Skip to main content
POST
Initiate Outbound Call

Authorizations

x-api-key
string
header
required

Your application's unique ID.

x-api-secret
string
header
required

Your application's secret key.

Path Parameters

whatsapp
string
required

The _id of the WhatsApp Business Account (WABA) to call from.

Example:

"60c72b2f9b1d8e001f8a1b2c"

Body

application/json

Outbound call payload

Payload for initiating an outbound WhatsApp call.

phone
string
required

The recipient's phone number in E.164 format.

Example:

"911234567890"

sdp
string
required

WebRTC SDP offer string from the calling client.

Example:

"v=0\r\no=- 46117317 2 IN IP4 127.0.0.1\r\n..."

Response

Call initiated successfully. Use the returned callId for accept/end operations.

Response returned after successfully initiating an outbound call.

status
integer
Example:

200

success
boolean
Example:

true

error
null
Example:

null

callId
string

The MongoDB _id of the created WaCall record. Use this as id in subsequent requests.

Example:

"64f1a2b3c4d5e6f7a8b9c0d1"