Get Call
Path parameters
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
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 transport of the phone call.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
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 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.
This is the analysis of the call. Configure in assistant.analysisPlan
.
This is to real-time monitor the call. Configure in assistant.monitorPlan
.
These are the artifacts created from the call. Configure in assistant.artifactPlan
.
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
orassistant
- Squad, use
squadId
orsquad
- Workflow, use
workflowId
orworkflow
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
These are the overrides for the assistant
or assistantId
’s settings and template variables.
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
orassistantId
- Squad, use
squad
orsquadId
- Workflow, use
workflow
orworkflowId
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
orassistantId
- Squad, use
squad
orsquadId
- Workflow, use
workflow
orworkflowId
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
orassistantId
- Squad, use
squad
orsquadId
- Workflow, use
workflow
orworkflowId
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
orassistantId
- Squad, use
squad
orsquadId
- Workflow, use
workflow
orworkflowId
These are the overrides for the workflow
or workflowId
’s settings and template variables.
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 phone number that will be used for the call. To use an existing number, use phoneNumberId
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 customer that will be called. To call an existing customer, use customerId
instead.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
This is the provider of the call.
Only relevant for outboundPhoneCall
and inboundPhoneCall
type.
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.