Skip to main content
POST
Start an outbound call

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Body

application/json
assistant_id
string<uuid>
required

Assistant that runs the call. Must be active.

to_number
string
required

Destination in E.164 format, e.g. +4930123456.

lead
object

Arbitrary key/value context injected into the conversation (e.g. the callee's name).

phone_number_id
string<uuid>

Optional explicit caller ID (one of your phone numbers). Defaults to the number assigned to the assistant.

Response

The created call (status queued).

data
object
required