Get call
Authorizations
Retrieve your API Key from Dashboard.
Path Parameters
Response
This is the type of call.
inboundPhoneCall
, outboundPhoneCall
, webCall
These are the messages that were spoken during the call.
This is the provider of the call.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
twilio
, vonage
, vapi
This is the transport of the phone call.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
sip
, pstn
This is the status of the call.
queued
, ringing
, in-progress
, forwarding
, ended
This is the explanation for how the call ended.
assistant-error
, assistant-not-found
, db-error
, no-server-available
, license-check-failed
, pipeline-error-openai-llm-failed
, pipeline-error-azure-openai-llm-failed
, pipeline-error-groq-llm-failed
, pipeline-error-openai-voice-failed
, pipeline-error-cartesia-voice-failed
, pipeline-error-deepgram-transcriber-failed
, pipeline-error-deepgram-voice-failed
, pipeline-error-gladia-transcriber-failed
, pipeline-error-eleven-labs-voice-failed
, pipeline-error-playht-voice-failed
, pipeline-error-lmnt-voice-failed
, pipeline-error-azure-voice-failed
, pipeline-error-rime-ai-voice-failed
, pipeline-error-neets-voice-failed
, pipeline-no-available-model
, worker-shutdown
, twilio-failed-to-connect-call
, unknown-error
, vonage-disconnected
, vonage-failed-to-connect-call
, phone-call-provider-bypass-enabled-but-no-call-received
, vapi-error-phone-call-worker-setup-socket-error
, vapi-error-phone-call-worker-worker-setup-socket-timeout
, vapi-error-phone-call-worker-could-not-find-call
, vapi-error-phone-call-worker-call-never-connected
, vapi-error-web-call-worker-setup-failed
, assistant-not-invalid
, assistant-not-provided
, call-start-error-neither-assistant-nor-server-set
, assistant-request-failed
, assistant-request-returned-error
, assistant-request-returned-unspeakable-error
, assistant-request-returned-invalid-assistant
, assistant-request-returned-no-assistant
, assistant-request-returned-forwarding-phone-number
, assistant-ended-call
, assistant-said-end-call-phrase
, assistant-forwarded-call
, assistant-join-timed-out
, customer-busy
, customer-ended-call
, customer-did-not-answer
, customer-did-not-give-microphone-permission
, assistant-said-message-with-end-call-enabled
, exceeded-max-duration
, manually-canceled
, phone-call-provider-closed-websocket
, pipeline-error-anthropic-llm-failed
, pipeline-error-together-ai-llm-failed
, pipeline-error-anyscale-llm-failed
, pipeline-error-openrouter-llm-failed
, pipeline-error-perplexity-ai-llm-failed
, pipeline-error-deepinfra-llm-failed
, pipeline-error-runpod-llm-failed
, pipeline-error-custom-llm-llm-failed
, pipeline-error-eleven-labs-voice-not-found
, pipeline-error-eleven-labs-quota-exceeded
, pipeline-error-eleven-labs-unauthorized-access
, pipeline-error-eleven-labs-unauthorized-to-access-model
, pipeline-error-eleven-labs-professional-voices-only-for-creator-plus
, pipeline-error-eleven-labs-blocked-free-plan-and-requested-upgrade
, pipeline-error-eleven-labs-blocked-concurrent-requests-and-requested-upgrade
, pipeline-error-eleven-labs-blocked-using-instant-voice-clone-and-requested-upgrade
, pipeline-error-eleven-labs-system-busy-and-requested-upgrade
, pipeline-error-eleven-labs-voice-not-fine-tuned
, pipeline-error-eleven-labs-invalid-api-key
, pipeline-error-eleven-labs-invalid-voice-samples
, pipeline-error-eleven-labs-voice-disabled-by-owner
, pipeline-error-eleven-labs-blocked-account-in-probation
, pipeline-error-eleven-labs-blocked-content-against-their-policy
, pipeline-error-eleven-labs-missing-samples-for-voice-clone
, pipeline-error-playht-request-timed-out
, pipeline-error-playht-invalid-voice
, pipeline-error-playht-unexpected-error
, pipeline-error-playht-out-of-credits
, pipeline-error-playht-rate-limit-exceeded
, pipeline-error-playht-502-gateway-error
, pipeline-error-playht-504-gateway-error
, pipeline-error-gladia-transcriber-failed
, sip-gateway-failed-to-connect-call
, silence-timed-out
, voicemail
, vonage-rejected
This is the destination where the call ended up being transferred to. If the call was not transferred, this will be empty.
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 cost of the call in USD.
These are the costs of individual components 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 stores artifacts of the call. Customize what artifacts are created by configuring assistant.artifactPlan
.
This is a copy of assistant artifact plan. This isn't actually stored on the call but rather just returned in POST /call/web to enable artifact creation client side.
This is the analysis of the call. Customize the analysis by configuring assistant.analysisPlan
.
The ID of the call as provided by the phone number service. callSid in Twilio. conversationUuid in Vonage.
Only relevant for outboundPhoneCall
and inboundPhoneCall
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.
These are the overrides for the assistant
or assistantId
's settings and template variables.
This is the squad that will be used for the call. To use a transient squad, use squad
instead.
This is a squad that will be used for the call. To use an existing squad, use squadId
instead.
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.
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 name of the call. This is just for your own reference.
Was this page helpful?