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