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