Expand setinterfacevar option to also set a variable, MEMBERNAME, which contains...
[asterisk/asterisk.git] / configs / queues.conf.sample
old mode 100755 (executable)
new mode 100644 (file)
index a510119..85064ae
@@ -3,14 +3,52 @@
 ; Global settings for call queues
 ;
 ; Persistent Members
 ; Global settings for call queues
 ;
 ; Persistent Members
-;    Store each dynamic agent in each queue in the astdb so that
-;    when asterisk is restarted, each agent will be automatically
-;    readded into their recorded queues. Default is 'yes'.
+;    Store each dynamic member in each queue in the astdb so that
+;    when asterisk is restarted, each member will be automatically
+;    read into their recorded queues. Default is 'yes'.
 ;
 persistentmembers = yes
 ;
 ;
 persistentmembers = yes
 ;
-; Note that a timeout to fail out of a queue may be passed as part of application call
-; from extensions.conf:
+; Keep Stats
+;    Keep queue statistics during a reload. Default is 'no'
+;
+keepstats = no
+; 
+; AutoFill Behavior
+;    The old/current behavior of the queue has a serial type behavior 
+;    in that the queue will make all waiting callers wait in the queue
+;    even if there is more than one available member ready to take
+;    calls until the head caller is connected with the member they 
+;    were trying to get to. The next waiting caller in line then
+;    becomes the head caller, and they are then connected with the
+;    next available member and all available members and waiting callers
+;    waits while this happens. The new behavior, enabled by setting
+;    autofill=yes makes sure that when the waiting callers are connecting
+;    with available members in a parallel fashion until there are
+;    no more available members or no more waiting callers. This is
+;    probably more along the lines of how a queue should work and 
+;    in most cases, you will want to enable this behavior. If you 
+;    do not specify or comment out this option, it will default to no
+;    to keep backward compatibility with the old behavior.
+;
+autofill = yes
+;
+; Monitor Type
+;    By setting monitor-type = MixMonitor, when specifying monitor-format
+;    to enable recording of queue member conversations, app_queue will
+;    now use the new MixMonitor application instead of Monitor so 
+;    the concept of "joining/mixing" the in/out files now goes away
+;    when this is enabled. You can set the default type for all queues
+;    here, and then also change monitor-type for individual queues within
+;    queue by using the same configuration parameter within a queue 
+;    configuration block. If you do not specify or comment out this option,
+;    it will default to the old 'Monitor' behavior to keep backward
+;    compatibility. 
+;
+monitor-type = MixMonitor
+;
+; Note that a timeout to fail out of a queue may be passed as part of
+; an application call from extensions.conf:
 ; Queue(queuename|[options]|[optionalurl]|[announceoverride]|[timeout])
 ; example: Queue(dave|t|||45)
 
 ; Queue(queuename|[options]|[optionalurl]|[announceoverride]|[timeout])
 ; example: Queue(dave|t|||45)
 
@@ -18,10 +56,12 @@ persistentmembers = yes
 ;
 ; A sample call queue
 ;
 ;
 ; A sample call queue
 ;
-; Musiconhold sets which music applies for this particular
-; call queue (configure classes in musiconhold.conf)
+; Musicclass sets which music applies for this particular call queue.
+; The only class which can override this one is if the MOH class is set
+; directly on the channel using Set(CHANNEL(musicclass)=whatever) in the
+; dialplan.
 ;
 ;
-;musiconhold = default
+;musicclass = default
 ;
 ; An announcement may be specified which is played for the member as
 ; soon as they answer a call, typically to indicate to them which queue
 ;
 ; An announcement may be specified which is played for the member as
 ; soon as they answer a call, typically to indicate to them which queue
@@ -43,7 +83,8 @@ persistentmembers = yes
 ;strategy = ringall
 ;
 ; Second settings for service level (default 0)
 ;strategy = ringall
 ;
 ; Second settings for service level (default 0)
-; Used for service level statistics (calls completed within service level time frame)
+; Used for service level statistics (calls answered within service level time
+; frame)
 ;servicelevel = 60
 ;
 ; A context may be specified, in which if the user types a SINGLE
 ;servicelevel = 60
 ;
 ; A context may be specified, in which if the user types a SINGLE
@@ -71,15 +112,39 @@ persistentmembers = yes
 ;
 ;wrapuptime=15
 ;
 ;
 ;wrapuptime=15
 ;
+; Autofill will follow queue strategy but push multiple calls through
+; at same time until there are no more waiting callers or no more
+; available members. The per-queue setting of autofill allows you
+; to override the default setting on an individual queue level.
+; 
+;autofill=yes
+;
+; Autopause will pause a queue member if they fail to answer a call
+;
+;autopause=yes
+;
 ; Maximum number of people waiting in the queue (0 for unlimited)
 ;
 ;maxlen = 0
 ;
 ; Maximum number of people waiting in the queue (0 for unlimited)
 ;
 ;maxlen = 0
 ;
