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
destinations
erforderlich

Up to 10 destinations, either as objects (with optional per-destination variables) or as plain E.164 strings. The two forms cannot be mixed.

Maximum array length: 10
agent_number
string
erforderlich

Your agent's phone number, or its SIP ID - see the Introduction.

Beispiel:

"+4921186942846"

caller_number
string

Caller ID for SIP-trunk agents - see the Introduction.

Pattern: ^\+\d+$
prompt_variables
object

Shared variables applied to every destination. Cannot be combined with per-destination prompt_variables in the same request - use one or the other.

Beispiel:

Antwort

Request accepted and every destination attempted. Per-destination outcomes are in results.

success
boolean
Beispiel:

true

batch_id
string<uuid>

Groups these calls together. Use it with Get a batch.

total
integer
Beispiel:

3

succeeded
integer
Beispiel:

2

failed
integer
Beispiel:

1

results
object[]