queues.conf.sample 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473
  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. ; Note that a timeout to fail out of a queue may be passed as part of
  58. ; an application call from extensions.conf:
  59. ; Queue(queuename,[options],[optionalurl],[announceoverride],[timeout])
  60. ; example: Queue(dave,t,,,45)
  61. ; shared_lastcall will make the lastcall and calls received be the same in
  62. ; members logged in more than one queue.
  63. ; This is useful to make the queue respect the wrapuptime of another queue
  64. ; for a shared member
  65. ;
  66. shared_lastcall=no
  67. ;
  68. ;[markq]
  69. ;
  70. ; A sample call queue
  71. ;
  72. ; Musicclass sets which music applies for this particular call queue.
  73. ; The only class which can override this one is if the MOH class is set
  74. ; directly on the channel using Set(CHANNEL(musicclass)=whatever) in the
  75. ; dialplan.
  76. ;
  77. ;musicclass = default
  78. ;
  79. ; An announcement may be specified which is played for the member as
  80. ; soon as they answer a call, typically to indicate to them which queue
  81. ; this call should be answered as, so that agents or members who are
  82. ; listening to more than one queue can differentiated how they should
  83. ; engage the customer
  84. ;
  85. ;announce = queue-markq
  86. ;
  87. ; A strategy may be specified. Valid strategies include:
  88. ;
  89. ; ringall - ring all available channels until one answers (default)
  90. ; leastrecent - ring interface which was least recently called by this queue
  91. ; fewestcalls - ring the one with fewest completed calls from this queue
  92. ; random - ring random interface
  93. ; rrmemory - round robin with memory, remember where we left off last ring pass
  94. ; linear - rings interfaces in the order specified in this configuration file.
  95. ; If you use dynamic members, the members will be rung in the order in
  96. ; which they were added
  97. ; wrandom - rings random interface, but uses the member's penalty as a weight
  98. ; when calculating their metric. So a member with penalty 0 will have
  99. ; a metric somewhere between 0 and 1000, and a member with penalty 1 will
  100. ; have a metric between 0 and 2000, and a member with penalty 2 will have
  101. ; a metric between 0 and 3000. Please note, if using this strategy, the member
  102. ; penalty is not the same as when using other queue strategies. It is ONLY used
  103. ; as a weight for calculating metric.
  104. ;
  105. ;strategy = ringall
  106. ;
  107. ; Second settings for service level (default 0)
  108. ; Used for service level statistics (calls answered within service level time
  109. ; frame)
  110. ;servicelevel = 60
  111. ;
  112. ; A context may be specified, in which if the user types a SINGLE
  113. ; digit extension while they are in the queue, they will be taken out
  114. ; of the queue and sent to that extension in this context.
  115. ;
  116. ;context = qoutcon
  117. ;
  118. ;----------------------QUEUE TIMING OPTIONS------------------------------------
  119. ; A Queue has two different "timeout" values associated with it. One is the
  120. ; timeout parameter configured in queues.conf. This timeout specifies the
  121. ; amount of time to try ringing a member's phone before considering the
  122. ; member to be unavailable. The other timeout value is the second argument
  123. ; to the Queue() application. This timeout represents the absolute amount
  124. ; of time to allow a caller to stay in the queue before the caller is
  125. ; removed from the queue. In certain situations, these two timeout values
  126. ; may clash. For instance, if the timeout in queues.conf is set to 5 seconds,
  127. ; the retry value in queues.conf is set to 4, and the second argument to Queue()
  128. ; is 10, then the following may occur:
  129. ;
  130. ; A caller places a call to a queue.
  131. ; The queue selects a member and attempts to ring that member.
  132. ; The member's phone is rung for 5 seconds and he does not answer.
  133. ; The retry time of 4 seconds occurs.
  134. ; The queue selects a second member to call.
  135. ;
  136. ; How long does that second member's phone ring? Does it ring for 5 seconds
  137. ; since the timeout set in app_queue is 5 seconds? Does it ring for 1 second since
  138. ; the caller has been in the queue for 9 seconds and is supposed to be removed after
  139. ; being in the queue for 10 seconds? This is configurable with the timeoutpriority
  140. ; option. By setting the timeoutpriority to "conf" then you are saying that you would
  141. ; rather use the time specified in the configuration file even if it means having the
  142. ; caller stay in the queue longer than the time specified in the application argument.
  143. ; For the scenario described above, timeoutpriority=conf would result in the second
  144. ; member's phone ringing for 5 seconds. By specifying "app" as the value for
  145. ; timeoutpriority, you are saying that the timeout specified as the argument to the
  146. ; Queue application is more important. In the scenario above, timeoutpriority=app
  147. ; would result in the second member's phone ringing for 1 second.
  148. ;
  149. ; There are a few exceptions to the priority rules. For instance, if timeoutpriority=appp
  150. ; and the configuration file timeout is set to 0, but the application argument timeout is
  151. ; non-zero, then the timeoutpriority is ignored and the application argument is used as
  152. ; the timeout. Furthermore, if no application argument timeout is specified, then the
  153. ; timeoutpriority option is ignored and the configuration file timeout is always used
  154. ; when calling queue members.
  155. ;
  156. ; In timeoutpriority=conf mode however timeout specified in config file will take higher
  157. ; priority than timeout in application arguments, so if config file has timeout 0, each
  158. ; queue member will be called indefineately and application timeout will be checked only
  159. ; after this call attempt. This is useful for having queue members with custom timeouts
  160. ; specified within Dial application of Local channel, and allows handling NO ANSWER which
  161. ; would otherwise be interrupted by queue destroying child channel on timeout.
  162. ;
  163. ; The default value for timeoutpriority is "app" since this was how previous versions of
  164. ; Asterisk behaved.
  165. ;
  166. ;timeout = 15
  167. ;retry = 5
  168. ;timeoutpriority = app|conf
  169. ;
  170. ;-----------------------END QUEUE TIMING OPTIONS---------------------------------
  171. ; Weight of queue - when compared to other queues, higher weights get
  172. ; first shot at available channels when the same channel is included in
  173. ; more than one queue.
  174. ;
  175. ;weight=0
  176. ;
  177. ; After a successful call, how long to wait before sending a potentially
  178. ; free member another call (default is 0, or no delay)
  179. ;
  180. ;wrapuptime=15
  181. ;
  182. ; Autofill will follow queue strategy but push multiple calls through
  183. ; at same time until there are no more waiting callers or no more
  184. ; available members. The per-queue setting of autofill allows you
  185. ; to override the default setting on an individual queue level.
  186. ;
  187. ;autofill=yes
  188. ;
  189. ; Autopause will pause a queue member if they fail to answer a call
  190. ;
  191. ;autopause=yes
  192. ;
  193. ; Maximum number of people waiting in the queue (0 for unlimited)
  194. ;
  195. ;maxlen = 0
  196. ;
  197. ; If set to yes, just prior to the caller being bridged with a queue member
  198. ; the following variables will be set
  199. ; MEMBERINTERFACE is the interface name (eg. Agent/1234)
  200. ; MEMBERNAME is the member name (eg. Joe Soap)
  201. ; MEMBERCALLS is the number of calls that interface has taken,
  202. ; MEMBERLASTCALL is the last time the member took a call.
  203. ; MEMBERPENALTY is the penalty of the member
  204. ; MEMBERDYNAMIC indicates if a member is dynamic or not
  205. ; MEMBERREALTIME indicates if a member is realtime or not
  206. ;
  207. ;setinterfacevar=no
  208. ;
  209. ; If set to yes, just prior to the caller being bridged with a queue member
  210. ; the following variables will be set:
  211. ; QEHOLDTIME callers hold time
  212. ; QEORIGINALPOS original position of the caller in the queue
  213. ;
  214. ;setqueueentryvar=no
  215. ;
  216. ; If set to yes, the following variables will be set
  217. ; just prior to the caller being bridged with a queue member
  218. ; and just prior to the caller leaving the queue
  219. ; QUEUENAME name of the queue
  220. ; QUEUEMAX maxmimum number of calls allowed
  221. ; QUEUESTRATEGY the strategy of the queue;
  222. ; QUEUECALLS number of calls currently in the queue
  223. ; QUEUEHOLDTIME current average hold time
  224. ; QUEUECOMPLETED number of completed calls for the queue
  225. ; QUEUEABANDONED number of abandoned calls
  226. ; QUEUESRVLEVEL queue service level
  227. ; QUEUESRVLEVELPERF current service level performance
  228. ;
  229. ;setqueuevar=no
  230. ;
  231. ; if set, run this macro when connected to the queue member
  232. ; you can override this macro by setting the macro option on
  233. ; the queue application
  234. ;
  235. ; membermacro=somemacro
  236. ; How often to announce queue position and/or estimated
  237. ; holdtime to caller (0=off)
  238. ; Note that this value is ignored if the caller's queue
  239. ; position has changed (see min-announce-frequency)
  240. ;
  241. ;announce-frequency = 90
  242. ;
  243. ; The absolute minimum time between the start of each
  244. ; queue position and/or estimated holdtime announcement
  245. ; This is useful for avoiding constant announcements
  246. ; when the caller's queue position is changing frequently
  247. ; (see announce-frequency)
  248. ;
  249. ;min-announce-frequency = 15
  250. ;
  251. ; How often to make any periodic announcement (see periodic-announce)
  252. ;
  253. ;periodic-announce-frequency=60
  254. ;
  255. ; Should the periodic announcements be played in a random order? Default is no.
  256. ;
  257. ;random-periodic-announce=no
  258. ;
  259. ; Should we include estimated hold time in position announcements?
  260. ; Either yes, no, or only once.
  261. ; Hold time will be announced as the estimated time.
  262. ;
  263. ;announce-holdtime = yes|no|once
  264. ;
  265. ; Queue position announce?
  266. ; Valid values are "yes," "no," "limit," or "more." If set to "no," then the caller's position will
  267. ; never be announced. If "yes," then the caller's position in the queue will be announced
  268. ; to the caller. If set to "more," then if the number of callers is more than the number
  269. ; specified by the announce-position-limit option, then the caller will hear that there
  270. ; are more than that many callers waiting (i.e. if a caller number 6 is in a queue with the
  271. ; announce-position-limit set to 5, then that caller will hear that there are more than 5
  272. ; callers waiting). If set to "limit," then only callers within the limit specified by announce-position-limit
  273. ; will have their position announced.
  274. ;
  275. ;announce-position = yes
  276. ;
  277. ; If you have specified "limit" or "more" for the announce-position option, then the following
  278. ; value is what is used to determine what announcement to play to waiting callers. If you have
  279. ; set the announce-position option to anything else, then this will have no bearing on queue operation
  280. ;
  281. ;announce-position-limit = 5
  282. ;
  283. ; What's the rounding time for the seconds?
  284. ; If this is non-zero, then we announce the seconds as well as the minutes
  285. ; rounded to this value.
  286. ; Valid values are 0, 5, 10, 15, 20, and 30.
  287. ;
  288. ; announce-round-seconds = 10
  289. ;
  290. ; Use these sound files in making position/holdtime announcements. The
  291. ; defaults are as listed below -- change only if you need to.
  292. ;
  293. ; Keep in mind that you may also prevent a sound from being played if you
  294. ; explicitly set a sound to be an empty string. For example, if you want to
  295. ; prevent the queue from playing queue-thankyou, you may set the sound using
  296. ; the following line:
  297. ;
  298. ; queue-thankyou=
  299. ;
  300. ; ("You are now first in line.")
  301. ;queue-youarenext = queue-youarenext
  302. ; ("There are")
  303. ;queue-thereare = queue-thereare
  304. ; ("calls waiting.")
  305. ;queue-callswaiting = queue-callswaiting
  306. ; ("The current est. holdtime is")
  307. ;queue-holdtime = queue-holdtime
  308. ; ("minutes.")
  309. ;queue-minutes = queue-minutes
  310. ; ("seconds.")
  311. ;queue-seconds = queue-seconds
  312. ; ("Thank you for your patience.")
  313. ;queue-thankyou = queue-thankyou
  314. ; ("Hold time")
  315. ;queue-reporthold = queue-reporthold
  316. ; ("All reps busy / wait for next")
  317. ;periodic-announce = queue-periodic-announce
  318. ;
  319. ; A set of periodic announcements can be defined by separating
  320. ; periodic announcements to reproduce by commas. For example:
  321. ;periodic-announce = queue-periodic-announce,your-call-is-important,please-wait
  322. ;
  323. ; The announcements will be played in the order in which they are defined. After
  324. ; playing the last announcement, the announcements begin again from the beginning.
  325. ;
  326. ; Calls may be recorded using Asterisk's monitor/MixMonitor resource
  327. ; This can be enabled from within the Queue application, starting recording
  328. ; when the call is actually picked up; thus, only successful calls are
  329. ; recorded, and you are not recording while people are listening to MOH.
  330. ; To enable monitoring, simply specify "monitor-format"; it will be disabled
  331. ; otherwise.
  332. ;
  333. ; You can specify the monitor filename with by calling
  334. ; Set(MONITOR_FILENAME=foo)
  335. ; Otherwise it will use MONITOR_FILENAME=${UNIQUEID}
  336. ;
  337. ; Pick any one valid extension for monitor format recording. If you leave
  338. ; monitor-format commented out, it will not record calls.
  339. ;
  340. ; monitor-format = gsm|wav|wav49
  341. ;
  342. ; Monitor Type
  343. ; By setting monitor-type = MixMonitor, when specifying monitor-format
  344. ; to enable recording of queue member conversations, app_queue will
  345. ; now use the new MixMonitor application instead of Monitor so
  346. ; the concept of "joining/mixing" the in/out files now goes away
  347. ; when this is enabled. If you do not specify or comment out this option,
  348. ; it will default to the old 'Monitor' behavior to keep backward
  349. ; compatibility.
  350. ;
  351. ; monitor-type = MixMonitor
  352. ;
  353. ; ----------------------- TYPE MIXMONITOR OPTIONS -----------------------------
  354. ;
  355. ;
  356. ; You can specify the options supplied to MixMonitor by calling (from the dialplan)
  357. ; Set(MONITOR_OPTIONS=av(<x>)V(<x>)W(<x>))
  358. ; The 'b' option for MixMonitor (only save audio to the file while bridged) is
  359. ; implied.
  360. ;
  361. ; You can specify a post recording command to be executed after the end of
  362. ; recording by calling (from the dialplan)
  363. ; Set(MONITOR_EXEC=mv /var/spool/asterisk/monitor/^{MONITOR_FILENAME} /tmp/^{MONITOR_FILENAME})
  364. ;
  365. ; The command specified within the contents of MONITOR_EXEC will be executed when
  366. ; the recording is over. Any strings matching ^{X} will be unescaped to ${X} and
  367. ; all variables will be evaluated just prior to recording being started.
  368. ;
  369. ; The contents of MONITOR_FILENAME will also be unescaped from ^{X} to ${X} and
  370. ; all variables will be evaluated just prior to recording being started.
  371. ;
  372. ;
  373. ; This setting controls whether callers can join a queue with no members. There
  374. ; are three choices:
  375. ;
  376. ; yes - callers can join a queue with no members or only unavailable members
  377. ; no - callers cannot join a queue with no members
  378. ; strict - callers cannot join a queue with no members or only unavailable
  379. ; members
  380. ; loose - same as strict, but paused queue members do not count as unavailable
  381. ;
  382. ; joinempty = yes
  383. ;
  384. ;
  385. ; If you wish to remove callers from the queue when new callers cannot join,
  386. ; set this setting to one of the same choices for 'joinempty'
  387. ;
  388. ; leavewhenempty = yes
  389. ;
  390. ;
  391. ; If this is set to yes, the following manager events will be generated:
  392. ; AgentCalled, AgentDump, AgentConnect, AgentComplete; setting this to
  393. ; vars also sends all channel variables with the event.
  394. ; (may generate some extra manager events, but probably ones you want)
  395. ;
  396. ; eventwhencalled = yes|no|vars
  397. ;
  398. ; If this is set to yes, the following manager events will be generated:
  399. ; QueueMemberStatus
  400. ; (may generate a WHOLE LOT of extra manager events)
  401. ;
  402. ; eventmemberstatus = no
  403. ;
  404. ; If you wish to report the caller's hold time to the member before they are
  405. ; connected to the caller, set this to yes.
  406. ;
  407. ; reportholdtime = no
  408. ;
  409. ; If you want the queue to avoid sending calls to members whose devices are
  410. ; known to be 'in use' (via the channel driver supporting that device state)
  411. ; uncomment this option. (Note: only the SIP channel driver currently is able
  412. ; to report 'in use'.)
  413. ;
  414. ; ringinuse = no
  415. ;
  416. ; If you wish to have a delay before the member is connected to the caller (or
  417. ; before the member hears any announcement messages), set this to the number of
  418. ; seconds to delay.
  419. ;
  420. ; memberdelay = 0
  421. ;
  422. ; If timeoutrestart is set to yes, then the timeout for an agent to answer is
  423. ; reset if a BUSY or CONGESTION is received. This can be useful if agents
  424. ; are able to cancel a call with reject or similar.
  425. ;
  426. ; timeoutrestart = no
  427. ;
  428. ; If you wish to implement a rule defined in queuerules.conf (see
  429. ; configs/queuerules.conf.sample from the asterisk source directory for
  430. ; more information about penalty rules) by default, you may specify this
  431. ; by setting defaultrule to the rule's name
  432. ;
  433. ; defaultrule = myrule
  434. ;
  435. ; Each member of this call queue is listed on a separate line in
  436. ; the form technology/dialstring. "member" means a normal member of a
  437. ; queue. An optional penalty may be specified after a comma, such that
  438. ; entries with higher penalties are considered last. An optional member
  439. ; name may also be specified after a second comma, which is used in log
  440. ; messages as a "friendly name". Multiple interfaces may share a single
  441. ; member name. An optional state interface may be specified after a third
  442. ; comma. This interface will be the one for which app_queue receives device
  443. ; state notifications, even though the first interface specified is the one
  444. ; that is actually called.
  445. ;
  446. ; It is important to ensure that channel drivers used for members are loaded
  447. ; before app_queue.so itself or they may be marked invalid until reload. This
  448. ; can be accomplished by explicitly listing them in modules.conf before
  449. ; app_queue.so. Additionally, if you use Local channels as queue members, you
  450. ; must also preload pbx_config.so and chan_local.so (or pbx_ael.so, pbx_lua.so,
  451. ; or pbx_realtime.so, depending on how your dialplan is configured).
  452. ;
  453. ;member => DAHDI/1
  454. ;member => DAHDI/2,10
  455. ;member => DAHDI/3,10,Bob Johnson
  456. ;member => Agent/1001
  457. ;member => Agent/1002
  458. ;member => Local/1000@default,0,John Smith,SIP/1000
  459. ;
  460. ; Note that using agent groups is probably not what you want. Strategies do
  461. ; not propagate down to the Agent system so if you want round robin, least
  462. ; recent, etc, you should list all the agents in this file individually and not
  463. ; use agent groups.
  464. ;
  465. ;member => Agent/@1 ; Any agent in group 1
  466. ;member => Agent/:1,1 ; Any agent in group 1, wait for first
  467. ; available, but consider with penalty