Skip to main content
POST
Escalate voice call to video

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
callSid
string
required

The live call leg being elevated. Stamped onto the created room so it stays traceable back to the originating call.

Required string length: 1 - 128
callLogId
string

Optional call-log identifier, used to correlate the room back to the originating call.

Required string length: 1 - 64
remotePartyNumber
string

E.164 number of the remote leg — used for room naming and, when notifyRemoteParty is true, the SMS notification destination.

Maximum string length: 32
Pattern: ^\+?[0-9]*$
remotePartyName
string

Display name of the remote leg (shown in the generated room name when present).

Maximum string length: 120
roomName
string

Optional override for the created room's name (defaults to Call with <remote party>).

Required string length: 1 - 200
notifyRemoteParty
boolean
default:false

When true, sends the guest join link to remotePartyNumber by SMS. Requires remotePartyNumber and sipCredentialId.

sipCredentialId
string

SIP credential (extension) the notification SMS is sent FROM. Required only when notifyRemoteParty is true.

Required string length: 1 - 64

Response

Created — the resource was created successfully.

data
object
required
meta
object
required