API by router
Whatsapp channel
GET
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
display_phone?string|nullenabled*Enabledphone_number_id?string|nullstatus*Statuswebhook_url*Webhook Urlcurl -X GET 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/whatsapp'Example Response
{ "display_phone": "string", "enabled": true, "phone_number_id": "string", "status": "string", "webhook_url": "string"}POST
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullapplication/json- body
access_token*Access TokenWABA access token (stored encrypted via MCP credentials)
app_secret*App SecretMeta App Secret for X-Hub-Signature-256 verification on POST webhooks
display_phone?|Display phone number (e.g. +61400111222)
phone_number_id*Phone Number IdMeta phone number ID from Embedded Signup
verify_token?|Custom verify token for GET webhook challenge. Auto-generated if not provided.
Successful Response
application/json- response
display_phone?string|nullenabled*Enabledphone_number_id?string|nullstatus*Statuswebhook_url*Webhook Urlcurl -X POST 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/whatsapp' \ -H 'Content-Type: application/json' \ -d '{ "access_token": "string", "app_secret": "string", "phone_number_id": "string"}'Example Response
{ "display_phone": "string", "enabled": true, "phone_number_id": "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/whatsapp'Example Response
Empty