Phone Calls
Post Phonecall
Create a new PhoneCall
POST
/
v1
/
phoneCalls
Body
application/json
teamId
object
requiredThe unique ID of the Team, phoneCall associated with.
callTemplateId
string
requiredThe ID of the call template used for the call.
nameOfHuman
string
requiredThe name of the human making the call to.
toPhoneNumber
string
requiredThe phone number the call is made to.
promptVariableValues
object[]
requiredArray of prompt variables used in the call.
phoneNumberId
string
The ID of the phone number associated with the call.
fromPhoneNumber
string
The optional phone number the call should be made from. If not provided AI will use a number from twilio settings.
toEmailAddress
string
The email of the person, the call is made to.
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
record
boolean
default: falseFlag indicating whether recording is enabled for the specific phone call.
Response
200 - application/json
data
object
required