Skip to main content
GET
/
call
/
{id}
Get Call
curl --request GET \
  --url https://api.vapi.ai/call/{id} \
  --header 'Authorization: Bearer <token>'
{
  "type": "inboundPhoneCall",
  "phoneCallProvider": "twilio",
  "phoneCallTransport": "sip",
  "status": "queued",
  "endedReason": "assistant-error",
  "maxDurationSeconds": 1800,
  "id": "<string>",
  "orgId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "endedAt": "2023-11-07T05:31:56Z",
  "cost": 123,
  "costBreakdown": {
    "transport": 123,
    "stt": 123,
    "llm": 123,
    "tts": 123,
    "vapi": 123,
    "total": 123,
    "llmPromptTokens": 123,
    "llmCompletionTokens": 123,
    "ttsCharacters": 123
  },
  "transcript": "<string>",
  "recordingUrl": "<string>",
  "stereoRecordingUrl": "<string>",
  "summary": "<string>",
  "messages": [
    {}
  ],
  "phoneCallProviderId": "<string>",
  "phoneCallProviderBypassEnabled": true,
  "phoneCallProviderDetails": {
    "statusCallbackEvent": "initiated",
    "machineDetection": "Enable",
    "to": "<string>",
    "from": "<string>",
    "twiml": "<string>",
    "statusCallback": "<string>",
    "asyncAmd": "<string>",
    "asyncAmdStatusCallback": "<string>",
    "record": true
  },
  "webCallUrl": "<string>",
  "webCallSipUri": "<string>",
  "forwardedPhoneNumber": "<string>",
  "assistantId": "<string>",
  "assistant": {
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "language": "cs",
      "keywords": [
        "<string>"
      ]
    },
    "model": {
      "messages": [
        {
          "content": "<string>",
          "role": "assistant",
          "function_call": {},
          "tool_calls": [
            {}
          ]
        }
      ],
      "provider": "openai",
      "model": "gpt-4-1106-preview",
      "fallbackModels": [
        "gpt-4-0125-preview",
        "gpt-4-0613"
      ],
      "semanticCachingEnabled": true,
      "temperature": 1,
      "functions": [
        {
          "name": "<string>",
          "async": true,
          "description": "<string>",
          "parameters": {
            "type": "object",
            "properties": {},
            "required": [
              "<any>"
            ]
          },
          "serverUrl": "<string>",
          "serverUrlSecret": "<string>"
        }
      ],
      "maxTokens": 525
    },
    "voice": {
      "provider": "azure",
      "voiceId": "andrew",
      "speed": 1.25
    },
    "forwardingPhoneNumber": null,
    "recordingEnabled": true,
    "endCallFunctionEnabled": false,
    "dialKeypadFunctionEnabled": null,
    "hipaaEnabled": false,
    "clientMessages": [
      "transcript",
      "hang",
      "function-call",
      "speech-update",
      "metadata",
      "conversation-update"
    ],
    "serverMessages": [
      "end-of-call-report",
      "status-update",
      "hang",
      "function-call"
    ],
    "silenceTimeoutSeconds": 30,
    "responseDelaySeconds": 0.4,
    "llmRequestDelaySeconds": 0.1,
    "numWordsToInterruptAssistant": 2,
    "maxDurationSeconds": 1800,
    "backgroundSound": "office",
    "name": "<string>",
    "forwardingPhoneNumbers": [
      {
        "number": "<string>",
        "sipUri": "<string>",
        "message": "<string>"
      }
    ],
    "firstMessage": "<string>",
    "voicemailDetectionEnabled": true,
    "voicemailMessage": "<string>",
    "endCallMessage": "<string>",
    "endCallPhrases": [
      "<string>"
    ],
    "metadata": {},
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>"
  },
  "customerId": "<string>",
  "customer": {
    "number": "<string>",
    "name": "<string>",
    "extension": "<string>"
  },
  "phoneNumberId": "<string>",
  "phoneNumber": {
    "twilioPhoneNumber": "<string>",
    "twilioAccountSid": "<string>",
    "twilioAuthToken": "<string>",
    "name": "<string>",
    "assistantId": "<string>",
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>"
  },
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

