POST
/
api
/
v1
/
agent
/
{agentId}
/
dispatch
Dispatch audio agent
curl --request POST \
  --url https://prod.featherhq.com/api/v1/agent/{agentId}/dispatch \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "versionId": "<string>",
  "outboundPhoneNumberId": "<string>",
  "leadId": "<string>",
  "toPhoneNumber": "<string>",
  "roomName": "<string>",
  "firstName": "<string>",
  "metadata": "<string>",
  "mode": "audio",
  "zipcode": "<string>",
  "customer": {
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "variables": {},
  "forwardingNumber": "<string>"
}'
{
  "id": "<string>",
  "status": "queued",
  "connectionDetails": {
    "serverUrl": "<string>",
    "roomName": "<string>",
    "participantName": "<string>",
    "participantToken": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

Path Parameters

agentId
string
required

Body

application/json

Response

201
application/json

Explicit dispatch created successfully

The response is of type object.