v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-304917042.1 MB

voice

Outbound

post/v1/voice/outbound

Request body

from_phone_number_idstring uuid required

Org-scoped phone number id to dial FROM. Must have an outbound_call agent attached so a SIP outbound trunk has been provisioned.

to_phone_numberstring required

E.164 phone number to dial, e.g. +15555550123

agent_idstring uuid nullable

Optional: dial AS this specific agent. Must already be attached to the from-number as an outbound_call binding. Provide this XOR team_id; omit both to let the backend pick a bound dialer at random (load-balanced across the fleet).

team_idstring uuid nullable

Optional: dial AS this specific team (its default member answers). Must already be attached to the from-number as an outbound_call binding. Provide this XOR agent_id; omit both for random pick.

context_variablesobject nullable

Optional seed values for the bound agent's typed context variables, applied once at session bootstrap. Each key must be a variable declared on the agent or one of its bound workflows; values are coerced against the variable's type/enum. An unknown key or an uncoercible value is rejected (422). System vars are frozen on-file; derived seeds satisfy the collection gate. Only honored for single-agent bindings in v1 (ignored for team-bound dialers).

Response

Successful Response

room_namestring required

dispatch_idstring required

agent_namestring required

session_idstring uuid required