Create Call
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This is used to issue batch calls to multiple customers.
Only relevant for outboundPhoneCall
. To call a single customer, use customer
instead.
This is the name of the call. This is just for your own reference.
This is the schedule plan of the call.
This is the transport of the call.
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
[BETA] This feature is in active development. The API and behavior are subject to change as we refine it based on user feedback.
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
[BETA] This feature is in active development. The API and behavior are subject to change as we refine it based on user feedback.
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
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.