API by router
Sms channel
GET
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
enabled*Enabledphone_number?string|nullstatus*Statuswebhook_url*Webhook Urlcurl -X GET 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/sms'Example Response
{ "enabled": true, "phone_number": "string", "status": "string", "webhook_url": "string"}POST
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullapplication/json- body
account_sid*Account SidTwilio Account SID
auth_token*Auth TokenTwilio Auth Token (stored encrypted)
phone_number*Phone NumberTwilio phone number (E.164 format, e.g. +61400111222)
Length
length <= 30Successful Response
application/json- response
enabled*Enabledphone_number?string|nullstatus*Statuswebhook_url*Webhook Urlcurl -X POST 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/sms' \ -H 'Content-Type: application/json' \ -d '{ "account_sid": "string", "auth_token": "string", "phone_number": "string"}'Example Response
{ "enabled": true, "phone_number": "string", "status": "string", "webhook_url": "string"}DELETE
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
curl -X DELETE 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/sms'Example Response
Empty