Scribd
Upload
69 views

List Calls VAPI

VAPI API

Uploaded by

mafechu
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
69 views

List Calls VAPI

VAPI API

Uploaded by

mafechu
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
You are on page 1/ 6

List Calls

GET
https://api.vapi.ai/call
Headers
Auth
Authorization
string
Required
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
assistantId
string
Optional
This will return calls with the specified assistantId.

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

createdAtGt
datetime
Optional
Defaults to 1970-01-01T00:00:00.000Z
This will return items where the createdAt is greater than the specified value.

createdAtLt
datetime
Optional
Defaults to 1970-01-01T00:00:00.000Z
This will return items where the createdAt is less than the specified value.

createdAtGe
datetime
Optional
Defaults to 1970-01-01T00:00:00.000Z
This will return items where the createdAt is greater than or equal to the
specified value.

createdAtLe
datetime
Optional
Defaults to 1970-01-01T00:00:00.000Z
This will return items where the createdAt is less than or equal to the specified
value.

updatedAtGt
datetime
Optional
Defaults to 1970-01-01T00:00:00.000Z
This will return items where the updatedAt is greater than the specified value.

updatedAtLt
datetime
Optional
Defaults to 1970-01-01T00:00:00.000Z
This will return items where the updatedAt is less than the specified value.

updatedAtGe
datetime
Optional
Defaults to 1970-01-01T00:00:00.000Z
This will return items where the updatedAt is greater than or equal to the
specified value.

updatedAtLe
datetime
Optional
Defaults to 1970-01-01T00:00:00.000Z
This will return items where the updatedAt is less than or equal to the specified
value.

Response
id
string
This is the unique identifier for the call.

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

createdAt
datetime
Defaults to 1970-01-01T00:00:00.000Z
This is the ISO 8601 date-time string of when the call was created.

updatedAt
datetime
Defaults to 1970-01-01T00:00:00.000Z
This is the ISO 8601 date-time string of when the call was last updated.

type
enum
Optional
Allowed values:
inboundPhoneCall
outboundPhoneCall
webCall
This is the type of call.

costs
list of objects
Optional
These are the costs of individual components of the call in USD.

Show 6 variants
messages
list of objects
Optional

Show 5 variants
phoneCallProvider
enum
Optional
Allowed values:
twilio
vonage
vapi
This is the provider of the call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

phoneCallTransport
"sip" or "pstn"
Optional
Allowed values:
sip
pstn
This is the transport of the phone call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

status
enum
Optional
Allowed values:
queued
ringing
in-progress
forwarding
ended
This is the status of the call.

endedReason
enum
Optional
This is the explanation for how the call ended.

Show 168 enum values


destination
object
Optional
This is the destination where the call ended up being transferred to. If the call
was not transferred, this will be empty.

Show 2 variants
startedAt
datetime
Optional
Defaults to 1970-01-01T00:00:00.000Z
This is the ISO 8601 date-time string of when the call was started.

endedAt
datetime
Optional
Defaults to 1970-01-01T00:00:00.000Z
This is the ISO 8601 date-time string of when the call was ended.

cost
double
Optional
This is the cost of the call in USD.

costBreakdown
object
Optional
This is the cost of the call in USD.

Show 10 properties
artifactPlan
object
Optional
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.

Show 4 properties
analysis
object
Optional
This is the analysis of the call. Configure in assistant.analysisPlan.

Show 3 properties
monitor
object
Optional
This is to real-time monitor the call. Configure in assistant.monitorPlan.

Show 2 properties
artifact
object
Optional
These are the artifacts created from the call. Configure in assistant.artifactPlan.

Show 7 properties
phoneCallProviderId
string
Optional
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.

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

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

Show 30 properties
assistantOverrides
object
Optional
These are the overrides for the assistant or assistantId’s settings and template
variables.

Show 31 properties
squadId
string
Optional
This is the squad that will be used for the call. To use a transient squad, use
squad instead.

squad
object
Optional
This is a squad that will be used for the call. To use an existing squad, use
squadId instead.

Show 3 properties
phoneNumberId
string
Optional
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
Optional
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.

Show 9 properties
customerId
string
Optional
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
Optional
This is the customer that will be called. To call an existing customer, use
customerId instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

Show 5 properties
name
string
Optional
This is the name of the call. This is just for your own

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy