Skip to main content
POST
/
v1
/
messaging
/
calls
/
whatsapp
Calls API
curl --request POST \
  --url https://api.example.com/v1/messaging/calls/whatsapp

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

WhatsApp calling requires the recipient’s device to support WhatsApp voice calls and be connected to the internet. Calls go through WhatsApp’s peer-to-peer infrastructure, not the PSTN.
Authentication: X-Auth-ID, X-Auth-Token, Accept: application/json

​
Endpoints overview

MethodEndpointDescription
POST/v1/messaging/calls/whatsappInitiate a WhatsApp call
POST/v1/messaging/calls/whatsapp/actionManage call (accept/reject/terminate)
GET/v1/messaging/calls/whatsapp/logsList call history

​
Initiate a WhatsApp call

POST https://api.vobiz.ai/v1/messaging/calls/whatsapp
Initiate a WhatsApp voice call. Provide a WebRTC SDP offer - Vobiz returns the SDP answer from the recipient’s device once they accept.

​
Request body

FieldRequiredDescription
channel_idYesChannel to call from
toYesRecipient phone number (E.164)
sdp_offerYesWebRTC SDP offer string
cURL
curl -X POST \
  "https://api.vobiz.ai/v1/messaging/calls/whatsapp" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{"channel_id":"{channel_id}","to":"{to}","sdp_offer":"v=0\r\no=- 0 0 IN IP4 0.0.0.0\r\n..."}'
200 OK
{"call_id":"call_abc123","status":"initiated","sdp_answer":"v=0\r\n...","created_at":"2026-03-25T14:00:00Z"}

​
Manage call (actions)

POST https://api.vobiz.ai/v1/messaging/calls/whatsapp/action
Control an active or incoming call. Pass the call_id and one of the four actions.
ActionDescription
pre_acceptSignal call preview before full accept
acceptAccept an incoming call
rejectReject an incoming call
terminateEnd an active connected call
curl -X POST \
  "https://api.vobiz.ai/v1/messaging/calls/whatsapp/action" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{"call_id":"{call_id}","action":"terminate"}'

​
List call logs

GET https://api.vobiz.ai/v1/messaging/calls/whatsapp/logs
Returns a paginated history of all WhatsApp calls - inbound and outbound - with duration, outcome, and participant details.
cURL
curl -X GET \
  "https://api.vobiz.ai/v1/messaging/calls/whatsapp/logs?page=1&limit=25" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"
200 OK
{
  "data": [{"call_id":"call_abc123","direction":"outbound","to":"+919876543210","status":"completed","duration_seconds":185,"started_at":"2026-03-25T14:00:00Z","ended_at":"2026-03-25T14:03:05Z"}],
  "meta": {"total":12,"page":1}
}