+; If set to yes, just prior to the caller being bridged with a queue member 
+; the MEMBERINTERFACE variable will be set with the interface name (eg. Agent/1234)
+; and the MEMBERNAME variable will be set with the member name (eg. Joe Soap)
+; of the queue member that was chosen and is now connected to be bridged with
+; the caller
+;
+;setinterfacevar=no
 ;
 ;
-; How often to announce queue position and/or estimated holdtime to caller (0=off)
+; How often to announce queue position and/or estimated 
+; holdtime to caller (0=off)
 ;
 ;announce-frequency = 90 
 ;
 ;
 ;announce-frequency = 90 
 ;
+;
+; How often to make any periodic announcement (see periodic-announce)
+;
+;periodic-announce-frequency=60
+;
 ; Should we include estimated hold time in position announcements?
 ; Either yes, no, or only once.
 ; Hold time will be announced as the estimated time, 
 ; Should we include estimated hold time in position announcements?
 ; Either yes, no, or only once.
 ; Hold time will be announced as the estimated time, 
@@ -89,67 +154,137 @@ persistentmembers = yes
 
 ;
 ; What's the rounding time for the seconds?
 
 ;
 ; What's the rounding time for the seconds?
-; If this is non zero then we announce the seconds as well as the minutes rounded to this value
+; If this is non-zero, then we announce the seconds as well as the minutes
+; rounded to this value.
 ;
 ; announce-round-seconds = 10
 ;
 ; Use these sound files in making position/holdtime announcements.  The
 ; defaults are as listed below -- change only if you need to.
 ;
 ;
 ; announce-round-seconds = 10
 ;
 ; Use these sound files in making position/holdtime announcements.  The
 ; defaults are as listed below -- change only if you need to.
 ;
-;queue-youarenext = queue-youarenext           ;       ("You are now first in line.")
-;queue-thereare        = queue-thereare                ;       ("There are")
-;queue-callswaiting = queue-callswaiting       ;       ("calls waiting.")
-;queue-holdtime = queue-holdtime               ;       ("The current est. holdtime is")
-;queue-minutes = queue-minutes                 ;       ("minutes.")
-;queue-seconds = queue-seconds                 ;       ("seconds.")
-;queue-thankyou = queue-thankyou               ;       ("Thank you for your patience.")
-;queue-lessthan = queue-less-than              ;       ("less than")
-;queue-reporthold = queue-reporthold           ;       ("Hold time")
-;
-; Calls may be recorded using Asterisk's monitor resource
+                       ;       ("You are now first in line.")
+;queue-youarenext = queue-youarenext           
+                       ;       ("There are")
+;queue-thereare        = queue-thereare
+                       ;       ("calls waiting.")
+;queue-callswaiting = queue-callswaiting
+                       ;       ("The current est. holdtime is")
+;queue-holdtime = queue-holdtime
+                       ;       ("minutes.")
+;queue-minutes = queue-minutes
+                       ;       ("seconds.")
+;queue-seconds = queue-seconds
+                       ;       ("Thank you for your patience.")
+;queue-thankyou = queue-thankyou
+                       ;       ("less than")
+;queue-lessthan = queue-less-than
+                       ;       ("Hold time")
+;queue-reporthold = queue-reporthold
+                       ;       ("All reps busy / wait for next")
+;periodic-announce = queue-periodic-announce
+;
+; Calls may be recorded using Asterisk's monitor/MixMonitor resource
 ; This can be enabled from within the Queue application, starting recording
 ; when the call is actually picked up; thus, only successful calls are
 ; recorded, and you are not recording while people are listening to MOH.
 ; To enable monitoring, simply specify "monitor-format";  it will be disabled
 ; otherwise.
 ;
 ; This can be enabled from within the Queue application, starting recording
 ; when the call is actually picked up; thus, only successful calls are
 ; recorded, and you are not recording while people are listening to MOH.
 ; To enable monitoring, simply specify "monitor-format";  it will be disabled
 ; otherwise.
 ;
-; You can specify the monitor filename with by calling SetVar(MONITOR_FILENAME=foo)
-; Otherwise it will use ${UNIQUEID}
+; You can specify the monitor filename with by calling
+;    Set(MONITOR_FILENAME=foo)
+; Otherwise it will use MONITOR_FILENAME=${UNIQUEID}
+;
+; Pick any one valid extension for monitor format recording. If you leave
+; monitor-format commented out, it will not record calls.
 ;
 ; monitor-format = gsm|wav|wav49
 ;
 ;
 ; monitor-format = gsm|wav|wav49
 ;
