Calls

List Calls

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

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.

limitdoubleOptional0-1000
This is the maximum number of items to return. Defaults to 100.
createdAtGtdatetimeOptional
This will return items where the createdAt is greater than the specified value.
createdAtLtdatetimeOptional
This will return items where the createdAt is less than the specified value.
createdAtGedatetimeOptional
This will return items where the createdAt is greater than or equal to the specified value.
createdAtLedatetimeOptional
This will return items where the createdAt is less than or equal to the specified value.
updatedAtGtdatetimeOptional
This will return items where the updatedAt is greater than the specified value.
updatedAtLtdatetimeOptional
This will return items where the updatedAt is less than the specified value.
updatedAtGedatetimeOptional
This will return items where the updatedAt is greater than or equal to the specified value.
updatedAtLedatetimeOptional
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.

typeenum
This is the type of call.
Allowed values:
costslist of objects
These are the costs of individual components of the call in USD.
messageslist of objects
phoneCallTransportenum

This is the transport of the phone call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

Allowed values:
statusenum
This is the status of the call.
endedReasonenum
This is the explanation for how the call ended.
endedMessagestring
This is the message that adds more context to the ended reason. It can be used to provide potential error messages or warnings.
destinationobject
This is the destination where the call ended up being transferred to. If the call was not transferred, this will be empty.
startedAtdatetime

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

endedAtdatetime

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

costdouble
This is the cost of the call in USD.
costBreakdownobject
This is the cost of the call in USD.
artifactPlanobject

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.

analysisobject

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

monitorobject

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

artifactobject

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

complianceobject

This is the compliance of the call. Configure in assistant.compliancePlan.

campaignIdstring
This is the campaign ID that the call belongs to.
assistantIdstring
This is the assistant ID that will be used for the call. To use a transient assistant, use `assistant` instead. To start a call with: - Assistant, use `assistantId` or `assistant` - Squad, use `squadId` or `squad` - Workflow, use `workflowId` or `workflow`
assistantobject
This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. To start a call with: - Assistant, use `assistant` - Squad, use `squad` - Workflow, use `workflow`
assistantOverridesobject

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

squadIdstring
This is the squad that will be used for the call. To use a transient squad, use `squad` instead. To start a call with: - Assistant, use `assistant` or `assistantId` - Squad, use `squad` or `squadId` - Workflow, use `workflow` or `workflowId`
squadobject
This is a squad that will be used for the call. To use an existing squad, use `squadId` instead. To start a call with: - Assistant, use `assistant` or `assistantId` - Squad, use `squad` or `squadId` - Workflow, use `workflow` or `workflowId`
squadOverridesobject

These are the overrides for the squad or squadId’s member settings and template variables. This will apply to all members of the squad.

workflowIdstring
This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead. To start a call with: - Assistant, use `assistant` or `assistantId` - Squad, use `squad` or `squadId` - Workflow, use `workflow` or `workflowId`
workflowobject
This is a workflow that will be used for the call. To use an existing workflow, use `workflowId` instead. To start a call with: - Assistant, use `assistant` or `assistantId` - Squad, use `squad` or `squadId` - Workflow, use `workflow` or `workflowId`
workflowOverridesobject

These are the overrides for the workflow or workflowId’s settings and template variables.

phoneNumberIdstring

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.

phoneNumberobject

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.

customerIdstring

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

Only relevant for outboundPhoneCall and inboundPhoneCall type.

customerobject

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

Only relevant for outboundPhoneCall and inboundPhoneCall type.

namestring<=40 characters
This is the name of the call. This is just for your own reference.
schedulePlanobject
This is the schedule plan of the call.
transportobject
This is the transport of the call.
phoneCallProviderenumDeprecated

This is the provider of the call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

Allowed values:
phoneCallProviderIdstringDeprecated

The ID of the call as provided by the phone number service. callSid in Twilio. conversationUuid in Vonage. callControlId in Telnyx.

Only relevant for outboundPhoneCall and inboundPhoneCall type.