List Calls

GET

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

idstringOptional

This is the unique identifier for the call.

assistantIdstringOptional

This will return calls with the specified assistantId.

phoneNumberIdstringOptional

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.

limitdoubleOptional>=0<=1000

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

createdAtGtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

createdAtLtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

createdAtGedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

createdAtLedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

updatedAtGtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

updatedAtLtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

updatedAtGedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

updatedAtLedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

Response

idstring

This is the unique identifier for the call.

orgIdstring

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

createdAtdatetime

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

updatedAtdatetime

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

typeenumOptional
Allowed values: inboundPhoneCalloutboundPhoneCallwebCall

This is the type of call.

costslist of objectsOptional

These are the costs of individual components of the call in USD.

messageslist of objectsOptional
phoneCallProviderenumOptional
Allowed values: twiliovonagevapi

This is the provider of the call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

phoneCallTransport"sip" or "pstn"Optional
Allowed values: sippstn

This is the transport of the phone call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

statusenumOptional
Allowed values: queuedringingin-progressforwardingended

This is the status of the call.

endedReasonenumOptional

This is the explanation for how the call ended.

destinationobjectOptional

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

startedAtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

endedAtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

costdoubleOptional

This is the cost of the call in USD.

costBreakdownobjectOptional

This is the cost of the call in USD.

artifactPlanobjectOptional

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.

analysisobjectOptional

This is the analysis of the call. Configure in assistant.analysisPlan.

monitorobjectOptional

This is to real-time monitor the call. Configure in assistant.monitorPlan.

artifactobjectOptional

These are the artifacts created from the call. Configure in assistant.artifactPlan.

transportobjectOptional

This is the transport used for the call.

phoneCallProviderIdstringOptional

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.

assistantIdstringOptional

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

assistantobjectOptional

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

assistantOverridesobjectOptional

These are the overrides for the assistant or assistantId’s settings and template variables.

squadIdstringOptional

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

squadobjectOptional

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

phoneNumberIdstringOptional

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.

phoneNumberobjectOptional

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.

customerIdstringOptional

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

Only relevant for outboundPhoneCall and inboundPhoneCall type.

customerobjectOptional

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

Only relevant for outboundPhoneCall and inboundPhoneCall type.

namestringOptional<=40 characters

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

Create Call
Built with