EndpointsCalls

Create a call

Initiate a new outbound phone call.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

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

Headers

X-Organization-IDstring or nullOptional

Request

This endpoint expects an object.
phone_numberstringRequired

Phone number to call (E.164 format)

load_idstring or nullOptionalformat: "uuid"
Load ID associated with this call
template_idstring or nullOptionalformat: "uuid"
Prompt template ID
voice_agent_idstring or nullOptionalformat: "uuid"

Voice agent ID (alternative to template)

call_typestring or nullOptional

Agent type: LOAD_BOOKING, ELP, or None

template_variablesmap from strings to anyOptional

Variables for the template/agent

Response

Successful Response
idstringformat: "^call_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
statusenum
call_timedatetime
created_atdatetime
updated_atdatetime
call_directionenum or null
phone_numberstring or null

Customer phone number (derived from direction)

to_numberstring or null
from_numberstring or null
call_start_timedatetime or null
call_end_timedatetime or null
call_typestring or null
load_idstringformat: "^load_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
organization_idstringformat: "^org_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
created_by_idstringformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
recording_statusstring or null
load_numberstring or null

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error