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