Fields

assistant ID
text
required
This is the assistant that will be used for the call. You can create an assistant with Bundle VAPI - create assistant
phone number ID
text
This is the phone number ID that will be used for the call. Configure or purchase phone numbers through VAPI’s dashboard.
name
text
The name of the assistant
number
text
required
The number of the customer. Should be more than 3 characters and less than 40 characters
extension
text
This is the extension that will be dialed after the call is answered
customer name
text
This is the name of the customer. This is just for your own reference

Return Values

id
text
Unique identifier for the call
org id
text
Organization identifier
type
text
Type of the call
created at
date
When the call was created
updated at
date
When the call was last updated
summary
text
Summary of the call
recording URL
text
URL to access the call recording
video recording URL
text
URL to access the video recording
transcript
text
Transcript of the call
error
boolean
Whether an error occurred
error message
text
Error message if an error occurred
error status
number
Error status code if an error occurred