Skip to main content
POST
Initiate call

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
phoneNumber
string
required

Customer/destination phone number

workspaceId
string<uuid>
required

Workspace ID

callerNumber
string

Caller ID phone number (used to look up SIP/trunk config). Required for regular calls; campaign calls derive it from the campaign

campaignId
string<uuid>

Campaign ID (presence triggers campaign call flow)

properties
object

Custom properties to pass to the agent

attemptNumber
integer

Campaign attempt number (1 = initial call); surfaced to the agent as 0-based call.retry_number

externalCallId
string

External call ID for client-side tracking

Required string length: 1 - 255
assistantId
string<uuid>

Override campaign assistant ID

entityVersionId
string<uuid>

Version ID of the entity (agent/workflow) active during the call

skipE164Normalization
boolean

Skip E.164 normalization of the phone number (default: false)

Response

Call initiated

success
enum<boolean>
required
Available options:
true
data
object
required