Skip to main content
POST
Place a call
WhatsApp Business Calling runs over WhatsApp’s WebRTC infrastructure, not the PSTN. The recipient’s device must support WhatsApp voice calls and be connected to the internet.
Base URL: https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp These are WhatsApp calls under /WhatsApp/Call/. They are separate from the Voice API’s /Account/{auth_id}/Call/, which places PSTN and SIP calls. Authentication: every request needs the X-Auth-ID: MA_XXXXXXXX and X-Auth-Token: YOUR_AUTH_TOKEN headers, and the {auth_id} in the path must be the account those credentials belong to. Set Content-Type: application/json on requests with a body. Get your credentials from console.vobiz.ai.

Endpoints overview

Initiate a WhatsApp call

Place a business-initiated WhatsApp voice call from one of your channels. Provide your WebRTC SDP offer. Returns 201 Created when WhatsApp accepts the call request.
This rings a real person. Use your own credentials and confirm the recipient before you place the call.
The response carries the call ID, not an SDP answer. The recipient’s SDP answer arrives later, through the call.* webhook events, when they answer.

Request body

cURL
201 Created
A missing field, an unknown channel, or a call WhatsApp rejects returns 400.

Manage call (actions)

Control an active or incoming call on one of your channels. Pass the channel_id, the call_id, and one of the four actions. For accept and pre_accept, include your WebRTC SDP answer in the sdp field. Returns 200 OK when WhatsApp accepts the action, or 404 when the channel or call isn’t found.

Request body

200 OK

List call logs

Returns a paginated history of WhatsApp calls - inbound and outbound, newest first - with duration, outcome, and participant details.
cURL
200 OK

Call log object

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID (MA_XXXXXXXX).

X-Auth-Token
string
header
required

Your Vobiz account Auth Token.

Path Parameters

auth_id
string
required

Your account Auth ID. It must match the X-Auth-ID header.

Example:

"MA_XXXXXXXX"

Body

application/json
channel_id
string<uuid>
required

The channel to call from.

Example:

"0a8f3feb-9598-47f2-8a6c-df1aeb306ae1"

to
string
required

The WhatsApp user to call, in E.164 format. Spaces, hyphens and parentheses are removed and a missing + is added.

Example:

"+919876543210"

sdp_offer
string
required

Your WebRTC SDP offer.

Example:

"v=0\r\no=- 0 0 IN IP4 0.0.0.0\r\n..."

Response

WhatsApp accepted the call request.

call_id
string
required

WhatsApp's call ID. Use it as call_id in POST /Call/Action/.

Example:

"wacid.HBgMOTE5ODc2NTQzMjEwFQIAEhggQzVGNkE3QjhDOUQwRTFGMkEz"

from
string
required

The channel's phone number.

Example:

"+14155550100"

to
string
required

The normalized number you called.

Example:

"+919876543210"

status
string
required

Always initiated.

Example:

"initiated"

direction
string
required

Always outbound.

Example:

"outbound"