Skip to main content
POST
Enqueue an inbound call for ACD dispatch

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Queue identifier (queue_<hex>).

Minimum string length: 1

Body

application/json
callControlId
string

Live call identifier on the voice platform (call-control leg id).

Minimum string length: 1
callerNumber
string

Caller CLI in E.164; used for callback and textback follow-ups.

Minimum string length: 1
priority
number
default:10

Waiting-list lane; 0 jumps to the head of the queue, 10 is the default lane.

Required range: 0 <= x <= 99
requiredSkills
string[]

Skill tags an agent must hold to be eligible; empty means any agent.

Minimum string length: 1

Response

Standard error envelope. error.code is machine-readable; see the error reference for the catalogue.

error
object
meta
object