Verbs

Enqueue

Place a caller in a queue.

1{
2	"verb": "enqueue",
3	"name": "support",
4	"actionHook": "/queue-action",
5	"waitHook": "/queue-wait"
6}

Parameters

actionHook
string

A webhook invoked when the operation completes.

  • If a call is dequeued through the leave verb, the webhook is immediately invoked.
  • If the call has been bridged to another party via the dequeue verb, then the webhook is invoked after both parties have disconnected.
  • If no webhook is provided, execution will continue with the next verb in the current application.
    See below for specified request parameters.
name
stringRequired

Name of the queue.

priority
number

(Added in 0.8.3-4) Optional priority value between 0 and 999.
Calls are dequeued in priority order, lowest to highest.
Default: 999.

waitHook
string

A webhook to invoke while the caller is in queue.
The only allowed verbs in the application returned from this webhook are say, play, pause, and leave.
See below for additional request parameters.

actionHook properties

  • queueSid: the unique identifier for the queue
  • queueResult: the completion reason:
    • ‘hangup’ - the call was abandoned while in queue
    • ‘leave’ - a leave verb caused the call to exit the queue
    • ‘bridged’ - a dequeue verb caused the call to be bridged to another call
    • ‘error’ - a system error of some kind occurred
  • queueTime - the number of seconds the call spent in queue
  • queueSize - the number of calls remaining in queue
  • queuePosition - the zero-based position of the call in queue before it was removed
  • callSid - the unique identifier for the call
  • callId - the sip Call-ID for the call

waitHook properties

  • queueSid: the unique identifier for the queue
  • queuePosition: the current zero-based position in the queue
  • queueTime: the current number of seconds the call has spent in queue
  • queueSize: the current number of calls in the queue