Sign in
Calls

List Calls

get/v2/call

Query parameters

assistantIdstring

This will return calls with the specified assistantId.

assistantNamestring

This will return calls where the transient assistant name exactly matches the specified value (case-insensitive).

idstring

This will return calls with the specified callId.

idAnystring[]

This will return calls with the specified callIds.

costLenumber

This will return calls where the cost is less than or equal to the specified value.

costGenumber

This will return calls where the cost is greater than or equal to the specified value.

costnumber

This will return calls with the exact specified cost.

successEvaluationstring

This will return calls with the specified successEvaluation.

endedReasonstring

This will return calls with the specified endedReason.

{"stackTrail":"paths:/v2/call:get:parameters:9:schema","oasType":"schema","type":"unknown"}

These are the options for the assistant's transcriber.

{"stackTrail":"paths:/v2/call:get:parameters:10:schema","oasType":"schema","type":"unknown"}

These are the options for the assistant's LLM.

{"stackTrail":"paths:/v2/call:get:parameters:11:schema","oasType":"schema","type":"unknown"}

These are the options for the assistant's voice.

firstMessagestring
Example:Hello! How can I help you today?

This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).

If unspecified, assistant will wait for user to speak and use the model to respond once they speak.

firstMessageInterruptionsEnabledboolean
firstMessageMode'assistant-speaks-first' | 'assistant-speaks-first-with-model-generated-message' | 'assistant-waits-for-user'
Example:assistant-speaks-first

This is the mode for the first message. Default is 'assistant-speaks-first'.

Use:

  • 'assistant-speaks-first' to have the assistant speak first.
  • 'assistant-waits-for-user' to have the assistant wait for the user to speak first.
  • 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (assistant.model.messages at call start, call.messages at squad transfer points).

@default 'assistant-speaks-first'

{"stackTrail":"paths:/v2/call:get:parameters:15:schema","oasType":"schema","type":"unknown"}

These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool]. This uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached. You can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.

clientMessagesstring[]

These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.

[
  "conversation-update",
  "function-call",
  "hang",
  "model-output",
  "speech-update",
  "status-update",
  "transfer-update",
  "transcript",
  "tool-calls",
  "user-interrupted",
  "voice-input",
  "workflow.node.started"
]
serverMessagesstring[]

These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,handoff-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.

[
  "conversation-update",
  "end-of-call-report",
  "function-call",
  "hang",
  "speech-update",
  "status-update",
  "tool-calls",
  "transfer-destination-request",
  "handoff-destination-request",
  "user-interrupted"
]
maxDurationSecondsnumber
Example:600

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

@default 600 (10 minutes)

{"stackTrail":"paths:/v2/call:get:parameters:19:schema","oasType":"schema","type":"unknown"}

This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'. You can also provide a custom sound by providing a URL to an audio file.

modelOutputInMessagesEnabledboolean

This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.

Default false while in beta.

@default false

{"stackTrail":"paths:/v2/call:get:parameters:21:schema:items","oasType":"schema","type":"unknown"}

These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.

{"stackTrail":"paths:/v2/call:get:parameters:22:schema","oasType":"schema","type":"unknown"}

This is the plan for observability of assistant's calls.

Currently, only Langfuse is supported.

{"stackTrail":"paths:/v2/call:get:parameters:23:schema:items","oasType":"schema","type":"unknown"}

These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.

{"stackTrail":"paths:/v2/call:get:parameters:24:schema:items","oasType":"schema","type":"unknown"}

This is a set of actions that will be performed on certain events.

variableValuesobject

These are values that will be used to replace the template variables in the assistant messages and other text-based fields. This uses LiquidJS syntax. https://liquidjs.com/tutorials/intro-to-liquid.html

So for example, {{ name }} will be replaced with the value of name in variableValues. {{"now" | date: "%b %d, %Y, %I:%M %p", "America/New_York"}} will be replaced with the current date and time in New York. Some VAPI reserved defaults:

  • customer - the customer object
namestring

This is the name of the assistant.

This is required when you want to transfer between assistants in a call.

voicemailMessagestring

This is the message that the assistant will say if the call is forwarded to voicemail.

If unspecified, it will hang up.

endCallMessagestring

This is the message that the assistant will say if it ends the call.

If unspecified, it will hang up without saying anything.

endCallPhrasesstring[]

This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.

hipaaEnabledboolean

When this is enabled, no logs, recordings, or transcriptions will be stored. At the end of the call, you will still receive an end-of-call-report message to store on your server. Defaults to false.

pciEnabledboolean

When this is enabled, the user will be restricted to use PCI-compliant providers, and no logs or transcripts are stored. At the end of the call, you will receive an end-of-call-report message to store on your server. Defaults to false.

metadataobject

This is for metadata you want to store on the assistant.

{"stackTrail":"paths:/v2/call:get:parameters:32:schema","oasType":"schema","type":"unknown"}

