API by router
Channels
List Instance Channels
AuthorizationBearer <token>
In: header
Path Parameters
instance_idInstance Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X GET "https://loading/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels" \ -H "X-Api-Key: string"{
"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
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Create Channel Endpoint
AuthorizationBearer <token>
In: header
Path Parameters
instance_idInstance Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
channel_typeChannel Type
telegram|whatsapp|voice|sms|email|web_chat
config?Config
Channel-specific config (streaming mode, processing rules, etc.)
connection_id?Connection Id
FK to customer_connections for customer-owned channels
credential_id?Credential Id
FK to mcp_credentials for platform-provisioned channels
enabled?Enabled
Default
trueexternal_identifierExternal Identifier
Phone number, bot username, email address, etc.
Length
length <= 255providerProvider
telegram|meta_cloud|retell|twilio|gmail|resend|etc.
Length
length <= 50webhook_secret?Webhook Secret
Response Body
curl -X POST "https://loading/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels" \ -H "X-Api-Key: string" \ -H "Content-Type: application/json" \ -d '{ "channel_type": "string", "external_identifier": "string", "provider": "string" }'{
"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"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Update Channel Endpoint
AuthorizationBearer <token>
In: header
Path Parameters
instance_idInstance Id
Format
uuidendpoint_idEndpoint Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
config?Config
enabled?Enabled
error_message?Error Message
external_identifier?External Identifier
provider?Provider
status?Status
Response Body
curl -X PATCH "https://loading/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Api-Key: string" \ -H "Content-Type: application/json" \ -d '{}'{
"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"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Delete Channel Endpoint
AuthorizationBearer <token>
In: header
Path Parameters
instance_idInstance Id
Format
uuidendpoint_idEndpoint Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X DELETE "https://loading/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Api-Key: string"Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}