Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Carrier campaign helper APIs for Telnyx, Twilio, and Vonage SMS registration.
/api/telnyx
| Method | Path | Purpose |
|---|---|---|
GET | /api/telnyx/brands | List Telnyx brands |
GET | /api/telnyx/campaigns?brand_id={brand_id} | List campaigns for a brand |
POST | /api/telnyx/campaign/select | Select campaign and brand for new Telnyx numbers |
GET | /api/telnyx/campaign/selected | Get selected Telnyx campaign |
GET | /api/telnyx/phone-number/{phone_number}/status | Check Telnyx phone-number campaign status |
{
"campaign_id": "campaign_123",
"brand_id": "brand_123"
}
/api/twilio-10dlc
| Method | Path | Purpose |
|---|---|---|
GET | /api/twilio-10dlc/messaging-services | List messaging services |
GET | /api/twilio-10dlc/messaging-services/{service_sid}/campaigns | List campaigns for a service |
POST | /api/twilio-10dlc/messaging-service/select | Select a default messaging service |
GET | /api/twilio-10dlc/messaging-service/selected | Get selected messaging service |
POST | /api/twilio-10dlc/campaign/select | Select campaign, messaging service, and brand |
GET | /api/twilio-10dlc/campaign/selected | Get selected Twilio campaign |
{
"campaign_id": "QE1234567890abcdef",
"messaging_service_sid": "MG1234567890abcdef",
"brand_sid": "BN1234567890abcdef"
}
/api/vonage-10dlc
| Method | Path | Purpose |
|---|---|---|
GET | /api/vonage-10dlc/brands | List Vonage brands |
GET | /api/vonage-10dlc/brands/{brand_id}/campaigns | List campaigns for a brand |
POST | /api/vonage-10dlc/campaign/select | Select a Vonage campaign |
GET | /api/vonage-10dlc/campaign/selected | Get selected Vonage campaign |
{
"campaign_id": "campaign_123",
"brand_id": "brand_123",
"usecase": "appointment_reminders",
"description": "Appointment reminder and customer support messages"
}
| Status | Cause |
|---|---|
400 | Missing provider credentials or invalid selection |
502 | Upstream provider returned an error |
503 | Provider API unavailable |
504 | Provider API timed out |