Skip to navigation
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
Idempotency-KeystringOptional<=255 characters

A unique key (up to 255 printable ASCII characters, e.g. a UUID) that makes a retry of this request safe. Envoy stores the response for 24 hours; a retry with the same key and the same request returns it again with Idempotent-Replayed: true instead of running twice. The same key with a different request returns 422 idempotency_key_reused; while the first request is still running, 409 idempotency_key_in_progress. 5xx and 429 responses are not stored.

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 nullOptional
Allowed values:
phone_numberstring or nullOptional

Customer phone number (derived from direction)

to_numberstring or nullOptional
from_numberstring or nullOptional
call_start_timedatetime or nullOptional
call_end_timedatetime or nullOptional
call_typestring or nullOptional
load_idstring or nullOptionalformat: "^load_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
organization_idstring or nullOptionalformat: "^org_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
created_by_idstring or nullOptionalformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
recording_statusstring or nullOptional
load_numberstring or nullOptional

Errors

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