List Calls
Query parameters
This is the unique identifier for the call.
This will return calls with the specified assistantId.
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.
This is the maximum number of items to return. Defaults to 100.
This will return items where the createdAt is greater than the specified value.
This will return items where the createdAt is less than the specified value.
This will return items where the createdAt is greater than or equal to the specified value.
This will return items where the createdAt is less than or equal to the specified value.
This will return items where the updatedAt is greater than the specified value.
This will return items where the updatedAt is less than the specified value.
This will return items where the updatedAt is greater than or equal to the specified value.
This will return items where the updatedAt is less than or equal to the specified value.
Response
This is the type of call.
This is the provider of the call.
Only relevant for outboundPhoneCall and inboundPhoneCall type.
This is the transport of the phone call.
Only relevant for outboundPhoneCall and inboundPhoneCall type.
This is the status of the call.
This is the explanation for how the call ended.
This is the message that adds more context to the ended reason. It can be used to provide potential error messages or warnings.
This is the assistant version to use for this call. Supported only with direct assistantId. Omit to follow the latest version.
This is the unique identifier for the call.
This is the unique identifier for the org that this call belongs to.
This is the ISO 8601 date-time string of when the call was created.
This is the ISO 8601 date-time string of when the call was last updated.
This is the ISO 8601 date-time string of when the call was started.
This is the ISO 8601 date-time string of when the call was ended.
This is the cost of the call in USD.
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.
This is the campaign ID that the call belongs to.
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
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
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
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.
This is the customer that will be called. To call a transient customer , use customer instead.
Only relevant for outboundPhoneCall and inboundPhoneCall type.
This is the name of the call. This is just for your own reference.