API by router
Channels
GET
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
channels*array<>count*Countcurl -X GET 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels'Example Response
{ "channels": [ { "channel_type": "string", "config": {}, "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9", "created_at": "2019-08-24T14:15:22Z", "enabled": true, "error_message": "string", "external_identifier": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "last_event_at": "2019-08-24T14:15:22Z", "provider": "string", "status": "string", "updated_at": "2019-08-24T14:15:22Z" } ], "count": 0}POST
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullapplication/json- body
channel_type*Channel Typetelegram|whatsapp|voice|sms|email|web_chat
config?|Channel-specific config (streaming mode, processing rules, etc.)
connection_id?|FK to customer_connections for customer-owned channels
credential_id?|FK to mcp_credentials for platform-provisioned channels
enabled?EnabledDefault
trueexternal_identifier*External IdentifierPhone number, bot username, email address, etc.
Length
length <= 255provider*Providertelegram|meta_cloud|retell|twilio|gmail|resend|etc.
Length
length <= 50webhook_secret?|nullSuccessful Response
application/json- response
channel_type*Channel Typeconfig?|nullconnection_id?|nullcreated_at*Created AtFormat
date-timeenabled*Enablederror_message?string|nullexternal_identifier*External Identifierid*IdFormat
uuidinstance_id*Instance IdFormat
uuidlast_event_at?|nullprovider*Providerstatus*Statusupdated_at*Updated AtFormat
date-timecurl -X POST 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels' \ -H 'Content-Type: application/json' \ -d '{ "channel_type": "string", "external_identifier": "string", "provider": "string"}'Example Response
{ "channel_type": "string", "config": {}, "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9", "created_at": "2019-08-24T14:15:22Z", "enabled": true, "error_message": "string", "external_identifier": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "last_event_at": "2019-08-24T14:15:22Z", "provider": "string", "status": "string", "updated_at": "2019-08-24T14:15:22Z"}PATCH
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidendpoint_id*Endpoint IdFormat
uuidX-Api-Key?string|nullapplication/json- body
config?|nullenabled?boolean|nullerror_message?string|nullexternal_identifier?string|nullprovider?string|nullstatus?string|nullSuccessful Response
application/json- response
channel_type*Channel Typeconfig?|nullconnection_id?|nullcreated_at*Created AtFormat
date-timeenabled*Enablederror_message?string|nullexternal_identifier*External Identifierid*IdFormat
uuidinstance_id*Instance IdFormat
uuidlast_event_at?|nullprovider*Providerstatus*Statusupdated_at*Updated AtFormat
date-timecurl -X PATCH 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "channel_type": "string", "config": {}, "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9", "created_at": "2019-08-24T14:15:22Z", "enabled": true, "error_message": "string", "external_identifier": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "last_event_at": "2019-08-24T14:15:22Z", "provider": "string", "status": "string", "updated_at": "2019-08-24T14:15:22Z"}DELETE
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidendpoint_id*Endpoint IdFormat
uuidX-Api-Key?string|nullSuccessful Response
curl -X DELETE 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
Empty