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.
SMS Messaging
Send text messages and multimedia content through your AI assistants using Twilio, Telnyx, or Vonage
Overview
The messaging system allows your AI assistants to send SMS and MMS messages to customers and users. The platform supports Twilio, Telnyx, and Vonage, automatically selecting the provider from the sending phone number’s configured provider.Key Features
Multi-Provider Support
Send through Twilio, Telnyx, or Vonage based on the provider attached to the sending phone number
MMS Support
Send images, documents, and other media files alongside text messages
Assistant-Based Routing
Messages are automatically routed through the correct provider based on the sending assistant
E.164 Validation
Automatic phone number format validation ensures reliable delivery
How It Works
The messaging system follows a simple but powerful flow:- Assistant Lookup: The system identifies which assistant owns the
from_phone_number - Provider Selection: Determines whether to use Twilio, Telnyx, or Vonage from the sender phone number’s provider configuration
- Message Delivery: Sends the message through the appropriate provider’s API
- Response: Returns confirmation with message ID and provider information
Provider Configuration
Per-Assistant Providers
Each assistant can be configured with different telephony providers:Provider Selection
The provider is determined by the owned phone number used asfrom_phone_number. If the number is a Telnyx number, Burki sends through Telnyx; if it is a Twilio or Vonage number, Burki uses that provider. This avoids guessing based on which credentials are present.
Supported Message Types
SMS (Text Messages)
Send plain text messages up to 1600 characters:MMS (Multimedia Messages)
Send images, documents, and other media files:Use Cases
Customer Service
Follow-up Messages
Follow-up Messages
Send follow-up messages after customer service calls with links to resources, ticket numbers, or additional information.
Appointment Reminders
Appointment Reminders
Automated appointment reminders with confirmation options and rescheduling links.
Order Updates
Order Updates
Shipping notifications, delivery confirmations, and order status updates.
Support Documentation
Support Documentation
Share troubleshooting guides, user manuals, and how-to videos via MMS.
Sales & Marketing
Lead Follow-up
Lead Follow-up
Personalized follow-up messages after sales calls with proposals and pricing information.
Event Invitations
Event Invitations
Send event invitations, webinar links, and calendar attachments.
Product Updates
Product Updates
Share product announcements, feature updates, and release notes.
Promotional Content
Promotional Content
Special offers, discount codes, and promotional materials (with proper consent).
Healthcare
Appointment Confirmations
Appointment Confirmations
Appointment confirmations and pre-visit instructions for healthcare workflows. Use a signed BAA and avoid sending PHI unless your full deployment is configured for the required compliance posture.
Medication Reminders
Medication Reminders
Automated medication reminders and refill notifications.
Test Results
Test Results
Secure delivery of test results and lab reports via encrypted links.
Health Tips
Health Tips
Personalized health tips and wellness recommendations.
Integration Patterns
Post-Call Follow-up
Automatically send follow-up messages after calls end:Scheduled Messaging
Set up scheduled messaging workflows:Interactive Workflows
Create two-way messaging workflows:Best Practices
Compliance & Regulations
- Opt-in Required: Only send messages to users who have explicitly opted in
- Opt-out Mechanism: Always provide a way for users to unsubscribe (e.g., “Reply STOP to opt out”)
- Business Hours: Respect time zones and send messages during appropriate hours
- Content Guidelines: Follow carrier guidelines for message content and frequency
Message Optimization
- Keep It Concise: SMS works best with short, clear messages
- Include CTAs: Provide clear next steps or calls to action
- Personalization: Use customer names and relevant context
- Timing: Send messages at appropriate times based on user preferences
Error Handling
Always implement proper error handling:Rate Limiting
Be mindful of rate limits:- Twilio: Varies by account type and sender setup
- Telnyx: Varies by account configuration
- Vonage: Varies by account type and sender setup
- Best Practice: Implement queuing for high-volume scenarios
Getting Started
Configure Your Assistant
Set up your assistant with Twilio, Telnyx, or Vonage credentials in the dashboard.
Next Steps
API Reference
Detailed API documentation for the SMS endpoint
SMS Conversations
Conversation, session, export, and archive APIs
SMS Logs
Delivery logs, stats, and debug timelines
SMS Compliance
Verify SMS use cases and outbound eligibility
SMS 10DLC
Carrier campaign helpers for Telnyx, Twilio, and Vonage
Telephony Providers
Learn about configuring Twilio, Telnyx, and Vonage providers
Webhooks
Set up webhooks to handle incoming SMS responses
Phone Numbers
Manage phone numbers for your assistants