Feat/queue enhancements (#70)

* queue changes

* minor

* dequeue changes

* note release that priority queues were added in
This commit is contained in:
Dave Horton authored and GitHub committed 2023-06-08 08:58:00 -04:00
1 parent c1a21bf03a
commit 6e08a3bfba
2 files changed
+10 -2

No files matched your search

+4 -1
View File
@@ -1,5 +1,7 @@
# dequeue
The `dequeue` verb removes the a call from the front of a specified queue and bridges that call to the current caller.
The `dequeue` verb removes the lowest priority call from a specified queue and bridges that call to the current caller.
Note that (as of release 0.8.3-4) calls can optionally be [enqueued](/docs/webhooks/enqueue) with priority values that will dictate how they are ordered in the queue. If priorities are not specified then the queue will operate in FIFO order.
```json
{
@@ -15,6 +17,7 @@ You can use the following options in the `dequeue` command:
| option | description | required |
| ------------- |-------------| -----|
| name | name of the queue | yes |
| callSid | a specific call to dequeue; if not provided the lowest priority call or the call at the head of the queue will be dequeued | no|
| actionHook | A webhook invoke when call ends. If no webhook is provided, execution will continue with the next verb in the current application. <br/>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 |