Dequeue
Introduction
The dequeue command is used to place a call from the front of a specified queue and bridges that call to the current caller.
The enqueue command can accept the following attributes:
Options
Option |
Description |
Required |
---|---|---|
name |
Name of the queue. |
yes |
actionHook |
A webhook invoke when call ends. If no webhook is provided, execution will continue with the next verb in the current application. See below for specified request parameters. |
no |
beep |
if true, play a beep tone to this caller only just prior to connecting the queued call; this provides an auditory cue that the call is now connected. |
no |
timeout |
number of seconds to wait on an empty queue before returning (default: wait forever). |
no |
The actionHook webhook will contain a dequeueResult property indicating the completion reason:
‘hangup: the bridged call was abandoned while listening to the confirmHook message.
‘complete’: the call was successfully bridged and ended with a caller hangup.
‘timeout’: no call appeared in the named queue during the timeout interval.
‘error’: the current number of calls in the queue.
Example
{
"verb": "dequeue",
"name": "support",
"beep": true,
"timeout": 60
}
Please contact us for timely support via:
Phone: 1900-1563
Email: support@epacific.com.vn