Skip to main content
POST
/
v1
/
voiceai
/
outbound-call
Initiate An Outbound Call
curl --request POST \
  --url https://api.example.com/v1/voiceai/outbound-call \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agent_id": "<string>",
  "phone_number_id": "<string>",
  "to_phone_number": "<string>"
}
'
{
  "success": true,
  "conversation_id": "<string>",
  "message": "Success",
  "call_sid": "<string>"
}

Authorizations

x-api-key
string
header
required

API key for programmatic access

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

Dynamic variables to pass to the agent

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