List Calls
Authentication
AuthorizationBearer
Retrieve your API Key from Dashboard.
Query parameters
assistantId
This will return calls with the specified assistantId.
assistantName
This will return calls where the transient assistant name exactly matches the specified value (case-insensitive).
id
This will return calls with the specified callId.
idAny
This will return calls with the specified callIds.
costLe
This will return calls where the cost is less than or equal to the specified value.
costGe
This will return calls where the cost is greater than or equal to the specified value.
cost
This will return calls with the exact specified cost.
successEvaluation
This will return calls with the specified successEvaluation.
endedReason
This will return calls with the specified endedReason.
transcriber
These are the options for the assistant's transcriber.
model
These are the options for the assistant's LLM.
voice
These are the options for the assistant's voice.
firstMessage
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.
firstMessageInterruptionsEnabled
firstMessageMode
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'
Allowed values:
voicemailDetection
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.
clientMessages
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.
serverMessages
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.
maxDurationSeconds
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)
backgroundSound
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.
modelOutputInMessagesEnabled
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
transportConfigurations
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.
observabilityPlan
This is the plan for observability of assistant's calls.
Currently, only Langfuse is supported.
credentials
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.
hooks
This is a set of actions that will be performed on certain events.
variableValues
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
name
This is the name of the assistant.
This is required when you want to transfer between assistants in a call.
voicemailMessage
This is the message that the assistant will say if the call is forwarded to voicemail.
If unspecified, it will hang up.
endCallMessage
This is the message that the assistant will say if it ends the call.
If unspecified, it will hang up without saying anything.
endCallPhrases
This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
compliancePlan
metadata
This is for metadata you want to store on the assistant.
backgroundSpeechDenoisingPlan
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
analysisPlan
This is the plan for analysis of assistant’s calls. Stored in call.analysis.
artifactPlan
This is the plan for artifacts generated during assistant’s calls. Stored in call.artifact.
startSpeakingPlan
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.
stopSpeakingPlan
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.
monitorPlan
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`.
credentialIds
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.
server
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:
- assistant.server.url
- phoneNumber.serverUrl
- org.serverUrl
keypadInputPlan
phoneNumberId
This will return calls with the specified phoneNumberId.
numberE164CheckEnabled
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)
extension
This is the extension that will be dialed after the call is answered.
assistantOverrides
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.
number
This is the number of the customer.
sipUri
This is the SIP URI of the customer.
name
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>.
email
This is the email of the customer.
externalId
This is the external ID of the customer.
structuredOutputs
Filter calls by structured output values. Use structured output ID as key and filter operators as values.
page
This is the page number to return. Defaults to 1.
sortOrder
This is the sort order for pagination. Defaults to 'DESC'.
Allowed values:
limit
This is the maximum number of items to return. Defaults to 100.
createdAtGt
This will return items where the createdAt is greater than the specified value.
createdAtLt
This will return items where the createdAt is less than the specified value.
createdAtGe
This will return items where the createdAt is greater than or equal to the specified value.
createdAtLe
This will return items where the createdAt is less than or equal to the specified value.
updatedAtGt
This will return items where the updatedAt is greater than the specified value.
updatedAtLt
This will return items where the updatedAt is less than the specified value.
updatedAtGe
This will return items where the updatedAt is greater than or equal to the specified value.
updatedAtLe
This will return items where the updatedAt is less than or equal to the specified value.
Response
results
metadata
