Wipple CPaaS
Menu
Guide
Introduction Getting started
Functions
Overview Agent Alert Answer Conference Config Dequeue Dial Dialogflow DTMF Dub Enqueue Gather Hangup Leave Listen LLM Pause Play Rasa Recognizer Redirect Say SIP Decline SIP Refer SIP Request Synthesizer Tag Transcribe Transfer
REST API
About the REST API Create a call List calls Get a call Update a call Delete a call Get call count List conferences Start conference listen Stop conference listen List queues
Webhooks
Overview New Call (POST) New Call (GET) Client Authentication Client Tool Request
Functions / Dequeue

Dequeue

Note

Calls can optionally be enqueued 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.

{
  "verb": "dequeue",
  "name": "support",
  "beep": true,
  "timeout": 60
}

Parameters

namestringrequired

name of the queue

callSidstring

a specific call to dequeue; if not provided, the lowest priority call or the call at the head of the queue will be dequeued

actionHookstring

A webhook invoked when the call ends. If no webhook is provided, execution will continue with the next Function in the current application.
See below for specified request parameters.

beepboolean

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

timeoutnumber

number of seconds to wait on an empty queue before returning (default: wait forever)

actionHook properties

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' - a system error of some kind occurred
← ConfigDial →