Create outgoing call

Places an outgoing WhatsApp voice call from your WhatsApp number to a customer, using a WebRTC session you set up.

Before you call

  • Your organization needs a calling licence or add-on, and the API key's user needs permission to start calls on from.
  • from is your connected WhatsApp number; coexistence numbers are not supported.
  • to must be an existing customer in DoubleTick; a leading + is accepted.
  • Send your WebRTC SDP offer in sdp and its type in sdpType; deviceId is optional.
  • The customer must have allowed calls; check with Get call permissions first.
  • Your number needs a messaging tier above 250, and your wallet balance must be above 1 (postpaid: no overdue invoice).

How it works

  • WhatsApp rings the customer; the response returns data.callId and an answer SDP to apply to your peer connection.
  • Pass callId to Decline or end call, Reconnect call and Keep call alive.
  • Creates the customer's chat on that number if it does not exist yet.
  • Browser (WebRTC) calls only: a number not set up for them returns 400 Calling is not supported on this number.
  • Returns 422 when the customer is not found, is blocked, or has not allowed calls; 409 if a call with them is already ongoing.

Rate limit

  • 60 requests per minute.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

WABA number to call from

string
required

Customer phone number in E.164 format

string
required

WebRTC SDP offer

string
required
string
Responses
200

Call initiated

422

Business rule failure

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json