Skip to main content

OutboundCallRequestResponse

requestIdstring<uuid>required
statusOutboundCallRequestStatusrequired

Possible values: [queued, checking_capacity, submitting, submission_unknown, submitted, failed, cancelled]

statusUrlstringrequired
queuedAtstring<date-time>required
queuePositioninteger | nullnullablerequired

Possible values: >= 1

retryAfterSecondsinteger | nullnullablerequired

Possible values: >= 1

fromNumberstringrequired
toNumberstringrequired
callGroupstring<uuid>required
capacityReasonstring | nullnullablerequired
dispatchScheduledboolean

Present on create responses. False means the durable reconciler will schedule dispatch.

result objectrequired
oneOf
callIdstringrequired
agentIdstring
callStatusstringrequired
fromNumberstringrequired
toNumberstringrequired
callGroupstringrequired
errorstring | nullnullablerequired
OutboundCallRequestResponse
{
  "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "queued",
  "statusUrl": "string",
  "queuedAt": "2024-07-29T15:51:28.071Z",
  "queuePosition": 0,
  "retryAfterSeconds": 0,
  "fromNumber": "string",
  "toNumber": "string",
  "callGroup": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "capacityReason": "string",
  "dispatchScheduled": true,
  "result": {
    "callId": "string",
    "agentId": "string",
    "callStatus": "string",
    "fromNumber": "string",
    "toNumber": "string",
    "callGroup": "string"
  },
  "error": "string"
}