Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Calling

Terminate a call

Terminates an active WhatsApp call.

Both the business or the WhatsApp user can terminate the call at any time. This endpoint is used by the business to end the call.

post/whatsapp/calls/terminate

Request body

phoneIdstring required

The WhatsApp Business phone number ID.

wacidstring required

The WhatsApp call ID. Required for terminate operations. This ID is received from the Call Connect webhook when a WhatsApp user initiates the call.

Example request

{
  "phoneId": "461269257068832",
  "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABEYIDNENjg2OEMzNTFFRDkwRkUxRUE1RTgxNjY1NjJCQUJBHBgNNjI4MzEzODIwNTE1MBUCABUeAA=="
}

Response

The call termination request is successfully processed.

wacidstring

The WhatsApp call ID associated with this calling operation.

successboolean required

Indicates whether the calling operation was successful.

Example response

{
  "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABEYIDNENjg2OEMzNTFFRDkwRkUxRUE1RTgxNjY1NjJCQUJBHBgNNjI4MzEzODIwNTE1MBUCABUeAA==",
  "success": true
}