Retrieve your key from Dashboard.

Path Parameters

​
id
string
required

Response

200 - application/json
​
id
string
required

This is the unique identifier for the call.

​
orgId
string
required

This is the unique identifier for the org that this call belongs to.

​
createdAt
string<date-time>
required

This is the ISO 8601 date-time string of when the call was created.

​
updatedAt
string<date-time>
required

This is the ISO 8601 date-time string of when the call was last updated.

​
type
enum<string>

This is the type of call.

Available options:
inboundPhoneCall,
outboundPhoneCall,
webCall
​
phoneCallProvider
enum<string>

This is the provider of the call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

Available options:
twilio,
vonage
​
phoneCallTransport
enum<string>

This is the transport of the phone call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

Available options:
sip,
pstn
​
status
enum<string>

This is the status of the call.

Available options:
queued,
ringing,
in-progress,
forwarding,
ended
​
endedReason
enum<string>

This is the explanation for how the call ended.

Available options:
assistant-error,
assistant-not-found,
db-error,
no-server-available,
pipeline-error-extra-function-failed,
pipeline-error-first-message-failed,
pipeline-error-function-filler-failed,
pipeline-error-function-failed,
pipeline-error-openai-llm-failed,
pipeline-error-azure-openai-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-groq-llm-failed,
pipeline-error-anthropic-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-lmnt-voice-failed,
pipeline-error-azure-voice-failed,
pipeline-error-rime-ai-voice-failed,
pipeline-error-neets-voice-failed,
pipeline-no-available-llm-model,
server-shutdown,
twilio-failed-to-connect-call,
unknown-error,
vonage-disconnected,
vonage-failed-to-connect-call,
assistant-not-invalid,
assistant-not-provided,
assistant-request-returned-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,
exceeded-max-duration,
manually-canceled,
phone-call-provider-closed-websocket,
pipeline-error-custom-llm-llm-failed,
silence-timed-out,
voicemail,
vonage-rejected
​
maxDurationSeconds
number

This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.

Required range: 10 <= x <= 3600
Example:

1800

​
startedAt
string<date-time>

This is the ISO 8601 date-time string of when the call was started.

​
endedAt
string<date-time>

This is the ISO 8601 date-time string of when the call was ended.

​
cost
number

This is the cost of the call in USD.

​
costBreakdown
object

This is the cost of the call in USD.

​
transcript
string

This is the transcript of the call.

​
recordingUrl
string

This is the URL of the recording of the call.

​
stereoRecordingUrl
string

This is the URL of the recording of the call in two channels.

​
summary
string

This is the summary of the call.

​
messages
object[]

These are the messages that were spoken during the call.

​
phoneCallProviderId
string

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.

​
phoneCallProviderBypassEnabled
boolean

If enabled, prevents Vapi from initiating calls directly. Defaults to disabled. Suitable for external call handling, such as with Twilio Studio Flow, with integration details provided in phoneCallProviderDetails.

Only relevant for outboundPhoneCall and inboundPhoneCall types.

​
phoneCallProviderDetails
object

This is the phone call provider details to bridge the assistant into the external call. Only filled if phoneCallProviderBypassEnabled is true.

Only relevant for outboundPhoneCall and inboundPhoneCall types.

​
webCallUrl
string

This is the URL of the call that the assistant will join.

Only relevant for webCall type.

​
webCallSipUri
string

This is the SIP URI of the call that the assistant will join.

Only relevant for webCall type.

​
forwardedPhoneNumber
string

This is the phone number that the call was forwarded to.

​
assistantId
string | null

This is the assistant that will be used for the call. To use a transient assistant, use assistant instead.

​
assistant
object

This is the assistant that will be used for the call. To use an existing assistant, use assistantId instead.

​
customerId
string

This is the customer that will be called. To call a transient customer , use customer instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

​
customer
object

This is the customer that will be called. To call an existing customer, use customerId instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

​
phoneNumberId
string

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.

​
phoneNumber
object

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.

​
metadata
object

This is the metadata associated with the call.