Skip to main content
POST
Start Call
Call a customer from your number. WhatsApp only allows it when the customer has given you call permission: check with Get Call Permission, ask with Request Call Permission. Send your SDP offer; when the customer answers, your webhook receives call.event: "connect" with their SDP answer in call.session, which you give to your media server.

Basic Usage


Body Parameters


Response

Success (200)


Errors

Authorizations

Authorization
string
header
required

Your FlowIQ organisation API key (Settings → API Keys), sent as a bearer token. Format: Bearer fiq_YOUR_API_KEY

Body

application/json
sdp
string
required

Your SDP offer

to
string

The customer's WhatsApp number with country code (or send contact_id)

Example:

"27820000000"

contact_id
string<uuid>

The customer's FlowIQ contact id (or send to)

biz_opaque_callback_data
string

Your own reference; WhatsApp sends it back on later events for this call

Maximum string length: 512

Response

Success

organization_id
string<uuid>
call_id
string
contact_id
string<uuid>
status
enum<string>
Available options:
ringing