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.

SMS logs provide provider-level delivery diagnostics. SMS debug timelines merge audit events and message-log delivery events for one SMS conversation. Authentication uses API key, JWT bearer token, or dashboard session.

​
List SMS Logs

GET /api/v1/sms-logs/?skip=0&limit=100&provider=telnyx&status=failed
Authorization: Bearer YOUR_TOKEN
Query ParameterTypeDescription
skipintegerRecords to skip
limitintegerRecords to return (1-500)
providerstringProvider filter
directionstringinbound or outbound
statusstringDelivery status filter
from_numberstringSender phone filter
to_numberstringRecipient phone filter
assistant_idintegerAssistant filter
date_fromstringISO lower bound
date_tostringISO upper bound
searchstringBody/content search
Response
{
  "items": [
    {
      "id": 1,
      "provider": "telnyx",
      "provider_message_id": "msg_abc123",
      "direction": "outbound",
      "from_number": "+15551234567",
      "to_number": "+15559876543",
      "body": "Your appointment is confirmed.",
      "media_urls": [],
      "segment_count": 1,
      "status": "sent",
      "provider_status": "delivered",
      "error_code": null,
      "error_message": null,
      "assistant_id": 123,
      "assistant_name": "Support Bot",
      "created_at": "2026-04-30T10:00:00Z",
      "updated_at": "2026-04-30T10:00:05Z"
    }
  ],
  "total": 1,
  "skip": 0,
  "limit": 100,
  "has_more": false
}

​
Get SMS Log

GET /api/v1/sms-logs/{log_id}
Authorization: Bearer YOUR_TOKEN
Returns the same fields as list items plus organization and provider debug payload details.
Response
{
  "id": 1,
  "organization_id": 9,
  "provider": "telnyx",
  "provider_message_id": "msg_abc123",
  "direction": "outbound",
  "from_number": "+15551234567",
  "to_number": "+15559876543",
  "body": "Your appointment is confirmed.",
  "media_urls": [],
  "segment_count": 1,
  "status": "sent",
  "provider_status": "delivered",
  "provider_payload": {
    "raw_status": "delivered"
  },
  "created_at": "2026-04-30T10:00:00Z",
  "updated_at": "2026-04-30T10:00:05Z"
}

​
SMS Log Stats

GET /api/v1/sms-logs/stats?date_from=2026-04-01&date_to=2026-04-30
Authorization: Bearer YOUR_TOKEN
Response
{
  "total": 240,
  "by_direction": {
    "inbound": 93,
    "outbound": 147
  },
  "by_status": {
    "sent": 130,
    "delivered": 90,
    "failed": 20
  },
  "by_provider": {
    "twilio": 40,
    "telnyx": 160,
    "vonage": 40
  },
  "failed_count": 20,
  "success_rate": 91.67
}

​
SMS Debug Timeline

GET /api/v1/sms/{call_id}/logs
Authorization: Bearer YOUR_TOKEN
The call_id is the SMS conversation call record ID.
Response
{
  "call_id": 101,
  "log_count": 3,
  "logs": [
    {
      "id": 1,
      "timestamp": "2026-04-30T10:00:00Z",
      "event_type": "webhook_received",
      "level": "info",
      "message": "Inbound SMS webhook received",
      "event_data": {
        "provider": "telnyx"
      }
    }
  ]
}
Errors:
  • 404 if the call/conversation is missing.
  • 403 if the conversation does not belong to the authenticated user’s organization.