Skip to main content
POST

Autorisierungen

​
Authorization
string
header
erforderlich

Scoped API token. Required scopes are listed on each operation in x-required-scopes.

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, pass the agent's SIP ID (a value starting with t) instead and set caller_number.

Beispiel:

"+4921186942846"

​
caller_number
string

Caller ID shown to the recipient, in E.164 format. Required when agent_number is a SIP ID; the number must be registered on your account. Ignored for agents with a purchased number.

Pattern: ^\+\d+$
Beispiel:

"+4921154229976"

​
prompt_variables
object
veraltet

Deprecated alias of variables. Send one of the two, not both.

Beispiel:
​
metadata
object

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

Up to 25 keys; strings, numbers and booleans are accepted (null values are dropped), strings up to 500 characters. The same reserved-key rules as prompt_variables apply. Not supported on bulk requests.

​
variables
object

Values for the {{placeholders}} in the agent's prompt. Send either variables or prompt_variables, not both.

Beispiel:

Antwort

Call placed.

​
success
boolean

Always true.

Beispiel:

true

​
call_id
string

The public identifier of this call. Use it to find the conversation in GET /api/v1/conversations.

Beispiel:

"outb_Ux7yQm2ZK9vLd0Rb1cAeTg"

​
consent_id
integer

Identifier of the underlying call record (the id shown in batch detail). The call is already dialed when you receive this response, so it cannot be canceled.

Beispiel:

48213

​
batch_id
string<uuid>

Batch this call belongs to (every call gets one, single calls included). Look the call up with GET /api/v1/outbound/batches/{batch_id}.

​
outbound_ref
string<uuid>

Reference for this call. Quote it when contacting support.

​
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

The number that was called.

Beispiel:

"+491761234567"

​
agent_number
string

The agent's number in E.164, or its SIP ID.

Beispiel:

"+4921186942846"

​
external_call_id
string

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

Beispiel:

"crm-8842"