POST
/
v1
/
phoneCalls

Body

application/json
callTemplateId
string
required

The ID of the call template used for the call.

nameOfHuman
string
required

The name of the human making the call to.

promptVariableValues
object[]
required

Array of prompt variables used in the call.

teamId
object
required

The unique ID of the Team, phoneCall associated with.

toPhoneNumber
string
required

The phone number the call is made to.

fromPhoneNumber
string

The optional phone number the call should be made from. If not provided AI will use a number from twilio settings.

phoneNumberId
string

The ID of the phone number associated with the call.

record
boolean
default:
false

Flag indicating whether recording is enabled for the specific phone call.

status
enum<string>

The status of the phone call. Possible values: "queued", "ringing", "inProgress", "busy", "noAnswer", "canceled", "failed", "completed".

Available options:
queued,
ringing,
inProgress,
busy,
failed,
noAnswer,
cancelled,
completed
telephonyProvider
enum<string>

The telephony provider to be used for the phone call. Possible values: "twilio", "plivo".

Available options:
twilio,
plivo
toEmailAddress
string

The email of the person, the call is made to.

Response

200 - application/json
data
object
required