Files
next-static-site/markdown/docs/webhooks/enqueue.md
Brandon Lee Kitajchuk db94b17829 Latest news + banner, cypress tests, open source copy, general style tweaks (#13)
* Adding latest news and banners

* Adding first draft of cypress specs and github actions workflow

* Adding sticky position for top banner

* Tweak styles for new latest news section

* Tweak styles for text__layout innerHTML

* Fix Cypress homepage test spec

* Fix mobile navi z-index with sticky top banner

* Fix sticky banner z-index bug with mobile navi

* Refactor markdown tools to support pages beyond developer docs

* Adjust TADHACK text max-widths for small mobile

* initial changes for open source copy

* more copy

* more copy

* updated open source structure

* minor

* typo

* more copy

* Adjust styles for Open Source markdown small text

* Update readme and remove floats from docs webhooks markdown

* Add readme notes on Cypress and flesh out navi spec tests

* Fix main navi highlight when on sub-sections of markdown pages

Co-authored-by: Dave Horton <daveh@beachdognet.com>
2021-07-22 12:34:01 -04:00

1.9 KiB

enqueue

The enqueue command is used to place a caller in a queue.

{
	"verb": "enqueue",
	"name": "support",
	"actionHook": "/queue-action",
	"waitHook": "/queue-wait"
}

You can use the following options in the enqueue command:

option description required
name name of the queue yes
actionHook A webhook invoke when operation completes.
If a call is dequeued through the leave verb, the webook 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.
no
waitHook 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
no

The actionHook webhook will contain the following additional parameters:

  • 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

The waitHook webhook will contain the following additional parameters:

  • 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

Prev: dialogflow Next: gather