Skip to end of metadata
Go to start of metadata

Queue()

Synopsis

Queue a call for a call queue.

Description

In addition to transferring the call, a call may be parked and then picked up by another user.

This application will return to the dialplan if the queue does not exist, or any of the join options cause the caller to not enter the queue.

This application does not automatically answer and should be preceeded by an application such as Answer(), Progress(), or Ringing().

This application sets the following channel variables upon completion:

  • QUEUESTATUS - The status of the call as a text string.
    • TIMEOUT
    • FULL
    • JOINEMPTY
    • LEAVEEMPTY
    • JOINUNAVAIL
    • LEAVEUNAVAIL
    • CONTINUE
    • WITHDRAW
  • ABANDONED - If the call was not answered by an agent this variable will be TRUE.
    • TRUE
  • DIALEDPEERNUMBER - Resource of the agent that was dialed set on the outbound channel.
  • QUEUE_WITHDRAW_INFO - If the call was successfully withdrawn from the queue, and the withdraw request was provided with optional withdraw info, the withdraw info will be stored in this variable.

Syntax

Queue(queuename,[options,[URL,filename&[filename2[&...]],[timeout,[AGI,[macro,[gosub,[rule,[position]]]]]]]]])
Arguments
  • queuename
  • options
    • b( context^exten^priority ) - Before initiating an outgoing call, Gosub to the specified location using the newly created channel. The Gosub will be executed for each destination channel.
      • context
      • exten
      • priority( params )
        • arg1[^arg1...]
        • argN
    • B( context^exten^priority ) - Before initiating the outgoing call(s), Gosub to the specified location using the current channel.
      • context
      • exten
      • priority( params )
        • arg1[^arg1...]
        • argN
    • C - Mark all calls as "answered elsewhere" when cancelled.
    • c - Continue in the dialplan if the callee hangs up.
    • d - Data-quality (modem) call (minimum delay).
      This option only applies to DAHDI channels. By default, DTMF is verified by muting audio TX/RX to verify the tone is still present. This option disables that behavior.
    • F( context^exten^priority ) - When the caller hangs up, transfer the called member to the specified destination and start execution at that location.
      NOTE: Any channel variables you want the called channel to inherit from the caller channel must be prefixed with one or two underbars ('_').
      NOTE: Using this option from a Macro() or GoSub() might not make sense as there would be no return points.
      • context
      • exten
      • priority
    • h - Allow callee to hang up by pressing *.
    • H - Allow caller to hang up by pressing *.
    • i - Ignore call forward requests from queue members and do nothing when they are requested.
    • I - Asterisk will ignore any connected line update requests or any redirecting party update requests it may receive on this dial attempt.
    • k - Allow the called party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf.
    • K - Allow the calling party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf.
    • m - Custom music on hold class to use, which will override the music on hold class configured in queues.conf, if specified.
      Note that CHANNEL(musicclass), if set, will still override this option.
    • n - No retries on the timeout; will exit this application and go to the next step.
    • r - Ring instead of playing MOH. Periodic Announcements are still made, if applicable.
    • R - Ring instead of playing MOH when a member channel is actually ringing.
    • t - Allow the called user to transfer the calling user.
    • T - Allow the calling user to transfer the call.
    • w - Allow the called user to write the conversation to disk via Monitor.
    • W - Allow the calling user to write the conversation to disk via Monitor.
    • x - Allow the called user to write the conversation to disk via MixMonitor.
    • X - Allow the calling user to write the conversation to disk via MixMonitor.
  • URL - URL will be sent to the called party if the channel supports it.
  • announceoverride
    • filename - Announcement file(s) to play to agent before bridging call, overriding the announcement(s) configured in queues.conf, if any.
    • filename2[,filename2...]
  • timeout - Will cause the queue to fail out after a specified number of seconds, checked between each queues.conf timeout and retry cycle.
  • AGI - Will setup an AGI script to be executed on the calling party's channel once they are connected to a queue member.
  • macro - Will run a macro on the called party's channel (the queue member) once the parties are connected.
    NOTE: Macros are deprecated, GoSub should be used instead.
  • gosub - Will run a gosub on the called party's channel (the queue member) once the parties are connected. The subroutine execution starts in the named context at the s exten and priority 1.
  • rule - Will cause the queue's defaultrule to be overridden by the rule specified.
  • position - Attempt to enter the caller into the queue at the numerical position specified. 1 would attempt to enter the caller at the head of the queue, and 3 would attempt to place the caller third in the queue.

See Also

Import Version

This documentation was imported from Asterisk Version GIT-20-de15852

  • No labels