This enables filtering of noise and background speech while the user is talking.

Features:

  • Smart denoising using Krisp
  • Fourier denoising

Smart denoising can be combined with or used independently of Fourier denoising.

Order of precedence:

  • Smart denoising
  • Fourier denoising
{"stackTrail":"paths:/v2/call:get:parameters:33:schema","oasType":"schema","type":"unknown"}

This is the plan for analysis of assistant's calls. Stored in call.analysis.

{"stackTrail":"paths:/v2/call:get:parameters:34:schema","oasType":"schema","type":"unknown"}

This is the plan for artifacts generated during assistant's calls. Stored in call.artifact.

{"stackTrail":"paths:/v2/call:get:parameters:35:schema","oasType":"schema","type":"unknown"}

This is the plan for when the assistant should start talking.

You should configure this if you're running into these issues:

  • The assistant is too slow to start talking after the customer is done speaking.
  • The assistant is too fast to start talking after the customer is done speaking.
  • The assistant is so fast that it's actually interrupting the customer.
{"stackTrail":"paths:/v2/call:get:parameters:36:schema","oasType":"schema","type":"unknown"}

This is the plan for when assistant should stop talking on customer interruption.

You should configure this if you're running into these issues:

  • The assistant is too slow to recognize customer's interruption.
  • The assistant is too fast to recognize customer's interruption.
  • The assistant is getting interrupted by phrases that are just acknowledgments.
  • The assistant is getting interrupted by background noises.
  • The assistant is not properly stopping -- it starts talking right after getting interrupted.
{"stackTrail":"paths:/v2/call:get:parameters:37:schema","oasType":"schema","type":"unknown"}

This is the plan for real-time monitoring of the assistant's calls.

Usage:

  • To enable live listening of the assistant's calls, set monitorPlan.listenEnabled to true.
  • To enable live control of the assistant's calls, set monitorPlan.controlEnabled to true.
credentialIdsstring[]

These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.

{"stackTrail":"paths:/v2/call:get:parameters:39:schema","oasType":"schema","type":"unknown"}

This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.

The order of precedence is:

  1. assistant.server.url
  2. phoneNumber.serverUrl
  3. org.serverUrl
enabledboolean

This keeps track of whether the user has enabled keypad input. By default, it is off.

@default false

timeoutSecondsnumber

This is the time in seconds to wait before processing the input. If the input is not received within this time, the input will be ignored. If set to "off", the input will be processed when the user enters a delimiter or immediately if no delimiter is used.

@default 2

delimiters'#' | '*' | ''

This is the delimiter(s) that will be used to process the input. Can be '#', '*', or an empty array.

phoneNumberIdstring

This will return calls with the specified phoneNumberId.

numberE164CheckEnabledboolean

This is the flag to toggle the E164 check for the number field. This is an advanced property which should be used if you know your use case requires it.

Use cases:

  • false: To allow non-E164 numbers like +001234567890, 1234, or abc. This is useful for dialing out to non-E164 numbers on your SIP trunks.
  • true (default): To allow only E164 numbers like +14155551234. This is standard for PSTN calls.

If false, the number is still required to only contain alphanumeric characters (regex: /^\+?[a-zA-Z0-9]+$/).

@default true (E164 check is enabled)

extensionstring

This is the extension that will be dialed after the call is answered.

{"stackTrail":"paths:/v2/call:get:parameters:44:schema","oasType":"schema","type":"unknown"}

These are the overrides for the assistant's settings and template variables specific to this customer. This allows customization of the assistant's behavior for individual customers in batch calls.

numberstring

This is the number of the customer.

sipUristring

This is the SIP URI of the customer.

namestring

This is the name of the customer. This is just for your own reference.

For SIP inbound calls, this is extracted from the From SIP header with format "Display Name" <sip:username@domain>.

emailstring

This is the email of the customer.

externalIdstring

This is the external ID of the customer.

structuredOutputsobject

Filter calls by structured output values. Use structured output ID as key and filter operators as values.

{
  "c9dddda4-d70a-4dad-aa5c-aaf117f85cea": {
    "eq": "2",
    "gt": "1"
  }
}
pagenumber

This is the page number to return. Defaults to 1.

sortOrder'ASC' | 'DESC'

This is the sort order for pagination. Defaults to 'DESC'.

limitnumber

This is the maximum number of items to return. Defaults to 100.

createdAtGtstring date-time

This will return items where the createdAt is greater than the specified value.

createdAtLtstring date-time

This will return items where the createdAt is less than the specified value.

createdAtGestring date-time

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLestring date-time

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGtstring date-time

This will return items where the updatedAt is greater than the specified value.

updatedAtLtstring date-time

This will return items where the updatedAt is less than the specified value.

updatedAtGestring date-time

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLestring date-time

This will return items where the updatedAt is less than or equal to the specified value.

Response

Changes