Skip to main content
POST
Initiate Outbound Call

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Outbound call request model with full LiveKit SIP support.

agent_id
string<uuid>
required
to_number
string
required

Destination phone number (E.164 format, spaces auto-stripped)

from_number
string | null

Caller ID (E.164 format, spaces auto-stripped)

context
Context · object | null

Additional call context/metadata

priority
string
default:normal

Call priority level

Pattern: ^(low|normal|high|urgent)$
krisp_enabled
boolean
default:true

Enable Krisp noise cancellation for this call

wait_until_answered
boolean
default:false

Wait for call to be answered before returning

display_name
string | null

Custom caller ID display name

dtmf
string | null

DTMF tones to send after call connects (e.g., '*123#ww456')

play_dialtone
boolean
default:false

Play dial tone while call is connecting

media_encryption
string
default:ALLOW

Media encryption level

Pattern: ^(DISABLE|ALLOW|REQUIRE)$
ringing_timeout_seconds
integer
default:80

Max time to wait for answer (1-80 seconds)

Required range: 1 <= x <= 80
max_call_duration_seconds
integer
default:3600

Maximum call duration

Required range: 60 <= x <= 86400
hide_phone_number
boolean
default:false

Hide phone number from participant attributes

custom_headers
Custom Headers · object | null

Custom SIP X-* headers

Response

Successful Response

Call response model.

call_id
string<uuid>
required
session_id
string<uuid>
required
room_name
string
required
agent_id
string<uuid>
required
direction
string
required
from_number
string
required
to_number
string
required
status
string
required
recording
Recording · object | null