Create phone call
Authorizations
Retrieve your key from Dashboard.
Body
This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
This is the assistant that will be used for the call. To use a transient assistant, use assistant
instead.
This is the assistant that will be used for the call. To use an existing assistant, use assistantId
instead.
This is the customer that will be called. To call a transient customer , use customer
instead.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
This is the customer that will be called. To call an existing customer, use customerId
instead.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
This is the phone number that will be used for the call. To use a transient number, use phoneNumber
instead.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
This is the phone number that will be used for the call. To use an existing number, use phoneNumberId
instead.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
Response
This is the type of call.
inboundPhoneCall
, outboundPhoneCall
, webCall
This is the status of the call.
queued
, ringing
, in-progress
, forwarding
, ended
This is the explanation for how the call ended.
assistant-ended-call
, assistant-error
, assistant-forwarded-call
, assistant-join-timed-out
, assistant-not-found
, customer-busy
, customer-ended-call
, customer-did-not-answer
, db-error
, exceeded-max-duration
, manually-canceled
, no-server-available
, pipeline-error-custom-llm-response-was-invalid
, pipeline-error-custom-llm-request-failed
, pipeline-error-extra-function-failed
, pipeline-error-first-message-failed
, pipeline-error-function-filler-failed
, pipeline-error-function-failed
, pipeline-error-llm-failed
, pipeline-error-openai-voice-failed
, pipeline-error-deepgram-transcriber-failed
, pipeline-error-deepgram-voice-failed
, pipeline-error-eleven-labs-voice-failed
, pipeline-error-eleven-labs-voice-not-found
, pipeline-error-eleven-labs-quota-exceeded
, pipeline-error-playht-voice-failed
, pipeline-error-rime-ai-voice-failed
, server-shutdown
, silence-timed-out
, twilio-failed-to-connect-call
, twilio-closed-websocket
, unknown-error
, voicemail
This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
This is the unique identifier for the call.
This is the unique identifier for the org that this call belongs to.
This is the ISO 8601 date-time string of when the call was created.
This is the ISO 8601 date-time string of when the call was last updated.
This is the ISO 8601 date-time string of when the call was started.
This is the ISO 8601 date-time string of when the call was ended.
This is the cost of the call in USD.
This is the transcript of the call.
This is the URL of the recording of the call.
This is the URL of the recording of the call in two channels.
This is the summary of the call.
These are the messages that were spoken during the call.
This is the callSid of the phone call.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
This is the URL of the call that the assistant will join.
Only relevant for webCall
type.
This is the assistant that will be used for the call. To use a transient assistant, use assistant
instead.
This is the assistant that will be used for the call. To use an existing assistant, use assistantId
instead.
This is the customer that will be called. To call a transient customer , use customer
instead.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
This is the customer that will be called. To call an existing customer, use customerId
instead.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
This is the phone number that will be used for the call. To use a transient number, use phoneNumber
instead.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
This is the phone number that will be used for the call. To use an existing number, use phoneNumberId
instead.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
Was this page helpful?