Sign in
Phone Calls

Place Call

post/api/v1/phone/place-call

Query parameters

async_commandboolean

Headers

Idempotency-Keystring nullable

Request body

origination'dedicated_number' | 'shared_imessage_number' | 'dedicated_imessage_number'
from_numberstring nullable

Phone number in E.164 format (e.g. '+15551234567').

to_numberstring required

Destination phone number to dial, in E.164 format.

agent_identity_idstring uuid nullable

Agent identity placing the call (required for shared_imessage_number under admin/JWT).

client_websocket_urlstring nullable

WebSocket URL (wss://) for audio bridging. Falls back to phone number's client_websocket_url.

mode'client_websocket' | 'hosted_agent'
hosted_agent_authority_mode'contact_scoped' | 'yolo'
voicemail_detection'enabled' | 'disabled'
reasonstring nullable

Task brief for the hosted agent, e.g. what to accomplish on the call. Required with mode=hosted_agent; invalid otherwise.

Example request

{
  "from_number": "+15551234567",
  "to_number": "+15551234567"
}

Response

Successful Response

OR

Changes

No recorded changes to this endpoint across all 1 revision of this API.