Skip to main content
POST

Autorisierungen

​
Authorization
string
header
erforderlich

Generate (or rotate) your token on the Outbound Calls page in your dashboard. The token is shown once - store it securely; rotating it invalidates the previous token. A token only reaches your own agents and data.

Body

application/json
​
destination
string
erforderlich

Number to call, in E.164 format (+ followed by digits only).

Pattern: ^\+\d+$
Beispiel:

"+491761234567"

​
agent_number
string
erforderlich

Your agent's phone number (a leading + is optional). If your account connects its own SIP trunk, the agent's SIP ID works here too - see the Introduction.

Beispiel:

"+4921186942846"

​
caller_number
string

Caller ID shown to the recipient, in E.164 format. Only needed for SIP-trunk agents - see the Introduction.

Pattern: ^\+\d+$
Beispiel:

"+4921154229976"

​
prompt_variables
object

Values injected into the agent's prompt at call time. Every {{placeholder}} in the prompt must be supplied, or the request is rejected with 400. Extra keys the prompt does not use are accepted and ignored.

Key names should be lower snake_case. Values must be strings - send numbers and booleans as strings ("3", "true"). Up to 25 keys, each value up to 500 characters. The system__ and secret__ prefixes are reserved.

Beispiel:
​
metadata
object

Your own values, carried through the call and returned in the post-call callback. external_call_id is echoed back at the top level of the placement response so you can correlate it with your own records.

Antwort

Call placed.

​
success
boolean
Beispiel:

true

​
call_id
string

The primary public identifier for this call. Also available in post-call callbacks as %%call_id%%.

Beispiel:

"outb_Ux7yQm2ZK9vLd0Rb1cAeTg"

​
consent_id
integer

Identifier of the underlying call record. Use it to cancel the call before it is dialed.

Beispiel:

48213

​
outbound_ref
string<uuid>

Internal reference for this call, stable across retries.

​
call_sid
string

Telephony-level call identifier. Format depends on the carrier behind your agent.

​
status
string

Placement status at the moment of the response.

Beispiel:

"initiated"

​
destination
string
Beispiel:

"+491761234567"

​
agent_number
string
Beispiel:

"4921186942846"

​
external_call_id
string

Echoed back unchanged when you send metadata.external_call_id. Omitted otherwise.

Beispiel:

"crm-8842"