Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.burki.dev/llms.txt

Use this file to discover all available pages before exploring further.

Burki exposes helper APIs for selecting and inspecting carrier 10DLC campaigns for Telnyx, Twilio, and Vonage. Authentication uses API key, JWT bearer token, or dashboard session. Each provider group requires the matching organization credentials.

Telnyx Campaigns

Base path:
/api/telnyx
MethodPathPurpose
GET/api/telnyx/brandsList Telnyx brands
GET/api/telnyx/campaigns?brand_id={brand_id}List campaigns for a brand
POST/api/telnyx/campaign/selectSelect campaign and brand for new Telnyx numbers
GET/api/telnyx/campaign/selectedGet selected Telnyx campaign
GET/api/telnyx/phone-number/{phone_number}/statusCheck Telnyx phone-number campaign status
Request
{
  "campaign_id": "campaign_123",
  "brand_id": "brand_123"
}

Twilio 10DLC

Base path:
/api/twilio-10dlc
MethodPathPurpose
GET/api/twilio-10dlc/messaging-servicesList messaging services
GET/api/twilio-10dlc/messaging-services/{service_sid}/campaignsList campaigns for a service
POST/api/twilio-10dlc/messaging-service/selectSelect a default messaging service
GET/api/twilio-10dlc/messaging-service/selectedGet selected messaging service
POST/api/twilio-10dlc/campaign/selectSelect campaign, messaging service, and brand
GET/api/twilio-10dlc/campaign/selectedGet selected Twilio campaign
Request
{
  "campaign_id": "QE1234567890abcdef",
  "messaging_service_sid": "MG1234567890abcdef",
  "brand_sid": "BN1234567890abcdef"
}

Vonage 10DLC

Base path:
/api/vonage-10dlc
MethodPathPurpose
GET/api/vonage-10dlc/brandsList Vonage brands
GET/api/vonage-10dlc/brands/{brand_id}/campaignsList campaigns for a brand
POST/api/vonage-10dlc/campaign/selectSelect a Vonage campaign
GET/api/vonage-10dlc/campaign/selectedGet selected Vonage campaign
Request
{
  "campaign_id": "campaign_123",
  "brand_id": "brand_123",
  "usecase": "appointment_reminders",
  "description": "Appointment reminder and customer support messages"
}

Common Errors

StatusCause
400Missing provider credentials or invalid selection
502Upstream provider returned an error
503Provider API unavailable
504Provider API timed out