Start a WhatsApp call

POST 
/api/v1/accounts/:account_id/whatsapp_calls/initiate

Places an outgoing call to the conversation's contact and writes it into the thread as a message, so the call is visible where the conversation is.

Three things have to hold: the inbox is a WhatsApp channel with calling enabled, the request carries a WebRTC sdp_offer, and the contact has a phone number.

Calling needs the contact's permission. If Meta reports they have not opted in, the opt-in template is sent instead and the response says so — permission_requested when it went out, permission_pending when one was already sent recently. The call itself does not happen in either case.

Request

Responses

200

Ringing

404

Conversation not found

422

Calling is off for the inbox, the offer or the contact's phone is missing, the provider refused, or the contact has not granted call permission — in which case the body reports permission_requested or permission_pending.