Asterisk-13-ManagerEvent_Agents_29394967.html 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 ManagerEvent_Agents</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-AMI-Events_29394281.html">Asterisk 13 AMI Events</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 ManagerEvent_Agents
  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="Asterisk13ManagerEvent_Agents-Agents">Agents</h1>
  37. <h3 id="Asterisk13ManagerEvent_Agents-Synopsis">Synopsis</h3>
  38. <p>Response event in a series to the Agents AMI action containing information about a defined agent.</p>
  39. <h3 id="Asterisk13ManagerEvent_Agents-Description">Description</h3>
  40. <p>The channel snapshot is present if the Status value is <code>AGENT_IDLE</code> or <code>AGENT_ONCALL</code>.</p>
  41. <h3 id="Asterisk13ManagerEvent_Agents-Syntax">Syntax</h3>
  42. <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
  43. <pre>Event: Agents
  44. Agent: &lt;value&gt;
  45. Name: &lt;value&gt;
  46. Status: &lt;value&gt;
  47. TalkingToChan: &lt;value&gt;
  48. CallStarted: &lt;value&gt;
  49. LoggedInTime: &lt;value&gt;
  50. Channel: &lt;value&gt;
  51. ChannelState: &lt;value&gt;
  52. ChannelStateDesc: &lt;value&gt;
  53. CallerIDNum: &lt;value&gt;
  54. CallerIDName: &lt;value&gt;
  55. ConnectedLineNum: &lt;value&gt;
  56. ConnectedLineName: &lt;value&gt;
  57. AccountCode: &lt;value&gt;
  58. Context: &lt;value&gt;
  59. Exten: &lt;value&gt;
  60. Priority: &lt;value&gt;
  61. Uniqueid: &lt;value&gt;
  62. ActionID: &lt;value&gt;
  63. </pre>
  64. </div></div>
  65. <h5 id="Asterisk13ManagerEvent_Agents-Arguments">Arguments</h5>
  66. <ul>
  67. <li><code>Agent</code> - Agent ID of the agent.</li>
  68. <li><code>Name</code> - User friendly name of the agent.</li>
  69. <li><code>Status</code> - Current status of the agent.<br />
  70. The valid values are:
  71. <ul>
  72. <li><code>AGENT_LOGGEDOFF</code></li>
  73. <li><code>AGENT_IDLE</code></li>
  74. <li><code>AGENT_ONCALL</code></li>
  75. </ul>
  76. </li>
  77. <li><code>TalkingToChan</code> - BRIDGEPEER value on agent channel.<br />
  78. Present if Status value is <code>AGENT_ONCALL</code>.</li>
  79. <li><code>CallStarted</code> - Epoche time when the agent started talking with the caller.<br />
  80. Present if Status value is <code>AGENT_ONCALL</code>.</li>
  81. <li><code>LoggedInTime</code> - Epoche time when the agent logged in.<br />
  82. Present if Status value is <code>AGENT_IDLE</code> or <code>AGENT_ONCALL</code>.</li>
  83. <li><code>Channel</code></li>
  84. <li><code>ChannelState</code> - A numeric code for the channel's current state, related to ChannelStateDesc</li>
  85. <li><code>ChannelStateDesc</code>
  86. <ul>
  87. <li><code>Down</code></li>
  88. <li><code>Rsrvd</code></li>
  89. <li><code>OffHook</code></li>
  90. <li><code>Dialing</code></li>
  91. <li><code>Ring</code></li>
  92. <li><code>Ringing</code></li>
  93. <li><code>Up</code></li>
  94. <li><code>Busy</code></li>
  95. <li><code>Dialing Offhook</code></li>
  96. <li><code>Pre-ring</code></li>
  97. <li><code>Unknown</code></li>
  98. </ul>
  99. </li>
  100. <li><code>CallerIDNum</code></li>
  101. <li><code>CallerIDName</code></li>
  102. <li><code>ConnectedLineNum</code></li>
  103. <li><code>ConnectedLineName</code></li>
  104. <li><code>AccountCode</code></li>
  105. <li><code>Context</code></li>
  106. <li><code>Exten</code></li>
  107. <li><code>Priority</code></li>
  108. <li><code>Uniqueid</code></li>
  109. <li><code>ActionID</code> - ActionID for this transaction. Will be returned.</li>
  110. </ul>
  111. <h3 id="Asterisk13ManagerEvent_Agents-Class">Class</h3>
  112. <p>AGENT</p>
  113. <h3 id="Asterisk13ManagerEvent_Agents-SeeAlso">See Also</h3>
  114. <ul>
  115. <li><a href="Asterisk-13-ManagerAction_Agents_29394504.html">Asterisk 13 ManagerAction_Agents</a></li>
  116. </ul>
  117. <h3 id="Asterisk13ManagerEvent_Agents-ImportVersion">Import Version</h3>
  118. <p>This documentation was imported from Asterisk Version SVN-branch-13-r420538</p>
  119. </div>
  120. </div> </div>
  121. <div id="footer">
  122. <section class="footer-body">
  123. <p>Document generated by Confluence on Aug 11, 2014 13:39</p>
  124. </section>
  125. </div>
  126. </div> </body>
  127. </html>