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