Skip to main content
POST
Initiate An Outbound Call

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Body

application/json

Request to initiate an outbound call.

agent_id
string
required

Agent ID to use for the call

phone_number_id
string
required

Phone number ID to call from

to_phone_number
string
required

Phone number to call (E.164 format)

dynamic_variables
Dynamic Variables · object | null

Dynamic variables to pass to the agent

conversation_initiation_client_data
ConversationInitiationClientDataRequest · object | null
telephony_call_config
TelephonyCallConfig · object

Response

Successful Response

Response from initiating an outbound call.

success
boolean
required

Whether the call was initiated successfully

conversation_id
string
required

Generated conversation ID

message
string
default:Success

Status message

call_sid
string | null

SIP call ID if available