Calls

Create Call

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
customerslist of objectsOptional

This is used to issue batch calls to multiple customers.

Only relevant for outboundPhoneCall. To call a single customer, use customer instead.

namestringOptional<=40 characters

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

schedulePlanobjectOptional

This is the schedule plan of the call.

transportmap from strings to anyOptional

This is the transport of the call.

assistantIdstringOptional

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
assistantobjectOptional

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
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.

To start a call with:

  • Assistant, use assistant or assistantId
  • Squad, use squad or squadId
  • Workflow, use workflow or workflowId
squadobjectOptional

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
workflowIdstringOptional

[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 or assistantId
  • Squad, use squad or squadId
  • Workflow, use workflow or workflowId
workflowobjectOptional

[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 or assistantId
  • Squad, use squad or squadId
  • Workflow, use workflow or workflowId
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.

Response

object
OR
object