Skip to main content
POST
/
v1
/
voice
/
outbound
Outbound
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/voice/outbound \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "from_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_phone_number": "<string>",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "context_variables": {}
}
'
{
  "room_name": "<string>",
  "dispatch_id": "<string>",
  "agent_name": "<string>",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
from_phone_number_id
string<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_number
string
required

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

Pattern: ^\+[1-9]\d{6,14}$
​
agent_id
string<uuid> | null

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_id
string<uuid> | null

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_variables
Context Variables · object

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_name
string
required
​
dispatch_id
string
required
​
agent_name
string
required
​
session_id
string<uuid>
required