Skip to main content
POST
Create call

Authorizations

X-API-Key
string
header
required

Path Parameters

account_id
string<uuid4>
required

Body

application/json
type
enum<string>
required

Call type. Use phone for outbound SIP and web for browser-based calls.

Available options:
phone,
web
agent_id
string
required

Agent UUID

from_number
string | null

Source E.164 phone number for phone calls

to_number
string | null

Destination E.164 phone number for phone calls

medium
string | null

Optional compatibility field. web calls always use WEB.

device_fingerprint
string | null

Optional client/device fingerprint for web calls

external_id
string | null

Optional idempotency/correlation key

initial_text
string | null

Optional first user message injected into web call context

audio_input_enabled
boolean | null
audio_output_enabled
boolean | null
amd
enum<string> | null

Answering-machine detection for phone calls: livekit, tool, aculab, or none.

Available options:
livekit,
tool,
aculab,
none
skip_greeting_on_initial_text
boolean | null
test_variables
Test Variables · object | null

Optional runtime variables exposed to the call worker

overrides
Overrides · object | null

Optional runtime override object. Use overrides.agent with the same JSON shape as Agent PATCH (/v1/accounts/{account_id}/agents/{agent_id}).

Response

Created

id
string<uuid4>
required
type
string
required
status
string
required
created
string<date-time>
required
modified
string<date-time>
required
direction
string | null
answer_status
enum<string> | null

How the call was answered when known (waiting, human, machine, user_rejected, user_unavailable, user_busy, or unknown).

Available options:
waiting,
human,
machine,
user_rejected,
user_unavailable,
user_busy,
unknown
agent_id
string<uuid4> | null
agent_name
string | null
from_number
string | null
to_number
string | null
external_id
string | null
started_at
string<date-time> | null
ended_at
string<date-time> | null
duration_seconds
integer | null
success
boolean
default:true
join
CallJoinV1Out · object | null

LiveKit connection details returned for web calls.