Remove 'keepstats' queue option from sample config, as it's no longer used.
[asterisk/asterisk.git] / configs / queues.conf.sample
1 [general]
2 ;
3 ; Global settings for call queues
4 ;
5 ; Persistent Members
6 ;    Store each dynamic member in each queue in the astdb so that
7 ;    when asterisk is restarted, each member 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 compatibility 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 configuration 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 ; UpdateCDR behavior.
46 ;    This option is implemented to mimic chan_agents behavior of populating
47 ;    CDR dstchannel field of a call with an agent name, which you can set
48 ;    at the login time with AddQueueMember membername parameter.
49 ;
50 ; updatecdr = no
51
52 ;
53 ; Note that a timeout to fail out of a queue may be passed as part of
54 ; an application call from extensions.conf:
55 ; Queue(queuename,[options],[optionalurl],[announceoverride],[timeout])
56 ; example: Queue(dave,t,,,45)
57
58 ; shared_lastcall will make the lastcall and calls received be the same in
59 ; members logged in more than one queue.
60 ; This is useful to make the queue respect the wrapuptime of another queue
61 ; for a shared member
62 ;
63 shared_lastcall=no
64 ;
65 ;[markq]
66 ;
67 ; A sample call queue
68 ;
69 ; Musicclass sets which music applies for this particular call queue.
70 ; The only class which can override this one is if the MOH class is set
71 ; directly on the channel using Set(CHANNEL(musicclass)=whatever) in the
72 ; dialplan.
73 ;
74 ;musicclass = default
75 ;
76 ; An announcement may be specified which is played for the member as
77 ; soon as they answer a call, typically to indicate to them which queue
78 ; this call should be answered as, so that agents or members who are
79 ; listening to more than one queue can differentiated how they should
80 ; engage the customer
81 ;
82 ;announce = queue-markq
83 ;
84 ; A strategy may be specified.  Valid strategies include:
85 ;
86 ; ringall - ring all available channels until one answers (default)
87 ; leastrecent - ring interface which was least recently called by this queue
88 ; fewestcalls - ring the one with fewest completed calls from this queue
89 ; random - ring random interface
90 ; rrmemory - round robin with memory, remember where we left off last ring pass
91 ; linear - rings interfaces in the order specified in this configuration file.
92 ;          If you use dynamic members, the members will be rung in the order in
93 ;          which they were added
94 ; wrandom - rings random interface, but uses the member's penalty as a weight
95 ;           when calculating their metric. So a member with penalty 0 will have
96 ;           a metric somewhere between 0 and 1000, and a member with penalty 1 will
97 ;                       have a metric between 0 and 2000, and a member with penalty 2 will have
98 ;           a metric between 0 and 3000. Please note, if using this strategy, the member
99 ;           penalty is not the same as when using other queue strategies. It is ONLY used
100 ;           as a weight for calculating metric.
101 ;
102 ;strategy = ringall
103 ;
104 ; Second settings for service level (default 0)
105 ; Used for service level statistics (calls answered within service level time
106 ; frame)
107 ;servicelevel = 60
108 ;
109 ; A context may be specified, in which if the user types a SINGLE
110 ; digit extension while they are in the queue, they will be taken out
111 ; of the queue and sent to that extension in this context.
112 ;
113 ;context = qoutcon
114 ;
115 ;----------------------QUEUE TIMING OPTIONS------------------------------------
116 ; A Queue has two different "timeout" values associated with it. One is the
117 ; timeout parameter configured in queues.conf. This timeout specifies the
118 ; amount of time to try ringing a member's phone before considering the
119 ; member to be unavailable. The other timeout value is the second argument
120 ; to the Queue() application. This timeout represents the absolute amount
121 ; of time to allow a caller to stay in the queue before the caller is
122 ; removed from the queue. In certain situations, these two timeout values
123 ; may clash. For instance, if the timeout in queues.conf is set to 5 seconds,
124 ; the retry value in queues.conf is set to 4, and the second argument to Queue()
125 ; is 10, then the following may occur:
126 ;
127 ; A caller places a call to a queue.
128 ; The queue selects a member and attempts to ring that member.
129 ; The member's phone is rung for 5 seconds and he does not answer.
130 ; The retry time of 4 seconds occurs.
131 ; The queue selects a second member to call.
132 ;
133 ; How long does that second member's phone ring? Does it ring for 5 seconds
134 ; since the timeout set in app_queue is 5 seconds? Does it ring for 1 second since
135 ; the caller has been in the queue for 9 seconds and is supposed to be removed after
136 ; being in the queue for 10 seconds? This is configurable with the timeoutpriority
137 ; option. By setting the timeoutpriority to "conf" then you are saying that you would
138 ; rather use the time specified in the configuration file even if it means having the
139 ; caller stay in the queue longer than the time specified in the application argument.
140 ; For the scenario described above, timeoutpriority=conf would result in the second
141 ; member's phone ringing for 5 seconds. By specifying "app" as the value for
142 ; timeoutpriority, you are saying that the timeout specified as the argument to the
143 ; Queue application is more important. In the scenario above, timeoutpriority=app
144 ; would result in the second member's phone ringing for 1 second.
145 ;
146 ; There are a few exceptions to the priority rules. For instance, if timeoutpriority=appp
147 ; and the configuration file timeout is set to 0, but the application argument timeout is
148 ; non-zero, then the timeoutpriority is ignored and the application argument is used as
149 ; the timeout. Furthermore, if no application argument timeout is specified, then the
150 ; timeoutpriority option is ignored and the configuration file timeout is always used
151 ; when calling queue members.
152 ;
153 ; In timeoutpriority=conf mode however timeout specified in config file will take higher
154 ; priority than timeout in application arguments, so if config file has timeout 0, each
155 ; queue member will be called indefineately and application timeout will be checked only
156 ; after this call attempt. This is useful for having queue members with custom timeouts
157 ; specified within Dial application of Local channel, and allows handling NO ANSWER which
158 ; would otherwise be interrupted by queue destroying child channel on timeout.
159 ;
160 ; The default value for timeoutpriority is "app" since this was how previous versions of
161 ; Asterisk behaved.
162 ;
163 ;timeout = 15
164 ;retry = 5
165 ;timeoutpriority = app|conf
166 ;
167 ;-----------------------END QUEUE TIMING OPTIONS---------------------------------
168 ; Weight of queue - when compared to other queues, higher weights get
169 ; first shot at available channels when the same channel is included in
170 ; more than one queue.
171 ;
172 ;weight=0
173 ;
174 ; After a successful call, how long to wait before sending a potentially
175 ; free member another call (default is 0, or no delay)
176 ;
177 ;wrapuptime=15
178 ;
179 ; Autofill will follow queue strategy but push multiple calls through
180 ; at same time until there are no more waiting callers or no more
181 ; available members. The per-queue setting of autofill allows you
182 ; to override the default setting on an individual queue level.
183 ;
184 ;autofill=yes
185 ;
186 ; Autopause will pause a queue member if they fail to answer a call
187 ;
188 ;autopause=yes
189 ;
190 ; Maximum number of people waiting in the queue (0 for unlimited)
191 ;
192 ;maxlen = 0
193 ;
194 ; If set to yes, just prior to the caller being bridged with a queue member
195 ; the following variables will be set
196 ; MEMBERINTERFACE is the interface name (eg. Agent/1234)
197 ; MEMBERNAME is the member name (eg. Joe Soap)
198 ; MEMBERCALLS is the number of calls that interface has taken,
199 ; MEMBERLASTCALL is the last time the member took a call.
200 ; MEMBERPENALTY is the penalty of the member
201 ; MEMBERDYNAMIC indicates if a member is dynamic or not
202 ; MEMBERREALTIME indicates if a member is realtime or not
203 ;
204 ;setinterfacevar=no
205 ;
206 ; If set to yes, just prior to the caller being bridged with a queue member
207 ; the following variables will be set:
208 ; QEHOLDTIME callers hold time
209 ; QEORIGINALPOS original position of the caller in the queue
210 ;
211 ;setqueueentryvar=no
212 ;
213 ; If set to yes, the following variables will be set
214 ; just prior to the caller being bridged with a queue member
215 ; and just prior to the caller leaving the queue
216 ; QUEUENAME name of the queue
217 ; QUEUEMAX maxmimum number of calls allowed
218 ; QUEUESTRATEGY the strategy of the queue;
219 ; QUEUECALLS number of calls currently in the queue
220 ; QUEUEHOLDTIME current average hold time
221 ; QUEUECOMPLETED number of completed calls for the queue
222 ; QUEUEABANDONED number of abandoned calls
223 ; QUEUESRVLEVEL queue service level
224 ; QUEUESRVLEVELPERF current service level performance
225 ;
226 ;setqueuevar=no
227 ;
228 ; if set, run this macro when connected to the queue member
229 ; you can override this macro by setting the macro option on
230 ; the queue application
231 ;
232 ; membermacro=somemacro
233
234 ; How often to announce queue position and/or estimated
235 ; holdtime to caller (0=off)
236 ; Note that this value is ignored if the caller's queue
237 ; position has changed (see min-announce-frequency)
238 ;
239 ;announce-frequency = 90
240 ;
241 ; The absolute minimum time between the start of each
242 ; queue position and/or estimated holdtime announcement
243 ; This is useful for avoiding constant announcements
244 ; when the caller's queue position is changing frequently
245 ; (see announce-frequency)
246 ;
247 ;min-announce-frequency = 15
248 ;
249 ; How often to make any periodic announcement (see periodic-announce)
250 ;
251 ;periodic-announce-frequency=60
252 ;
253 ; Should the periodic announcements be played in a random order? Default is no.
254 ;
255 ;random-periodic-announce=no
256 ;
257 ; Should we include estimated hold time in position announcements?
258 ; Either yes, no, or only once.
259 ; Hold time will be announced as the estimated time.
260 ;
261 ;announce-holdtime = yes|no|once
262 ;
263 ; Queue position announce?
264 ; Valid values are "yes," "no," "limit," or "more." If set to "no," then the caller's position will
265 ; never be announced. If "yes," then the caller's position in the queue will be announced
266 ; to the caller. If set to "more," then if the number of callers is more than the number
267 ; specified by the announce-position-limit option, then the caller will hear that there
268 ; are more than that many callers waiting (i.e. if a caller number 6 is in a queue with the
269 ; announce-position-limit set to 5, then that caller will hear that there are more than 5
270 ; callers waiting). If set to "limit," then only callers within the limit specified by announce-position-limit
271 ; will have their position announced.
272 ;
273 ;announce-position = yes
274 ;
275 ; If you have specified "limit" or "more" for the announce-position option, then the following
276 ; value is what is used to determine what announcement to play to waiting callers. If you have
277 ; set the announce-position option to anything else, then this will have no bearing on queue operation
278 ;
279 ;announce-position-limit = 5
280 ;
281 ; What's the rounding time for the seconds?
282 ; If this is non-zero, then we announce the seconds as well as the minutes
283 ; rounded to this value.
284 ; Valid values are 0, 5, 10, 15, 20, and 30.
285 ;
286 ; announce-round-seconds = 10
287 ;
288 ; Use these sound files in making position/holdtime announcements.  The
289 ; defaults are as listed below -- change only if you need to.
290 ;
291 ; Keep in mind that you may also prevent a sound from being played if you
292 ; explicitly set a sound to be an empty string. For example, if you want to
293 ; prevent the queue from playing queue-thankyou, you may set the sound using
294 ; the following line:
295 ;
296 ; queue-thankyou=
297 ;
298                         ;       ("You are now first in line.")
299 ;queue-youarenext = queue-youarenext
300                         ;       ("There are")
301 ;queue-thereare = queue-thereare
302                         ;       ("calls waiting.")
303 ;queue-callswaiting = queue-callswaiting
304                         ;       ("The current est. holdtime is")
305 ;queue-holdtime = queue-holdtime
306                         ;       ("minutes.")
307 ;queue-minutes = queue-minutes
308                         ;       ("seconds.")
309 ;queue-seconds = queue-seconds
310                         ;       ("Thank you for your patience.")
311 ;queue-thankyou = queue-thankyou
312                         ;       ("Hold time")
313 ;queue-reporthold = queue-reporthold
314                         ;       ("All reps busy / wait for next")
315 ;periodic-announce = queue-periodic-announce
316 ;
317 ; A set of periodic announcements can be defined by separating
318 ; periodic announcements to reproduce by commas. For example:
319 ;periodic-announce = queue-periodic-announce,your-call-is-important,please-wait
320 ;
321 ; The announcements will be played in the order in which they are defined. After
322 ; playing the last announcement, the announcements begin again from the beginning.
323 ;
324 ; Calls may be recorded using Asterisk's monitor/MixMonitor resource
325 ; This can be enabled from within the Queue application, starting recording
326 ; when the call is actually picked up; thus, only successful calls are
327 ; recorded, and you are not recording while people are listening to MOH.
328 ; To enable monitoring, simply specify "monitor-format";  it will be disabled
329 ; otherwise.
330 ;
331 ; You can specify the monitor filename with by calling
332 ;    Set(MONITOR_FILENAME=foo)
333 ; Otherwise it will use MONITOR_FILENAME=${UNIQUEID}
334 ;
335 ; Pick any one valid extension for monitor format recording. If you leave
336 ; monitor-format commented out, it will not record calls.
337 ;
338 ; monitor-format = gsm|wav|wav49
339 ;
340 ; Monitor Type
341 ;    By setting monitor-type = MixMonitor, when specifying monitor-format
342 ;    to enable recording of queue member conversations, app_queue will
343 ;    now use the new MixMonitor application instead of Monitor so
344 ;    the concept of "joining/mixing" the in/out files now goes away
345 ;    when this is enabled. If you do not specify or comment out this option,
346 ;    it will default to the old 'Monitor' behavior to keep backward
347 ;    compatibility.
348 ;
349 ; monitor-type = MixMonitor
350 ;
351 ; ----------------------- TYPE MIXMONITOR OPTIONS -----------------------------
352 ;
353 ;
354 ; You can specify the options supplied to MixMonitor by calling (from the dialplan)
355 ;   Set(MONITOR_OPTIONS=av(<x>)V(<x>)W(<x>))
356 ; The 'b' option for MixMonitor (only save audio to the file while bridged) is
357 ; implied.
358 ;
359 ; You can specify a post recording command to be executed after the end of
360 ; recording by calling (from the dialplan)
361 ;   Set(MONITOR_EXEC=mv /var/spool/asterisk/monitor/^{MONITOR_FILENAME} /tmp/^{MONITOR_FILENAME})
362 ;
363 ; The command specified within the contents of MONITOR_EXEC will be executed when
364 ; the recording is over. Any strings matching ^{X} will be unescaped to ${X} and
365 ; all variables will be evaluated just prior to recording being started.
366 ;
367 ; The contents of MONITOR_FILENAME will also be unescaped from ^{X} to ${X} and
368 ; all variables will be evaluated just prior to recording being started.
369 ;
370 ; ---------------------- Queue Empty Options ----------------------------------
371 ;
372 ; Asterisk has provided the "joinempty" and "leavewhenempty" options for a while
373 ; with tenuous definitions of what they actually mean. The "joinempty" option controls
374 ; whether a caller may join a queue depending on several factors of member availability.
375 ; Similarly, then leavewhenempty option controls whether a caller may remain in a queue
376 ; he has already joined. Both options take a comma-separated list of factors which
377 ; contribute towards whether a caller may join/remain in the queue. The list of
378 ; factors which contribute to these option is as follows:
379 ;
380 ; paused: a member is not considered available if he is paused
381 ; penalty: a member is not considered available if his penalty is less than QUEUE_MAX_PENALTY
382 ; inuse: a member is not considered available if he is currently on a call
383 ; ringing: a member is not considered available if his phone is currently ringing
384 ; unavailable: This applies mainly to Agent channels. If the agent is a member of the queue
385 ;              but has not logged in, then do not consider the member to be available
386 ; invalid: Do not consider a member to be available if he has an "invalid" device state.
387 ;          This generally is caused by an error condition in the member's channel driver.
388 ; unknown: Do not consider a member to be available if we are unable to determine the member's
389 ;          current device state.
390 ; wrapup: A member is not considered available if he is currently in his wrapuptime after
391 ;         taking a call.
392 ;
393 ; For the "joinempty" option, when a caller attempts to enter a queue, the members of that
394 ; queue are examined. If all members are deemed to be unavailable due to any of the conditions
395 ; listed for the "joinempty" option, then the caller will be unable to enter the queue. For the
396 ; "leavewhenempty" option, the state of the members of the queue are checked periodically during
397 ; the caller's stay in the queue. If all of the members are unavailable due to any of the above
398 ; conditions, then the caller will be removed from the queue.
399 ;
400 ; Some examples:
401 ;
402 ;joinempty = paused,inuse,invalid
403 ;
404 ; A caller will not be able to enter a queue if at least one member cannot be found
405 ; who is not paused, on the phone, or who has an invalid device state.
406 ;
407 ;leavewhenempty = inuse,ringing
408 ;
409 ; A caller will be removed from the queue if at least one member cannot be found
410 ; who is not on the phone, or whose phone is not ringing.
411 ;
412 ; For the sake of backwards-compatibility, the joinempty and leavewhenempty
413 ; options also accept the strings "yes" "no" "strict" and "loose". The following
414 ; serves as a translation for these values:
415 ;
416 ; yes - (empty) for joinempty; penalty,paused,invalid for leavewhenempty
417 ; no - penalty,paused,invalid for joinempty; (empty) for leavewhenempty
418 ; strict - penalty,paused,invalid,unavailable
419 ; loose - penalty,invalid
420 ;
421
422 ; If this is set to yes, the following manager events will be generated:
423 ; AgentCalled, AgentDump, AgentConnect, AgentComplete; setting this to
424 ; vars also sends all channel variables with the event.
425 ; (may generate some extra manager events, but probably ones you want)
426 ;
427 ; eventwhencalled = yes|no|vars
428 ;
429 ; If this is set to yes, the following manager events will be generated:
430 ; QueueMemberStatus
431 ; (may generate a WHOLE LOT of extra manager events)
432 ;
433 ; eventmemberstatus = no
434 ;
435 ; If you wish to report the caller's hold time to the member before they are
436 ; connected to the caller, set this to yes.
437 ;
438 ; reportholdtime = no
439 ;
440 ; If you want the queue to avoid sending calls to members whose devices are
441 ; known to be 'in use' (via the channel driver supporting that device state)
442 ; uncomment this option. (Note: only the SIP channel driver currently is able
443 ; to report 'in use'.)
444 ;
445 ; ringinuse = no
446 ;
447 ; If you wish to have a delay before the member is connected to the caller (or
448 ; before the member hears any announcement messages), set this to the number of
449 ; seconds to delay.
450 ;
451 ; memberdelay = 0
452 ;
453 ; If timeoutrestart is set to yes, then the timeout for an agent to answer is
454 ; reset if a BUSY or CONGESTION is received.  This can be useful if agents
455 ; are able to cancel a call with reject or similar.
456 ;
457 ; timeoutrestart = no
458 ;
459 ; If you wish to implement a rule defined in queuerules.conf (see
460 ; configs/queuerules.conf.sample from the asterisk source directory for
461 ; more information about penalty rules) by default, you may specify this
462 ; by setting defaultrule to the rule's name
463 ;
464 ; defaultrule = myrule
465 ;
466 ; Each member of this call queue is listed on a separate line in
467 ; the form technology/dialstring.  "member" means a normal member of a
468 ; queue.  An optional penalty may be specified after a comma, such that
469 ; entries with higher penalties are considered last.  An optional member
470 ; name may also be specified after a second comma, which is used in log
471 ; messages as a "friendly name".  Multiple interfaces may share a single
472 ; member name. An optional state interface may be specified after a third
473 ; comma. This interface will be the one for which app_queue receives device
474 ; state notifications, even though the first interface specified is the one
475 ; that is actually called.
476 ;
477 ; It is important to ensure that channel drivers used for members are loaded
478 ; before app_queue.so itself or they may be marked invalid until reload. This
479 ; can be accomplished by explicitly listing them in modules.conf before
480 ; app_queue.so.  Additionally, if you use Local channels as queue members, you
481 ; must also preload pbx_config.so and chan_local.so (or pbx_ael.so, pbx_lua.so,
482 ; or pbx_realtime.so, depending on how your dialplan is configured).
483 ;
484 ;member => DAHDI/1
485 ;member => DAHDI/2,10
486 ;member => DAHDI/3,10,Bob Johnson
487 ;member => Agent/1001
488 ;member => Agent/1002
489 ;member => Local/1000@default,0,John Smith,SIP/1000
490
491 ;
492 ; Note that using agent groups is probably not what you want.  Strategies do
493 ; not propagate down to the Agent system so if you want round robin, least
494 ; recent, etc, you should list all the agents in this file individually and not
495 ; use agent groups.
496 ;
497 ;member => Agent/@1             ; Any agent in group 1
498 ;member => Agent/:1,1           ; Any agent in group 1, wait for first
499                                 ; available, but consider with penalty
500