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