Bug 6589 - option to display channel variables in queue events
[asterisk/asterisk.git] / configs / queues.conf.sample
1 [general]
2 ;
3 ; Global settings for call queues
4 ;
5 ; Persistent Members
6 ;    Store each dynamic agent in each queue in the astdb so that
7 ;    when asterisk is restarted, each agent will be automatically
8 ;    read into their recorded queues. Default is 'yes'.
9 ;
10 persistentmembers = yes
11
12 ; AutoFill Behavior
13 ;    The old/current behavior of the queue has a serial type behavior 
14 ;    in that the queue will make all waiting callers wait in the queue
15 ;    even if there is more than one available member ready to take
16 ;    calls until the head caller is connected with the member they 
17 ;    were trying to get to. The next waiting caller in line then
18 ;    becomes the head caller, and they are then connected with the
19 ;    next available member and all available members and waiting callers
20 ;    waits while this happens. The new behavior, enabled by setting
21 ;    autofill=yes makes sure that when the waiting callers are connecting
22 ;    with available members in a parallel fashion until there are
23 ;    no more available members or no more waiting callers. This is
24 ;    probably more along the lines of how a queue should work and 
25 ;    in most cases, you will want to enable this behavior. If you 
26 ;    do not specify or comment out this option, it will default to no
27 ;    to keep backward compatability with the old behavior.
28 ;
29 autofill = yes
30 ;
31 ; Monitor Type
32 ;    By setting monitor-type = MixMonitor, when specifying monitor-format
33 ;    to enable recording of queue member conversations, app_queue will
34 ;    now use the new MixMonitor application instead of Monitor so 
35 ;    the concept of "joining/mixing" the in/out files now goes away
36 ;    when this is enabled. You can set the default type for all queues
37 ;    here, and then also change monitor-type for individual queues within
38 ;    queue by using the same configuation parameter within a queue 
39 ;    configuration block. If you do not specify or comment out this option,
40 ;    it will default to the old 'Monitor' behavior to keep backward
41 ;    compatibility. 
42 ;
43 monitor-type = MixMonitor
44 ;
45 ; Note that a timeout to fail out of a queue may be passed as part of
46 ; an application call from extensions.conf:
47 ; Queue(queuename|[options]|[optionalurl]|[announceoverride]|[timeout])
48 ; example: Queue(dave|t|||45)
49
50 ;[markq]
51 ;
52 ; A sample call queue
53 ;
54 ; Musiconhold sets which music applies for this particular
55 ; call queue (configure classes in musiconhold.conf)
56 ;
57 ;musiconhold = default
58 ;
59 ; An announcement may be specified which is played for the member as
60 ; soon as they answer a call, typically to indicate to them which queue
61 ; this call should be answered as, so that agents or members who are
62 ; listening to more than one queue can differentiated how they should
63 ; engage the customer
64 ;
65 ;announce = queue-markq
66 ;
67 ; A strategy may be specified.  Valid strategies include:
68 ;
69 ; ringall - ring all available channels until one answers (default)
70 ; roundrobin - take turns ringing each available interface 
71 ; leastrecent - ring interface which was least recently called by this queue
72 ; fewestcalls - ring the one with fewest completed calls from this queue
73 ; random - ring random interface
74 ; rrmemory - round robin with memory, remember where we left off last ring pass
75 ;
76 ;strategy = ringall
77 ;
78 ; Second settings for service level (default 0)
79 ; Used for service level statistics (calls answered within service level time
80 ; frame)
81 ;servicelevel = 60
82 ;
83 ; A context may be specified, in which if the user types a SINGLE
84 ; digit extension while they are in the queue, they will be taken out
85 ; of the queue and sent to that extension in this context.
86 ;
87 ;context = qoutcon
88 ;
89 ; How long do we let the phone ring before we consider this a timeout...
90 ;
91 ;timeout = 15
92 ;
93 ; How long do we wait before trying all the members again?
94 ;
95 ;retry = 5
96 ;
97 ; Weight of queue - when compared to other queues, higher weights get 
98 ; first shot at available channels when the same channel is included in 
99 ; more than one queue.
100 ;
101 ;weight=0
102 ;
103 ; After a successful call, how long to wait before sending a potentially
104 ; free member another call (default is 0, or no delay)
105 ;
106 ;wrapuptime=15
107 ;
108 ; Autofill will follow queue strategy but push multiple calls through
109 ; at same time until there are no more waiting callers or no more
110 ; available members. The per-queue setting of autofill allows you
111 ; to override the default setting on an individual queue level.
112
113 ;autofill=yes
114 ;
115 ; Autopause will pause a queue member if they fail to answer a call
116 ;
117 ;autopause=yes
118 ;
119 ; Maximum number of people waiting in the queue (0 for unlimited)
120 ;
121 ;maxlen = 0
122 ;
123 ; If set to yes, just prior to the caller being bridged with a queue member 
124 ; the MEMBERINTERFACE variable will be set with the interface name (eg. Agent/1234)
125 ; of the queue member that was chosen and is now connected to be bridged with
126 ; the caller
127 ;
128 ;setinterfacevar=no
129 ;
130 ; How often to announce queue position and/or estimated 
131 ; holdtime to caller (0=off)
132 ;
133 ;announce-frequency = 90 
134 ;
135 ;
136 ; How often to make any periodic announcement (see periodic-announce)
137 ;
138 ;periodic-announce-frequency=60
139 ;
140 ; Should we include estimated hold time in position announcements?
141 ; Either yes, no, or only once.
142 ; Hold time will be announced as the estimated time, 
143 ; or "less than 2 minutes" when appropriate.
144 ;
145 ;announce-holdtime = yes|no|once
146
147 ;
148 ; What's the rounding time for the seconds?
149 ; If this is non-zero, then we announce the seconds as well as the minutes
150 ; rounded to this value.
151 ;
152 ; announce-round-seconds = 10
153 ;
154 ; Use these sound files in making position/holdtime announcements.  The
155 ; defaults are as listed below -- change only if you need to.
156 ;
157                         ;       ("You are now first in line.")
158 ;queue-youarenext = queue-youarenext            
159                         ;       ("There are")
160 ;queue-thereare = queue-thereare
161                         ;       ("calls waiting.")
162 ;queue-callswaiting = queue-callswaiting
163                         ;       ("The current est. holdtime is")
164 ;queue-holdtime = queue-holdtime
165                         ;       ("minutes.")
166 ;queue-minutes = queue-minutes
167                         ;       ("seconds.")
168 ;queue-seconds = queue-seconds
169                         ;       ("Thank you for your patience.")
170 ;queue-thankyou = queue-thankyou
171                         ;       ("less than")
172 ;queue-lessthan = queue-less-than
173                         ;       ("Hold time")
174 ;queue-reporthold = queue-reporthold
175                         ;       ("All reps busy / wait for next")
176 ;periodic-announce = queue-periodic-announce
177 ;
178 ; Calls may be recorded using Asterisk's monitor/MixMonitor resource
179 ; This can be enabled from within the Queue application, starting recording
180 ; when the call is actually picked up; thus, only successful calls are
181 ; recorded, and you are not recording while people are listening to MOH.
182 ; To enable monitoring, simply specify "monitor-format";  it will be disabled
183 ; otherwise.
184 ;
185 ; You can specify the monitor filename with by calling
186 ;    Set(MONITOR_FILENAME=foo)
187 ; Otherwise it will use MONITOR_FILENAME=${UNIQUEID}
188 ;
189 ; Pick any one valid extension for monitor format recording. If you leave
190 ; monitor-format commented out, it will not record calls.
191 ;
192 ; monitor-format = gsm|wav|wav49
193 ;
194 ; Monitor Type
195 ;    By setting monitor-type = MixMonitor, when specifying monitor-format
196 ;    to enable recording of queue member conversations, app_queue will
197 ;    now use the new MixMonitor application instead of Monitor so
198 ;    the concept of "joining/mixing" the in/out files now goes away
199 ;    when this is enabled. If you do not specify or comment out this option,
200 ;    it will default to the old 'Monitor' behavior to keep backward
201 ;    compatibility.
202 ;
203 ; monitor-type = MixMonitor
204 ;
205 ; ----------------------- TYPE MONITOR OPTIONS --------------------------------
206 ;
207 ; If you wish to have the two files joined together when the call ends, set this
208 ; to yes.
209 ;
210 ; monitor-join = yes
211 ;
212 ; This setting controls whether callers can join a queue with no members. There
213 ; are three choices:
214 ;
215 ; yes    - callers can join a queue with no members or only unavailable members
216 ; no     - callers cannot join a queue with no members
217 ; strict - callers cannot join a queue with no members or only unavailable
218 ;          members
219 ;
220 ; ----------------------- TYPE MIXMONITOR OPTIONS -----------------------------
221 ;
222 ;
223 ; You can specify the options supplied to MixMonitor by calling
224 ;   Set(MONITOR_OPTIONS=av(<x>)V(<x>)W(<x>))
225 ; The 'b' option for MixMonitor (only save audio to the file while bridged) is 
226 ; implied.
227 ;
228 ; You can specify a post recording command to be executed after the end of
229 ; recording by calling
230 ;   Set(MONITOR_EXEC=mv /var/spool/asterisk/monitor/^{MONITOR_FILENAME} /tmp/^{MONITOR_FILENAME})
231 ;
232 ; The command specified within the contents of MONITOR_EXEC will be executed when
233 ; the recording is over. Any strings matching ^{X} will be unescaped to ${X} and
234 ; all variables will be evaluated just prior to recording being started.
235 ;
236 ; The contents of MONITOR_FILENAME will also be unescaped from ^{X} to ${X} and
237 ; all variables will be evaluated just prior to recording being started.
238 ;
239 ;
240 ;
241 ;
242 ;
243 ;
244 ; joinempty = yes
245 ;
246 ; If you wish to remove callers from the queue when new callers cannot join,
247 ; set this setting to one of the same choices for 'joinempty'
248 ;
249 ; leavewhenempty = yes
250 ;
251 ;
252 ; If this is set to yes, the following manager events will be generated:
253 ; AgentCalled, AgentDump, AgentConnect, AgentComplete; setting this to
254 ; vars also sends all channel variables with the event.
255 ; (may generate some extra manager events, but probably ones you want)
256 ;
257 ; eventwhencalled = yes|no|vars
258 ;
259 ; If this is set to no, the following manager events will be generated:
260 ; QueueMemberStatus
261 ; (may generate a WHOLE LOT of extra manager events)
262 ;
263 ; eventmemberstatusoff = no
264 ;
265 ; If you wish to report the caller's hold time to the member before they are
266 ; connected to the caller, set this to yes.
267 ;
268 ; reportholdtime = no
269 ;
270 ; If you want the queue to avoid sending calls to members whose devices are
271 ; known to be 'in use' (via the channel driver supporting that device state)
272 ; uncomment this option. (Note: only the SIP channel driver currently is able
273 ; to report 'in use'.)
274 ;
275 ; ringinuse = no
276 ;
277 ; If you wish to have a delay before the member is connected to the caller (or
278 ; before the member hears any announcement messages), set this to the number of
279 ; seconds to delay.
280 ;
281 ; memberdelay = 0
282 ;
283 ; If timeoutrestart is set to yes, then the timeout for an agent to answer is
284 ; reset if a BUSY or CONGESTION is received.  This can be useful if agents
285 ; are able to cancel a call with reject or similar.
286 ;
287 ; timeoutrestart = no
288 ;
289 ; Each member of this call queue is listed on a separate line in
290 ; the form technology/dialstring.  "member" means a normal member of a
291 ; queue.  An optional penalty may be specified after a comma, such that
292 ; entries with higher penalties are considered last.
293 ;
294 ;member => Zap/1
295 ;member => Zap/2
296 ;member => Agent/1001
297 ;member => Agent/1002
298
299 ;
300 ; Note that using agent groups is probably not what you want.  Strategies do
301 ; not propagate down to the Agent system so if you want round robin, least
302 ; recent, etc, you should list all the agents in this file individually and not
303 ; use agent groups.
304 ;
305 ;member => Agent/@1             ; Any agent in group 1
306 ;member => Agent/:1,1           ; Any agent in group 1, wait for first
307                                 ; available, but consider with penalty
308