Skip to main content
POST
Start Call

Authorizations

Authorization
string
header
required

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

Path Parameters

workspace_id
string
required
agent_id
string
required

Body

application/json

Request schema for starting a call. 'from_phone' is optional;'Parameters' includes custom key-value data that can be used in the call.

to_phone
string
required

To phone number

from_phone
string | null

From phone number

record
boolean | null
default:true

Whether to record the call

parameters
Parameters · object | null

Optional user-defined key-value pairs

Response

Call started successfully

Response schema for starting a call

to_phone
string
required

To phone number

created_by
string
required

Created by

from_phone
string | null

From phone number

record
boolean | null
default:true

Whether to record the call

status
enum<string>
default:created

Call status

Available options:
created,
initiated,
connected,
inprogress,
completed,
failed
created_at
string<date-time> | null

Call created at