Skip to main content
POST
Place an outbound call

Authorizations

Authorization
string
header
required

Send your organization API key as Authorization: Bearer <key>.

Path Parameters

id
string<uuid>
required

Agent id

Query Parameters

number
string

Phone number to call. Same as destination.

destination
string

Phone number to call. Same as number.

sipTrunkId
string<uuid>

SIP trunk to use for this call.

callerId
string

Caller ID to show the callee when using a SIP trunk.

firstMessage
string

Override the agent's first message for this call.

prompt
string

Override the agent's system prompt for this call.

Body

application/json

Optional. Pass variables for data the agent can use on this call.

variables
object[]

Custom data for the agent on this call.

Response

Outbound call accepted.

Result of the dial request.

success
boolean
required

Whether the call was accepted.