-; If you wish to have the two files joined together when the call ends set this to yes
+; Monitor Type
+;    By setting monitor-type = MixMonitor, when specifying monitor-format
+;    to enable recording of queue member conversations, app_queue will
+;    now use the new MixMonitor application instead of Monitor so
+;    the concept of "joining/mixing" the in/out files now goes away
+;    when this is enabled. If you do not specify or comment out this option,
+;    it will default to the old 'Monitor' behavior to keep backward
+;    compatibility.
+;
+; monitor-type = MixMonitor
+;
+; ----------------------- TYPE MONITOR OPTIONS --------------------------------
+;
+; If you wish to have the two files joined together when the call ends, set this
+; to yes.
 ;
 ; monitor-join = yes
 ;
 ;
 ; monitor-join = yes
 ;
-; This setting controls whether callers can join a queue with no members. There are three
-; choices:
+; This setting controls whether callers can join a queue with no members. There
+; are three choices:
+;
+; yes    - callers can join a queue with no members or only unavailable members
+; no     - callers cannot join a queue with no members
+; strict - callers cannot join a queue with no members or only unavailable
+;          members
+;
+; ----------------------- TYPE MIXMONITOR OPTIONS -----------------------------
+;
+;
+; You can specify the options supplied to MixMonitor by calling
+;   Set(MONITOR_OPTIONS=av(<x>)V(<x>)W(<x>))
+; The 'b' option for MixMonitor (only save audio to the file while bridged) is 
+; implied.
+;
+; You can specify a post recording command to be executed after the end of
+; recording by calling
+;   Set(MONITOR_EXEC=mv /var/spool/asterisk/monitor/^{MONITOR_FILENAME} /tmp/^{MONITOR_FILENAME})
+;
+; The command specified within the contents of MONITOR_EXEC will be executed when
+; the recording is over. Any strings matching ^{X} will be unescaped to ${X} and
+; all variables will be evaluated just prior to recording being started.
+;
+; The contents of MONITOR_FILENAME will also be unescaped from ^{X} to ${X} and
+; all variables will be evaluated just prior to recording being started.
+;
+;
+;
+;
 ;
 ;
-; yes - callers can join a queue with no members or only unavailable members
-; no - callers cannot join a queue with no members or only unavailable members
-; strict - callers cannot join a queue with no members
 ;
 ; joinempty = yes
 ;
 ;
 ; joinempty = yes
 ;
-; If you wish to remove callers from the queue when new callers cannot join, set this setting
-; to one of the same choices for 'joinempty'
+; If you wish to remove callers from the queue when new callers cannot join,
+; set this setting to one of the same choices for 'joinempty'
 ;
 ; leavewhenempty = yes
 ;
 ;
 ;
 ; leavewhenempty = yes
 ;
 ;
-; Asterisk can generate AgentCalled events when an agent is rung, if this is turned on
-; (may generate a LOT of extra manager events)
+; If this is set to yes, the following manager events will be generated:
+; AgentCalled, AgentDump, AgentConnect, AgentComplete; setting this to
+; vars also sends all channel variables with the event.
+; (may generate some extra manager events, but probably ones you want)
 ;
 ;
-; eventwhencalled = yes
+; eventwhencalled = yes|no|vars
 ;
 ;
-; If you wish to report the caller's hold time to the member before they are connected
-; to the caller, set this to yes.
+; If this is set to yes, the following manager events will be generated:
+; QueueMemberStatus
+; (may generate a WHOLE LOT of extra manager events)
+;
+; eventmemberstatus = no
+;
+; If you wish to report the caller's hold time to the member before they are
+; connected to the caller, set this to yes.
 ;
 ; reportholdtime = no
 ;
 ;
 ; reportholdtime = no
 ;
+; If you want the queue to avoid sending calls to members whose devices are
+; known to be 'in use' (via the channel driver supporting that device state)
+; uncomment this option. (Note: only the SIP channel driver currently is able
+; to report 'in use'.)
+;
+; ringinuse = no
 ;
 ;
-; If you wish to have a delay before the member is connected to the caller (or before the member
-; hears any announcement messages), set this to the number of seconds to delay.
+; If you wish to have a delay before the member is connected to the caller (or
+; before the member hears any announcement messages), set this to the number of
+; seconds to delay.
 ;
 ; memberdelay = 0
 ;
 ;
 ; memberdelay = 0
 ;
@@ -162,10 +297,14 @@ persistentmembers = yes
 ; Each member of this call queue is listed on a separate line in
 ; the form technology/dialstring.  "member" means a normal member of a
 ; queue.  An optional penalty may be specified after a comma, such that
 ; Each member of this call queue is listed on a separate line in
 ; the form technology/dialstring.  "member" means a normal member of a
 ; queue.  An optional penalty may be specified after a comma, such that
-; entries with higher penalties are considered last.
+; entries with higher penalties are considered last.  An optional member
+; name may also be specified after a second comma, which is used in log
+; messages as a "friendly name".  Multiple interfaces may share a single
+; member name.
 ;
 ;member => Zap/1
 ;
 ;member => Zap/1
-;member => Zap/2
+;member => Zap/2,10
+;member => Zap/3,10,Bob Johnson
 ;member => Agent/1001
 ;member => Agent/1002
 
 ;member => Agent/1001
 ;member => Agent/1002