WhatsApp Calling Status Update Webhook Examples

🚧

Prerequisites

Make sure that your webhook endpoint is listening forwhatsapp.call.status.updated events. See also Configure Webhooks, Retrieve a webhook endpoint API.


When a business calls a WhatsApp user, it receives a status webhook with the call state: RINGING, ACCEPTED, or REJECTED.

Business initiated call is ringing the user

When the WhatsApp user’s client device begins ringing:

{
 "id": "evt_676e5ab57a9cb742d02d7646",
 "type": "whatsapp.call.status.updated",
 "apiVersion": "v2",
 "createTime": "2024-12-27T07:41:28.422Z",
 "callingStatusUpdated": {
   "wabaId": "188234691048809",
   "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABE",
   "status": "RINGING",
   "recipientPhone": "+6281361905133"
 }
}

Business initiated call is accepted by the user

When the WhatsApp user accepts the call:

{
 "id": "evt_67724ad42b4b206adc55f099",
 "type": "whatsapp.call.status.updated",
 "apiVersion": "v2",
 "createTime": "2024-12-27T07:42:00.577Z",
 "callingStatusUpdated": {
   "wabaId": "188234691048809",
   "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABE",
   "status": "ACCEPTED",
   "recipientPhone": "+6281361905133"
 }
}

Business initiated call is rejected by the user

When the call is rejected by the WhatsApp user. You'll also receive the call terminate webhook in this case:

{
 "id": "evt_677258526a15af2a8c7184a3",
 "type": "whatsapp.call.status.updated",
 "apiVersion": "v2",
 "createTime": "2024-12-27T07:41:32.093Z",
 "callingStatusUpdated": {
   "wabaId": "188234691048809",
   "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCAB",
   "status": "REJECTED",
   "recipientPhone": "+6281361905133"
 }
}