Allow for the position announcement to be turned off if desired.
[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 ;[markq]
64 ;
65 ; A sample call queue
66 ;
67 ; Musicclass sets which music applies for this particular call queue.
68 ; The only class which can override this one is if the MOH class is set
69 ; directly on the channel using Set(CHANNEL(musicclass)=whatever) in the
70 ; dialplan.
71 ;
72 ;musicclass = default
73 ;
74 ; An announcement may be specified which is played for the member as
75 ; soon as they answer a call, typically to indicate to them which queue
76 ; this call should be answered as, so that agents or members who are
77 ; listening to more than one queue can differentiated how they should
78 ; engage the customer
79 ;
80 ;announce = queue-markq
81 ;
82 ; A strategy may be specified.  Valid strategies include:
83 ;
84 ; ringall - ring all available channels until one answers (default)
85 ; roundrobin - take turns ringing each available interface 
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 ;
91 ;strategy = ringall
92 ;
93 ; Second settings for service level (default 0)
94 ; Used for service level statistics (calls answered within service level time
95 ; frame)
96 ;servicelevel = 60
97 ;
98 ; A context may be specified, in which if the user types a SINGLE
99 ; digit extension while they are in the queue, they will be taken out
100 ; of the queue and sent to that extension in this context.
101 ;
102 ;context = qoutcon
103 ;
104 ; How long do we let the phone ring before we consider this a timeout...
105 ;
106 ;timeout = 15
107 ;
108 ; How long do we wait before trying all the members again?
109 ;
110 ;retry = 5
111 ;
112 ; Weight of queue - when compared to other queues, higher weights get 
113 ; first shot at available channels when the same channel is included in 
114 ; more than one queue.
115 ;
116 ;weight=0
117 ;
118 ; After a successful call, how long to wait before sending a potentially
119 ; free member another call (default is 0, or no delay)
120 ;
121 ;wrapuptime=15
122 ;
123 ; Autofill will follow queue strategy but push multiple calls through
124 ; at same time until there are no more waiting callers or no more
125 ; available members. The per-queue setting of autofill allows you
126 ; to override the default setting on an individual queue level.
127
128 ;autofill=yes
129 ;
130 ; Autopause will pause a queue member if they fail to answer a call
131 ;
132 ;autopause=yes
133 ;
134 ; Maximum number of people waiting in the queue (0 for unlimited)
135 ;
136 ;maxlen = 0
137 ;
138 ; If set to yes, just prior to the caller being bridged with a queue member 
139 ; the following variables will be set
140 ; MEMBERINTERFACE is the interface name (eg. Agent/1234)
141 ; MEMBERNAME is the member name (eg. Joe Soap)
142 ; MEMBERCALLS is the number of calls that interface has taken, 
143 ; MEMBERLASTCALL is the last time the member took a call. 
144 ; MEMBERPENALTY is the penalty of the member 
145 ; MEMBERDYNAMIC indicates if a member is dynamic or not
146 ; MEMBERREALTIME indicates if a member is realtime or not
147 ;
148 ;setinterfacevar=no
149 ;
150 ; If set to yes, just prior to the caller being bridged with a queue member 
151 ; the following variables will be set:
152 ; QEHOLDTIME callers hold time 
153 ; QEORIGINALPOS original position of the caller in the queue
154 ;
155 ;setqueueentryvar=no
156 ;
157 ; If set to yes, the following variables will be set
158 ; just prior to the caller being bridged with a queue member
159 ; and just prior to the caller leaving the queue
160 ; QUEUEMAX maxmimum number of calls allowed
161 ; QUEUESTRATEGY the strategy of the queue; 
162 ; QUEUECALLS number of calls currently in the queue
163 ; QUEUEHOLDTIME current average hold time
164 ; QUEUECOMPLETED number of completed calls for the queue
165 ; QUEUEABANDONED number of abandoned calls
166 ; QUEUESRVLEVEL queue service level
167 ; QUEUESRVLEVELPERF current service level performance
168 ;
169 ;setqueuevar=no
170 ;
171 ; if set, run this macro when connected to the queue member
172 ; you can override this macro by setting the macro option on 
173 ; the queue application
174 ;
175 ; membermacro=somemacro
176
177 ; How often to announce queue position and/or estimated 
178 ; holdtime to caller (0=off)
179 ; Note that this value is ignored if the caller's queue
180 ; position has changed (see min-announce-frequency)
181 ;
182 ;announce-frequency = 90 
183 ;
184 ; The absolute minimum time between the start of each
185 ; queue position and/or estimated holdtime announcement
186 ; This is useful for avoiding constant announcements
187 ; when the caller's queue position is changing frequently
188 ; (see announce-frequency)
189 ;
190 ;min-announce-frequency = 15
191 ;
192 ; How often to make any periodic announcement (see periodic-announce)
193 ;
194 ;periodic-announce-frequency=60
195 ;
196 ; Should we include estimated hold time in position announcements?
197 ; Either yes, no, or only once.
198 ; Hold time will be announced as the estimated time, 
199 ; or "less than 2 minutes" when appropriate.
200 ;
201 ;announce-holdtime = yes|no|once
202 ;
203 ; Queue position announce?
204 ; Either yes or no. If turned off, only the holdtime will be announced (as
205 ; configured in announce-holdtime)
206 ;
207 ;announce-position = yes
208 ;
209 ; What's the rounding time for the seconds?
210 ; If this is non-zero, then we announce the seconds as well as the minutes
211 ; rounded to this value.
212 ; Valid values are 0, 1, 5, 10, 15, 20, and 30.
213 ;
214 ; announce-round-seconds = 10
215 ;
216 ; Use these sound files in making position/holdtime announcements.  The
217 ; defaults are as listed below -- change only if you need to.
218 ;
219                         ;       ("You are now first in line.")
220 ;queue-youarenext = queue-youarenext            
221                         ;       ("There are")
222 ;queue-thereare = queue-thereare
223                         ;       ("calls waiting.")
224 ;queue-callswaiting = queue-callswaiting
225                         ;       ("The current est. holdtime is")
226 ;queue-holdtime = queue-holdtime
227                         ;       ("minutes.")
228 ;queue-minutes = queue-minutes
229                         ;       ("seconds.")
230 ;queue-seconds = queue-seconds
231                         ;       ("Thank you for your patience.")
232 ;queue-thankyou = queue-thankyou
233                         ;       ("less than")
234 ;queue-lessthan = queue-less-than
235                         ;       ("Hold time")
236 ;queue-reporthold = queue-reporthold
237                         ;       ("All reps busy / wait for next")
238 ;periodic-announce = queue-periodic-announce
239 ;
240 ; Calls may be recorded using Asterisk's monitor/MixMonitor resource
241 ; This can be enabled from within the Queue application, starting recording
242 ; when the call is actually picked up; thus, only successful calls are
243 ; recorded, and you are not recording while people are listening to MOH.
244 ; To enable monitoring, simply specify "monitor-format";  it will be disabled
245 ; otherwise.
246 ;
247 ; You can specify the monitor filename with by calling
248 ;    Set(MONITOR_FILENAME=foo)
249 ; Otherwise it will use MONITOR_FILENAME=${UNIQUEID}
250 ;
251 ; Pick any one valid extension for monitor format recording. If you leave
252 ; monitor-format commented out, it will not record calls.
253 ;
254 ; monitor-format = gsm|wav|wav49
255 ;
256 ; Monitor Type
257 ;    By setting monitor-type = MixMonitor, when specifying monitor-format
258 ;    to enable recording of queue member conversations, app_queue will
259 ;    now use the new MixMonitor application instead of Monitor so
260 ;    the concept of "joining/mixing" the in/out files now goes away
261 ;    when this is enabled. If you do not specify or comment out this option,
262 ;    it will default to the old 'Monitor' behavior to keep backward
263 ;    compatibility.
264 ;
265 ; monitor-type = MixMonitor
266 ;
267 ; ----------------------- TYPE MONITOR OPTIONS --------------------------------
268 ;
269 ; If you wish to have the two files joined together when the call ends, set this
270 ; to yes.
271 ;
272 ; monitor-join = yes
273 ;
274 ; ----------------------- TYPE MIXMONITOR OPTIONS -----------------------------
275 ;
276 ;
277 ; You can specify the options supplied to MixMonitor by calling
278 ;   Set(MONITOR_OPTIONS=av(<x>)V(<x>)W(<x>))
279 ; The 'b' option for MixMonitor (only save audio to the file while bridged) is 
280 ; implied.
281 ;
282 ; You can specify a post recording command to be executed after the end of
283 ; recording by calling
284 ;   Set(MONITOR_EXEC=mv /var/spool/asterisk/monitor/^{MONITOR_FILENAME} /tmp/^{MONITOR_FILENAME})
285 ;
286 ; The command specified within the contents of MONITOR_EXEC will be executed when
287 ; the recording is over. Any strings matching ^{X} will be unescaped to ${X} and
288 ; all variables will be evaluated just prior to recording being started.
289 ;
290 ; The contents of MONITOR_FILENAME will also be unescaped from ^{X} to ${X} and
291 ; all variables will be evaluated just prior to recording being started.
292 ;
293 ;
294 ; This setting controls whether callers can join a queue with no members. There
295 ; are three choices:
296 ;
297 ; yes    - callers can join a queue with no members or only unavailable members
298 ; no     - callers cannot join a queue with no members
299 ; strict - callers cannot join a queue with no members or only unavailable
300 ;          members
301 ; loose  - same as strict, but paused queue members do not count as unavailable
302 ;
303 ; joinempty = yes
304 ;
305 ;
306 ; If you wish to remove callers from the queue when new callers cannot join,
307 ; set this setting to one of the same choices for 'joinempty'
308 ;
309 ; leavewhenempty = yes
310 ;
311 ;
312 ; If this is set to yes, the following manager events will be generated:
313 ; AgentCalled, AgentDump, AgentConnect, AgentComplete; setting this to
314 ; vars also sends all channel variables with the event.
315 ; (may generate some extra manager events, but probably ones you want)
316 ;
317 ; eventwhencalled = yes|no|vars
318 ;
319 ; If this is set to yes, the following manager events will be generated:
320 ; QueueMemberStatus
321 ; (may generate a WHOLE LOT of extra manager events)
322 ;
323 ; eventmemberstatus = no
324 ;
325 ; If you wish to report the caller's hold time to the member before they are
326 ; connected to the caller, set this to yes.
327 ;
328 ; reportholdtime = no
329 ;
330 ; If you want the queue to avoid sending calls to members whose devices are
331 ; known to be 'in use' (via the channel driver supporting that device state)
332 ; uncomment this option. (Note: only the SIP channel driver currently is able
333 ; to report 'in use'.)
334 ;
335 ; ringinuse = no
336 ;
337 ; If you wish to have a delay before the member is connected to the caller (or
338 ; before the member hears any announcement messages), set this to the number of
339 ; seconds to delay.
340 ;
341 ; memberdelay = 0
342 ;
343 ; If timeoutrestart is set to yes, then the timeout for an agent to answer is
344 ; reset if a BUSY or CONGESTION is received.  This can be useful if agents
345 ; are able to cancel a call with reject or similar.
346 ;
347 ; timeoutrestart = no
348 ;
349 ; Each member of this call queue is listed on a separate line in
350 ; the form technology/dialstring.  "member" means a normal member of a
351 ; queue.  An optional penalty may be specified after a comma, such that
352 ; entries with higher penalties are considered last.  An optional member
353 ; name may also be specified after a second comma, which is used in log
354 ; messages as a "friendly name".  Multiple interfaces may share a single
355 ; member name.
356 ;
357 ; It is important to ensure that channel drivers used for members are loaded
358 ; before app_queue.so itself or they may be marked invalid until reload. This
359 ; can be accomplished by explicitly listing them in modules.conf before app_queue.so
360 ;
361 ;member => Zap/1
362 ;member => Zap/2,10
363 ;member => Zap/3,10,Bob Johnson
364 ;member => Agent/1001
365 ;member => Agent/1002
366
367 ;
368 ; Note that using agent groups is probably not what you want.  Strategies do
369 ; not propagate down to the Agent system so if you want round robin, least
370 ; recent, etc, you should list all the agents in this file individually and not
371 ; use agent groups.
372 ;
373 ;member => Agent/@1             ; Any agent in group 1
374 ;member => Agent/:1,1           ; Any agent in group 1, wait for first
375                                 ; available, but consider with penalty
376