Asterisk-13-Configuration_app_agent_pool_29394506.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 Configuration_app_agent_pool</title>
  5. <link rel="stylesheet" href="styles/site.css" type="text/css" />
  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. </head>
  8. <body class="theme-default aui-theme-default">
  9. <div id="page">
  10. <div id="main" class="aui-page-panel">
  11. <div id="main-header">
  12. <div id="breadcrumb-section">
  13. <ol id="breadcrumbs">
  14. <li class="first">
  15. <span><a href="index.html">Asterisk Project</a></span>
  16. </li>
  17. <li>
  18. <span><a href="Asterisk-13-Command-Reference_29394274.html">Asterisk 13 Command Reference</a></span>
  19. </li>
  20. <li>
  21. <span><a href="Asterisk-13-Module-Configuration_29394289.html">Asterisk 13 Module Configuration</a></span>
  22. </li>
  23. </ol>
  24. </div>
  25. <h1 id="title-heading" class="pagetitle">
  26. <span id="title-text">
  27. Asterisk Project : Asterisk 13 Configuration_app_agent_pool
  28. </span>
  29. </h1>
  30. </div>
  31. <div id="content" class="view">
  32. <div class="page-metadata">
  33. Created by <span class='author'> wikibot</span> on Aug 08, 2014
  34. </div>
  35. <div id="main-content" class="wiki-content group">
  36. <h1 id="Asterisk13Configuration_app_agent_pool-Agentpoolapplications">Agent pool applications</h1>
  37. <p>This configuration documentation is for functionality provided by <code>app_agent_pool</code>.</p>
  38. <h2 id="Asterisk13Configuration_app_agent_pool-Overview">Overview</h2>
  39. <div class="aui-message hint shadowed information-macro">
  40. <p class="title">Note</p>
  41. <span class="aui-icon icon-hint">Icon</span>
  42. <div class="message-content">
  43. <p>Option changes take effect on agent login or after an agent disconnects from a call.</p>
  44. </div>
  45. </div>
  46. <h2 id="Asterisk13Configuration_app_agent_pool-agents.conf">agents.conf</h2>
  47. <h3 id="Asterisk13Configuration_app_agent_pool-global">global</h3>
  48. <p>Unused, but reserved.</p>
  49. <h3 id="Asterisk13Configuration_app_agent_pool-agent-id">agent-id</h3>
  50. <p>Configure an agent for the pool.</p>
  51. <h4 id="Asterisk13Configuration_app_agent_pool-ConfigurationOptionReference">Configuration Option Reference</h4>
  52. <div class="table-wrap"><table class="confluenceTable"><tbody>
  53. <tr>
  54. <th class="confluenceTh"><p> Option Name </p></th>
  55. <th class="confluenceTh"><p> Type </p></th>
  56. <th class="confluenceTh"><p> Default Value </p></th>
  57. <th class="confluenceTh"><p> Regular Expression </p></th>
  58. <th class="confluenceTh"><p> Description </p></th>
  59. </tr>
  60. <tr>
  61. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_app_agent_pool_29394506.html"><code>ackcall</code></a> </p></td>
  62. <td class="confluenceTd"><p> <code>Boolean</code> </p></td>
  63. <td class="confluenceTd"><p> <code>no</code> </p></td>
  64. <td class="confluenceTd"><p> <code>false</code> </p></td>
  65. <td class="confluenceTd"><p> Enable to require the agent to acknowledge a call. </p></td>
  66. </tr>
  67. <tr>
  68. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_app_agent_pool_29394506.html"><code>acceptdtmf</code></a> </p></td>
  69. <td class="confluenceTd"><p> <code>String</code> </p></td>
  70. <td class="confluenceTd"><p> <code>#</code> </p></td>
  71. <td class="confluenceTd"><p> <code>false</code> </p></td>
  72. <td class="confluenceTd"><p> DTMF key sequence the agent uses to acknowledge a call. </p></td>
  73. </tr>
  74. <tr>
  75. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_app_agent_pool_29394506.html"><code>autologoff</code></a> </p></td>
  76. <td class="confluenceTd"><p> <code>Unsigned Integer</code> </p></td>
  77. <td class="confluenceTd"><p> <code>0</code> </p></td>
  78. <td class="confluenceTd"><p> <code>false</code> </p></td>
  79. <td class="confluenceTd"><p> Time the agent has to acknowledge a call before being logged off. </p></td>
  80. </tr>
  81. <tr>
  82. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_app_agent_pool_29394506.html"><code>wrapuptime</code></a> </p></td>
  83. <td class="confluenceTd"><p> <code>Unsigned Integer</code> </p></td>
  84. <td class="confluenceTd"><p> <code>0</code> </p></td>
  85. <td class="confluenceTd"><p> <code>false</code> </p></td>
  86. <td class="confluenceTd"><p> Minimum time the agent has between calls. </p></td>
  87. </tr>
  88. <tr>
  89. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_app_agent_pool_29394506.html"><code>musiconhold</code></a> </p></td>
  90. <td class="confluenceTd"><p> <code>String</code> </p></td>
  91. <td class="confluenceTd"><p> <code>default</code> </p></td>
  92. <td class="confluenceTd"><p> <code>false</code> </p></td>
  93. <td class="confluenceTd"><p> Music on hold class the agent listens to between calls. </p></td>
  94. </tr>
  95. <tr>
  96. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_app_agent_pool_29394506.html"><code>recordagentcalls</code></a> </p></td>
  97. <td class="confluenceTd"><p> <code>Boolean</code> </p></td>
  98. <td class="confluenceTd"><p> <code>no</code> </p></td>
  99. <td class="confluenceTd"><p> <code>false</code> </p></td>
  100. <td class="confluenceTd"><p> Enable to automatically record calls the agent takes. </p></td>
  101. </tr>
  102. <tr>
  103. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_app_agent_pool_29394506.html"><code>custom_beep</code></a> </p></td>
  104. <td class="confluenceTd"><p> <code>String</code> </p></td>
  105. <td class="confluenceTd"><p> <code>beep</code> </p></td>
  106. <td class="confluenceTd"><p> <code>false</code> </p></td>
  107. <td class="confluenceTd"><p> Sound file played to alert the agent when a call is present. </p></td>
  108. </tr>
  109. <tr>
  110. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_app_agent_pool_29394506.html"><code>fullname</code></a> </p></td>
  111. <td class="confluenceTd"><p> <code>String</code> </p></td>
  112. <td class="confluenceTd"><p> </p></td>
  113. <td class="confluenceTd"><p> <code>false</code> </p></td>
  114. <td class="confluenceTd"><p> A friendly name for the agent used in log messages. </p></td>
  115. </tr>
  116. </tbody></table></div>
  117. <h4 id="Asterisk13Configuration_app_agent_pool-ConfigurationOptionDescriptions">Configuration Option Descriptions</h4>
  118. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_app_agent_pool-agent-id_ackcall"></span></p>
  119. <h5 id="Asterisk13Configuration_app_agent_pool-ackcall">ackcall</h5>
  120. <p>Enable to require the agent to give a DTMF acknowledgement when the agent receives a call.</p>
  121. <div class="aui-message hint shadowed information-macro">
  122. <p class="title">Note</p>
  123. <span class="aui-icon icon-hint">Icon</span>
  124. <div class="message-content">
  125. <p>The option is overridden by <code>AGENTACKCALL</code> on agent login.</p>
  126. </div>
  127. </div>
  128. <div class="aui-message hint shadowed information-macro">
  129. <p class="title">Note</p>
  130. <span class="aui-icon icon-hint">Icon</span>
  131. <div class="message-content">
  132. <p>Option changes take effect on agent login or after an agent disconnects from a call.</p>
  133. </div>
  134. </div>
  135. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_app_agent_pool-agent-id_acceptdtmf"></span></p>
  136. <h5 id="Asterisk13Configuration_app_agent_pool-acceptdtmf">acceptdtmf</h5>
  137. <div class="aui-message hint shadowed information-macro">
  138. <p class="title">Note</p>
  139. <span class="aui-icon icon-hint">Icon</span>
  140. <div class="message-content">
  141. <p>The option is overridden by <code>AGENTACCEPTDTMF</code> on agent login.</p>
  142. </div>
  143. </div>
  144. <div class="aui-message hint shadowed information-macro">
  145. <p class="title">Note</p>
  146. <span class="aui-icon icon-hint">Icon</span>
  147. <div class="message-content">
  148. <p>The option is ignored unless the ackcall option is enabled.</p>
  149. </div>
  150. </div>
  151. <div class="aui-message hint shadowed information-macro">
  152. <p class="title">Note</p>
  153. <span class="aui-icon icon-hint">Icon</span>
  154. <div class="message-content">
  155. <p>Option changes take effect on agent login or after an agent disconnects from a call.</p>
  156. </div>
  157. </div>
  158. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_app_agent_pool-agent-id_autologoff"></span></p>
  159. <h5 id="Asterisk13Configuration_app_agent_pool-autologoff">autologoff</h5>
  160. <p>Set how many seconds a call for the agent has to wait for the agent to acknowledge the call before the agent is automatically logged off. If set to zero then the call will wait forever for the agent to acknowledge.</p>
  161. <div class="aui-message hint shadowed information-macro">
  162. <p class="title">Note</p>
  163. <span class="aui-icon icon-hint">Icon</span>
  164. <div class="message-content">
  165. <p>The option is overridden by <code>AGENTAUTOLOGOFF</code> on agent login.</p>
  166. </div>
  167. </div>
  168. <div class="aui-message hint shadowed information-macro">
  169. <p class="title">Note</p>
  170. <span class="aui-icon icon-hint">Icon</span>
  171. <div class="message-content">
  172. <p>The option is ignored unless the ackcall option is enabled.</p>
  173. </div>
  174. </div>
  175. <div class="aui-message hint shadowed information-macro">
  176. <p class="title">Note</p>
  177. <span class="aui-icon icon-hint">Icon</span>
  178. <div class="message-content">
  179. <p>Option changes take effect on agent login or after an agent disconnects from a call.</p>
  180. </div>
  181. </div>
  182. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_app_agent_pool-agent-id_wrapuptime"></span></p>
  183. <h5 id="Asterisk13Configuration_app_agent_pool-wrapuptime">wrapuptime</h5>
  184. <p>Set the minimum amount of time in milliseconds after disconnecting a call before the agent can receive a new call.</p>
  185. <div class="aui-message hint shadowed information-macro">
  186. <p class="title">Note</p>
  187. <span class="aui-icon icon-hint">Icon</span>
  188. <div class="message-content">
  189. <p>The option is overridden by <code>AGENTWRAPUPTIME</code> on agent login.</p>
  190. </div>
  191. </div>
  192. <div class="aui-message hint shadowed information-macro">
  193. <p class="title">Note</p>
  194. <span class="aui-icon icon-hint">Icon</span>
  195. <div class="message-content">
  196. <p>Option changes take effect on agent login or after an agent disconnects from a call.</p>
  197. </div>
  198. </div>
  199. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_app_agent_pool-agent-id_musiconhold"></span></p>
  200. <h5 id="Asterisk13Configuration_app_agent_pool-musiconhold">musiconhold</h5>
  201. <div class="aui-message hint shadowed information-macro">
  202. <p class="title">Note</p>
  203. <span class="aui-icon icon-hint">Icon</span>
  204. <div class="message-content">
  205. <p>Option changes take effect on agent login or after an agent disconnects from a call.</p>
  206. </div>
  207. </div>
  208. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_app_agent_pool-agent-id_recordagentcalls"></span></p>
  209. <h5 id="Asterisk13Configuration_app_agent_pool-recordagentcalls">recordagentcalls</h5>
  210. <p>Enable recording calls the agent takes automatically by invoking the automixmon DTMF feature when the agent connects to a caller. See <code>features.conf.sample</code> for information about the automixmon feature.</p>
  211. <div class="aui-message hint shadowed information-macro">
  212. <p class="title">Note</p>
  213. <span class="aui-icon icon-hint">Icon</span>
  214. <div class="message-content">
  215. <p>Option changes take effect on agent login or after an agent disconnects from a call.</p>
  216. </div>
  217. </div>
  218. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_app_agent_pool-agent-id_custom_beep"></span></p>
  219. <h5 id="Asterisk13Configuration_app_agent_pool-custom_beep">custom_beep</h5>
  220. <div class="aui-message hint shadowed information-macro">
  221. <p class="title">Note</p>
  222. <span class="aui-icon icon-hint">Icon</span>
  223. <div class="message-content">
  224. <p>Option changes take effect on agent login or after an agent disconnects from a call.</p>
  225. </div>
  226. </div>
  227. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_app_agent_pool-agent-id_fullname"></span></p>
  228. <h5 id="Asterisk13Configuration_app_agent_pool-fullname">fullname</h5>
  229. <div class="aui-message hint shadowed information-macro">
  230. <p class="title">Note</p>
  231. <span class="aui-icon icon-hint">Icon</span>
  232. <div class="message-content">
  233. <p>Option changes take effect on agent login or after an agent disconnects from a call.</p>
  234. </div>
  235. </div>
  236. <h3 id="Asterisk13Configuration_app_agent_pool-ImportVersion">Import Version</h3>
  237. <p>This documentation was imported from Asterisk Version SVN-branch-13-r420538</p>
  238. </div>
  239. </div> </div>
  240. <div id="footer">
  241. <section class="footer-body">
  242. <p>Document generated by Confluence on Aug 11, 2014 13:48</p>
  243. </section>
  244. </div>
  245. </div> </body>
  246. </html>