Fix autofill behavior in app_queue and document it's functionality in queues.conf...
[asterisk/asterisk.git] / configs / queues.conf.sample
1 [general]
2 ;
3 ; Global settings for call queues
4 ;
5 ; Persistent Members
6 ;    Store each dynamic agent in each queue in the astdb so that
7 ;    when asterisk is restarted, each agent will be automatically
8 ;    read into their recorded queues. Default is 'yes'.
9 ;
10 persistentmembers = yes
11
12 ; AutoFill Behavior
13 ;    The old/current behavior of the queue has 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 no
27 ;    to keep backward compatability with the old behavior.
28 ;
29 autofill = yes
30 ;
31 ; Note that a timeout to fail out of a queue may be passed as part of
32 ; an application call from extensions.conf:
33 ; Queue(queuename|[options]|[optionalurl]|[announceoverride]|[timeout])
34 ; example: Queue(dave|t|||45)
35
36 ;[markq]
37 ;
38 ; A sample call queue
39 ;
40 ; Musiconhold sets which music applies for this particular
41 ; call queue (configure classes in musiconhold.conf)
42 ;
43 ;musiconhold = default
44 ;
45 ; An announcement may be specified which is played for the member as
46 ; soon as they answer a call, typically to indicate to them which queue
47 ; this call should be answered as, so that agents or members who are
48 ; listening to more than one queue can differentiated how they should
49 ; engage the customer
50 ;
51 ;announce = queue-markq
52 ;
53 ; A strategy may be specified.  Valid strategies include:
54 ;
55 ; ringall - ring all available channels until one answers (default)
56 ; roundrobin - take turns ringing each available interface 
57 ; leastrecent - ring interface which was least recently called by this queue
58 ; fewestcalls - ring the one with fewest completed calls from this queue
59 ; random - ring random interface
60 ; rrmemory - round robin with memory, remember where we left off last ring pass
61 ;
62 ;strategy = ringall
63 ;
64 ; Second settings for service level (default 0)
65 ; Used for service level statistics (calls answered within service level time
66 ; frame)
67 ;servicelevel = 60
68 ;
69 ; A context may be specified, in which if the user types a SINGLE
70 ; digit extension while they are in the queue, they will be taken out
71 ; of the queue and sent to that extension in this context.
72 ;
73 ;context = qoutcon
74 ;
75 ; How long do we let the phone ring before we consider this a timeout...
76 ;
77 ;timeout = 15
78 ;
79 ; How long do we wait before trying all the members again?
80 ;
81 ;retry = 5
82 ;
83 ; Weight of queue - when compared to other queues, higher weights get 
84 ; first shot at available channels when the same channel is included in 
85 ; more than one queue.
86 ;
87 ;weight=0
88 ;
89 ; After a successful call, how long to wait before sending a potentially
90 ; free member another call (default is 0, or no delay)
91 ;
92 ;wrapuptime=15
93 ;
94 ; Autofill will follow queue strategy but push multiple calls through
95 ; at same time until there are no more waiting callers or no more
96 ; available members. The per-queue setting of autofill allows you
97 ; to override the default setting on an individual queue level.
98
99 ;autofill=yes
100 ;
101 ; Autopause will pause a queue member if the y fail to answer a call
102 ;
103 ;autopause=yes
104 ;
105 ; Maximum number of people waiting in the queue (0 for unlimited)
106 ;
107 ;maxlen = 0
108 ;
109 ;
110 ; How often to announce queue position and/or estimated 
111 ; holdtime to caller (0=off)
112 ;
113 ;announce-frequency = 90 
114 ;
115 ;
116 ; How often to make any periodic announcement (see periodic-announce)
117 ;
118 ;periodic-announce-frequency=60
119 ;
120 ; Should we include estimated hold time in position announcements?
121 ; Either yes, no, or only once.
122 ; Hold time will be announced as the estimated time, 
123 ; or "less than 2 minutes" when appropriate.
124 ;
125 ;announce-holdtime = yes|no|once
126
127 ;
128 ; What's the rounding time for the seconds?
129 ; If this is non-zero, then we announce the seconds as well as the minutes
130 ; rounded to this value.
131 ;
132 ; announce-round-seconds = 10
133 ;
134 ; Use these sound files in making position/holdtime announcements.  The
135 ; defaults are as listed below -- change only if you need to.
136 ;
137                         ;       ("You are now first in line.")
138 ;queue-youarenext = queue-youarenext            
139                         ;       ("There are")
140 ;queue-thereare = queue-thereare
141                         ;       ("calls waiting.")
142 ;queue-callswaiting = queue-callswaiting
143                         ;       ("The current est. holdtime is")
144 ;queue-holdtime = queue-holdtime
145                         ;       ("minutes.")
146 ;queue-minutes = queue-minutes
147                         ;       ("seconds.")
148 ;queue-seconds = queue-seconds
149                         ;       ("Thank you for your patience.")
150 ;queue-thankyou = queue-thankyou
151                         ;       ("less than")
152 ;queue-lessthan = queue-less-than
153                         ;       ("Hold time")
154 ;queue-reporthold = queue-reporthold
155                         ;       ("All reps busy / wait for next")
156 ;periodic-announce = queue-periodic-announce
157 ;
158 ; Calls may be recorded using Asterisk's monitor resource
159 ; This can be enabled from within the Queue application, starting recording
160 ; when the call is actually picked up; thus, only successful calls are
161 ; recorded, and you are not recording while people are listening to MOH.
162 ; To enable monitoring, simply specify "monitor-format";  it will be disabled
163 ; otherwise.
164 ;
165 ; You can specify the monitor filename with by calling
166 ;    Set(MONITOR_FILENAME=foo)
167 ; Otherwise it will use MONITOR_FILENAME=${UNIQUEID}
168 ;
169 ; monitor-format = gsm|wav|wav49
170 ;
171 ; If you wish to have the two files joined together when the call ends, set this
172 ; to yes.
173 ;
174 ; monitor-join = yes
175 ;
176 ; This setting controls whether callers can join a queue with no members. There
177 ; are three choices:
178 ;
179 ; yes    - callers can join a queue with no members or only unavailable members
180 ; no     - callers cannot join a queue with no members
181 ; strict - callers cannot join a queue with no members or only unavailable
182 ;          members
183 ;
184 ; joinempty = yes
185 ;
186 ; If you wish to remove callers from the queue when new callers cannot join,
187 ; set this setting to one of the same choices for 'joinempty'
188 ;
189 ; leavewhenempty = yes
190 ;
191 ;
192 ; If this is set to yes, the following manager events will be generated:
193 ; AgentCalled, AgentDump, AgentConnect, AgentComplete
194 ; (may generate some extra manager events, but probably ones you want)
195 ;
196 ; eventwhencalled = yes
197 ;
198 ; If this is set to no, the following manager events will be generated:
199 ; QueueMemberStatus
200 ; (may generate a WHOLE LOT of extra manager events)
201 ;
202 ; eventmemberstatusoff = no
203 ;
204 ; If you wish to report the caller's hold time to the member before they are
205 ; connected to the caller, set this to yes.
206 ;
207 ; reportholdtime = no
208 ;
209 ; If you want the queue to avoid sending calls to members whose devices are
210 ; known to be 'in use' (via the channel driver supporting that device state)
211 ; uncomment this option. (Note: only the SIP channel driver currently is able
212 ; to report 'in use'.)
213 ;
214 ; ringinuse = no
215 ;
216 ; If you wish to have a delay before the member is connected to the caller (or
217 ; before the member hears any announcement messages), set this to the number of
218 ; seconds to delay.
219 ;
220 ; memberdelay = 0
221 ;
222 ; If timeoutrestart is set to yes, then the timeout for an agent to answer is
223 ; reset if a BUSY or CONGESTION is received.  This can be useful if agents
224 ; are able to cancel a call with reject or similar.
225 ;
226 ; timeoutrestart = no
227 ;
228 ; Each member of this call queue is listed on a separate line in
229 ; the form technology/dialstring.  "member" means a normal member of a
230 ; queue.  An optional penalty may be specified after a comma, such that
231 ; entries with higher penalties are considered last.
232 ;
233 ;member => Zap/1
234 ;member => Zap/2
235 ;member => Agent/1001
236 ;member => Agent/1002
237
238 ;
239 ; Note that using agent groups is probably not what you want.  Strategies do
240 ; not propagate down to the Agent system so if you want round robin, least
241 ; recent, etc, you should list all the agents in this file individually and not
242 ; use agent groups.
243 ;
244 ;member => Agent/@1             ; Any agent in group 1
245 ;member => Agent/:1,1           ; Any agent in group 1, wait for first
246                                 ; available, but consider with penalty
247