Retrieve your API Key from Dashboard.
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 assistant ID that will be used for the call. To use a transient assistant, use assistant instead.
To start a call with:
assistantId or assistantsquadId or squadworkflowId or workflowThis is the assistant that will be used for the call. To use an existing assistant, use assistantId instead.
To start a call with:
assistantsquadworkflowThese 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 or assistantIdsquad or squadIdworkflow or workflowIdThis is a squad that will be used for the call. To use an existing squad, use squadId instead.
To start a call with:
assistant or assistantIdsquad or squadIdworkflow or workflowIdThese are the overrides for the squad or squadId’s member settings and template variables.
This will apply to all members of the squad.
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 or assistantIdsquad or squadIdworkflow or workflowIdThis is a workflow that will be used for the call. To use an existing workflow, use workflowId instead.
To start a call with:
assistant or assistantIdsquad or squadIdworkflow or workflowIdThese 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.