Skip to main content
POST
Initiate an outbound WhatsApp Business Call (Phase 5)

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
to
string
required

Recipient phone number (E.164, optional leading +).

Required string length: 1 - 64
from_phone_number_id
string
required

Meta phone_number_id of the sender WABA number.

Required string length: 1 - 64
conversation_id
string
Required string length: 1 - 64
biz_opaque_callback_data
string

Echoed back on every webhook event for the call (correlation handle).

Required string length: 1 - 512
sdp_offer
string

SDP offer for browser-side WebRTC. Omit for server-bridged calls.

Required string length: 1 - 16384

Response

Call queued with Meta

Call queued with Meta

data
object
meta
object