Expand setinterfacevar option to also set a variable, MEMBERNAME, which contains...
[asterisk/asterisk.git] / configs / queues.conf.sample
index f1cdeba..85064ae 100644 (file)
@@ -3,11 +3,16 @@
 ; 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
+;    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
+;
+; 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 
@@ -24,10 +29,24 @@ persistentmembers = yes
 ;    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 compatability with the old behavior.
+;    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])
@@ -37,10 +56,12 @@ autofill = yes
 ;
 ; 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
@@ -108,6 +129,7 @@ autofill = yes
 ;
 ; 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
 ;
@@ -161,7 +183,7 @@ autofill = yes
                        ;       ("All reps busy / wait for next")
 ;periodic-announce = queue-periodic-announce
 ;
-; Calls may be recorded using Asterisk's monitor resource
+; 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.
@@ -172,8 +194,24 @@ autofill = yes
 ;    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 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.
 ;
@@ -187,6 +225,30 @@ autofill = yes
 ; 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.
+;
+;
+;
+;
+;
+;
 ; joinempty = yes
 ;
 ; If you wish to remove callers from the queue when new callers cannot join,
@@ -196,16 +258,17 @@ autofill = yes
 ;
 ;
 ; If this is set to yes, the following manager events will be generated:
-; AgentCalled, AgentDump, AgentConnect, AgentComplete
+; 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 this is set to no, the following manager events will be generated:
+; If this is set to yes, the following manager events will be generated:
 ; QueueMemberStatus
 ; (may generate a WHOLE LOT of extra manager events)
 ;
-; eventmemberstatusoff = no
+; 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.
@@ -234,10 +297,14 @@ autofill = 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
-; 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/2
+;member => Zap/2,10
+;member => Zap/3,10,Bob Johnson
 ;member => Agent/1001
 ;member => Agent/1002