Skip to main content
POST
Dispatch audio agent

Authorizations

X-API-Key
string
header
required

Path Parameters

agentId
string
required

Body

application/json
leadId
string
required
firstName
string
required
versionId
string
outboundPhoneNumberId
string
toPhoneNumber
string
Pattern: ^\+1(\d{10}|\d{3}-\d{3}-\d{4})|^\+[1-9]\d{1,14}$
metadata
object
mode
enum<string>
default:audio
Available options:
audio,
web
zipcode
string | null
Pattern: ^\d{5}(-?\d{4})?$
customer
object
variables
object
forwardingNumber
string
Pattern: ^\+1(\d{10}|\d{3}-\d{3}-\d{4})|^\+[1-9]\d{1,14}$

Response

Explicit dispatch created successfully

id
string
required
status
enum<string>
required
Available options:
queued
connectionDetails
object