Asterisk-13-ManagerEvent_EndpointDetail_29394883.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 ManagerEvent_EndpointDetail</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_EndpointDetail
  28. </span>
  29. </h1>
  30. </div>
  31. <div id="content" class="view">
  32. <div class="page-metadata">
  33. Created and last modified by <span class='author'> wikibot</span> on Aug 11, 2014
  34. </div>
  35. <div id="main-content" class="wiki-content group">
  36. <h1 id="Asterisk13ManagerEvent_EndpointDetail-EndpointDetail">EndpointDetail</h1>
  37. <h3 id="Asterisk13ManagerEvent_EndpointDetail-Synopsis">Synopsis</h3>
  38. <p>Provide details about an endpoint section.</p>
  39. <h3 id="Asterisk13ManagerEvent_EndpointDetail-Description">Description</h3>
  40. <h3 id="Asterisk13ManagerEvent_EndpointDetail-Syntax">Syntax</h3>
  41. <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
  42. <pre>Event: EndpointDetail
  43. ObjectType: &lt;value&gt;
  44. ObjectName: &lt;value&gt;
  45. Context: &lt;value&gt;
  46. Disallow: &lt;value&gt;
  47. Allow: &lt;value&gt;
  48. DtmfMode: &lt;value&gt;
  49. RtpIpv6: &lt;value&gt;
  50. RtpSymmetric: &lt;value&gt;
  51. IceSupport: &lt;value&gt;
  52. UsePtime: &lt;value&gt;
  53. ForceRport: &lt;value&gt;
  54. RewriteContact: &lt;value&gt;
  55. Transport: &lt;value&gt;
  56. OutboundProxy: &lt;value&gt;
  57. MohSuggest: &lt;value&gt;
  58. 100rel: &lt;value&gt;
  59. Timers: &lt;value&gt;
  60. TimersMinSe: &lt;value&gt;
  61. TimersSessExpires: &lt;value&gt;
  62. Auth: &lt;value&gt;
  63. OutboundAuth: &lt;value&gt;
  64. Aors: &lt;value&gt;
  65. MediaAddress: &lt;value&gt;
  66. IdentifyBy: &lt;value&gt;
  67. DirectMedia: &lt;value&gt;
  68. DirectMediaMethod: &lt;value&gt;
  69. ConnectedLineMethod: &lt;value&gt;
  70. DirectMediaGlareMitigation: &lt;value&gt;
  71. DisableDirectMediaOnNat: &lt;value&gt;
  72. Callerid: &lt;value&gt;
  73. CalleridPrivacy: &lt;value&gt;
  74. CalleridTag: &lt;value&gt;
  75. TrustIdInbound: &lt;value&gt;
  76. TrustIdOutbound: &lt;value&gt;
  77. SendPai: &lt;value&gt;
  78. SendRpid: &lt;value&gt;
  79. SendDiversion: &lt;value&gt;
  80. Mailboxes: &lt;value&gt;
  81. AggregateMwi: &lt;value&gt;
  82. MediaEncryption: &lt;value&gt;
  83. UseAvpf: &lt;value&gt;
  84. ForceAvp: &lt;value&gt;
  85. MediaUseReceivedTransport: &lt;value&gt;
  86. OneTouchRecording: &lt;value&gt;
  87. InbandProgress: &lt;value&gt;
  88. CallGroup: &lt;value&gt;
  89. PickupGroup: &lt;value&gt;
  90. NamedCallGroup: &lt;value&gt;
  91. NamedPickupGroup: &lt;value&gt;
  92. DeviceStateBusyAt: &lt;value&gt;
  93. T38Udptl: &lt;value&gt;
  94. T38UdptlEc: &lt;value&gt;
  95. T38UdptlMaxdatagram: &lt;value&gt;
  96. FaxDetect: &lt;value&gt;
  97. T38UdptlNat: &lt;value&gt;
  98. T38UdptlIpv6: &lt;value&gt;
  99. ToneZone: &lt;value&gt;
  100. Language: &lt;value&gt;
  101. RecordOnFeature: &lt;value&gt;
  102. RecordOffFeature: &lt;value&gt;
  103. AllowTransfer: &lt;value&gt;
  104. SdpOwner: &lt;value&gt;
  105. SdpSession: &lt;value&gt;
  106. TosAudio: &lt;value&gt;
  107. TosVideo: &lt;value&gt;
  108. CosAudio: &lt;value&gt;
  109. CosVideo: &lt;value&gt;
  110. AllowSubscribe: &lt;value&gt;
  111. SubMinExpiry: &lt;value&gt;
  112. FromUser: &lt;value&gt;
  113. FromDomain: &lt;value&gt;
  114. MwiFromUser: &lt;value&gt;
  115. RtpEngine: &lt;value&gt;
  116. DtlsVerify: &lt;value&gt;
  117. DtlsRekey: &lt;value&gt;
  118. DtlsCertFile: &lt;value&gt;
  119. DtlsPrivateKey: &lt;value&gt;
  120. DtlsCipher: &lt;value&gt;
  121. DtlsCaFile: &lt;value&gt;
  122. DtlsCaPath: &lt;value&gt;
  123. DtlsSetup: &lt;value&gt;
  124. SrtpTag32: &lt;value&gt;
  125. RedirectMethod: &lt;value&gt;
  126. SetVar: &lt;value&gt;
  127. MessageContext: &lt;value&gt;
  128. Accountcode: &lt;value&gt;
  129. DeviceState: &lt;value&gt;
  130. ActiveChannels: &lt;value&gt;
  131. </pre>
  132. </div></div>
  133. <h5 id="Asterisk13ManagerEvent_EndpointDetail-Arguments">Arguments</h5>
  134. <ul>
  135. <li><code>ObjectType</code> - The object's type. This will always be 'endpoint'.</li>
  136. <li><code>ObjectName</code> - The name of this object.</li>
  137. <li><code>Context</code> - Dialplan context for inbound sessions</li>
  138. <li><code>Disallow</code> - Media Codec(s) to disallow</li>
  139. <li><code>Allow</code> - Media Codec(s) to allow</li>
  140. <li><code>DtmfMode</code> - DTMF mode</li>
  141. <li><code>RtpIpv6</code> - Allow use of IPv6 for RTP traffic</li>
  142. <li><code>RtpSymmetric</code> - Enforce that RTP must be symmetric</li>
  143. <li><code>IceSupport</code> - Enable the ICE mechanism to help traverse NAT</li>
  144. <li><code>UsePtime</code> - Use Endpoint's requested packetisation interval</li>
  145. <li><code>ForceRport</code> - Force use of return port</li>
  146. <li><code>RewriteContact</code> - Allow Contact header to be rewritten with the source IP address-port</li>
  147. <li><code>Transport</code> - Desired transport configuration</li>
  148. <li><code>OutboundProxy</code> - Proxy through which to send requests, a full SIP URI must be provided</li>
  149. <li><code>MohSuggest</code> - Default Music On Hold class</li>
  150. <li><code>100rel</code> - Allow support for RFC3262 provisional ACK tags</li>
  151. <li><code>Timers</code> - Session timers for SIP packets</li>
  152. <li><code>TimersMinSe</code> - Minimum session timers expiration period</li>
  153. <li><code>TimersSessExpires</code> - Maximum session timer expiration period</li>
  154. <li><code>Auth</code> - Authentication Object(s) associated with the endpoint</li>
  155. <li><code>OutboundAuth</code> - Authentication object used for outbound requests</li>
  156. <li><code>Aors</code> - AoR(s) to be used with the endpoint</li>
  157. <li><code>MediaAddress</code> - IP address used in SDP for media handling</li>
  158. <li><code>IdentifyBy</code> - Way(s) for Endpoint to be identified</li>
  159. <li><code>DirectMedia</code> - Determines whether media may flow directly between endpoints.</li>
  160. <li><code>DirectMediaMethod</code> - Direct Media method type</li>
  161. <li><code>ConnectedLineMethod</code> - Connected line method type</li>
  162. <li><code>DirectMediaGlareMitigation</code> - Mitigation of direct media (re)INVITE glare</li>
  163. <li><code>DisableDirectMediaOnNat</code> - Disable direct media session refreshes when NAT obstructs the media session</li>
  164. <li><code>Callerid</code> - CallerID information for the endpoint</li>
  165. <li><code>CalleridPrivacy</code> - Default privacy level</li>
  166. <li><code>CalleridTag</code> - Internal id_tag for the endpoint</li>
  167. <li><code>TrustIdInbound</code> - Accept identification information received from this endpoint</li>
  168. <li><code>TrustIdOutbound</code> - Send private identification details to the endpoint.</li>
  169. <li><code>SendPai</code> - Send the P-Asserted-Identity header</li>
  170. <li><code>SendRpid</code> - Send the Remote-Party-ID header</li>
  171. <li><code>SendDiversion</code> - Send the Diversion header, conveying the diversion information to the called user agent</li>
  172. <li><code>Mailboxes</code> - NOTIFY the endpoint when state changes for any of the specified mailboxes</li>
  173. <li><code>AggregateMwi</code> - Condense MWI notifications into a single NOTIFY.</li>
  174. <li><code>MediaEncryption</code> - Determines whether res_pjsip will use and enforce usage of media encryption for this endpoint.</li>
  175. <li><code>UseAvpf</code> - Determines whether res_pjsip will use and enforce usage of AVPF for this endpoint.</li>
  176. <li><code>ForceAvp</code> - Determines whether res_pjsip will use and enforce usage of AVP, regardless of the RTP profile in use for this endpoint.</li>
  177. <li><code>MediaUseReceivedTransport</code> - Determines whether res_pjsip will use the media transport received in the offer SDP in the corresponding answer SDP.</li>
  178. <li><code>OneTouchRecording</code> - Determines whether one-touch recording is allowed for this endpoint.</li>
  179. <li><code>InbandProgress</code> - Determines whether chan_pjsip will indicate ringing using inband progress.</li>
  180. <li><code>CallGroup</code> - The numeric pickup groups for a channel.</li>
  181. <li><code>PickupGroup</code> - The numeric pickup groups that a channel can pickup.</li>
  182. <li><code>NamedCallGroup</code> - The named pickup groups for a channel.</li>
  183. <li><code>NamedPickupGroup</code> - The named pickup groups that a channel can pickup.</li>
  184. <li><code>DeviceStateBusyAt</code> - The number of in-use channels which will cause busy to be returned as device state</li>
  185. <li><code>T38Udptl</code> - Whether T.38 UDPTL support is enabled or not</li>
  186. <li><code>T38UdptlEc</code> - T.38 UDPTL error correction method</li>
  187. <li><code>T38UdptlMaxdatagram</code> - T.38 UDPTL maximum datagram size</li>
  188. <li><code>FaxDetect</code> - Whether CNG tone detection is enabled</li>
  189. <li><code>T38UdptlNat</code> - Whether NAT support is enabled on UDPTL sessions</li>
  190. <li><code>T38UdptlIpv6</code> - Whether IPv6 is used for UDPTL Sessions</li>
  191. <li><code>ToneZone</code> - Set which country's indications to use for channels created for this endpoint.</li>
  192. <li><code>Language</code> - Set the default language to use for channels created for this endpoint.</li>
  193. <li><code>RecordOnFeature</code> - The feature to enact when one-touch recording is turned on.</li>
  194. <li><code>RecordOffFeature</code> - The feature to enact when one-touch recording is turned off.</li>
  195. <li><code>AllowTransfer</code> - Determines whether SIP REFER transfers are allowed for this endpoint</li>
  196. <li><code>SdpOwner</code> - String placed as the username portion of an SDP origin (o=) line.</li>
  197. <li><code>SdpSession</code> - String used for the SDP session (s=) line.</li>
  198. <li><code>TosAudio</code> - DSCP TOS bits for audio streams</li>
  199. <li><code>TosVideo</code> - DSCP TOS bits for video streams</li>
  200. <li><code>CosAudio</code> - Priority for audio streams</li>
  201. <li><code>CosVideo</code> - Priority for video streams</li>
  202. <li><code>AllowSubscribe</code> - Determines if endpoint is allowed to initiate subscriptions with Asterisk.</li>
  203. <li><code>SubMinExpiry</code> - The minimum allowed expiry time for subscriptions initiated by the endpoint.</li>
  204. <li><code>FromUser</code> - Username to use in From header for requests to this endpoint.</li>
  205. <li><code>FromDomain</code> - Domain to user in From header for requests to this endpoint.</li>
  206. <li><code>MwiFromUser</code> - Username to use in From header for unsolicited MWI NOTIFYs to this endpoint.</li>
  207. <li><code>RtpEngine</code> - Name of the RTP engine to use for channels created for this endpoint</li>
  208. <li><code>DtlsVerify</code> - Verify that the provided peer certificate is valid</li>
  209. <li><code>DtlsRekey</code> - Interval at which to renegotiate the TLS session and rekey the SRTP session</li>
  210. <li><code>DtlsCertFile</code> - Path to certificate file to present to peer</li>
  211. <li><code>DtlsPrivateKey</code> - Path to private key for certificate file</li>
  212. <li><code>DtlsCipher</code> - Cipher to use for DTLS negotiation</li>
  213. <li><code>DtlsCaFile</code> - Path to certificate authority certificate</li>
  214. <li><code>DtlsCaPath</code> - Path to a directory containing certificate authority certificates</li>
  215. <li><code>DtlsSetup</code> - Whether we are willing to accept connections, connect to the other party, or both.</li>
  216. <li><code>SrtpTag32</code> - Determines whether 32 byte tags should be used instead of 80 byte tags.</li>
  217. <li><code>RedirectMethod</code> - How redirects received from an endpoint are handled</li>
  218. <li><code>SetVar</code> - Variable set on a channel involving the endpoint.</li>
  219. <li><code>MessageContext</code> - Context to route incoming MESSAGE requests to.</li>
  220. <li><code>Accountcode</code> - An accountcode to set automatically on any channels created for this endpoint.</li>
  221. <li><code>DeviceState</code> - The aggregate device state for this endpoint.</li>
  222. <li><code>ActiveChannels</code> - The number of active channels associated with this endpoint.</li>
  223. </ul>
  224. <h3 id="Asterisk13ManagerEvent_EndpointDetail-Class">Class</h3>
  225. <p>COMMAND</p>
  226. <h3 id="Asterisk13ManagerEvent_EndpointDetail-SeeAlso">See Also</h3>
  227. <h3 id="Asterisk13ManagerEvent_EndpointDetail-ImportVersion">Import Version</h3>
  228. <p>This documentation was imported from Asterisk Version SVN-branch-13-r420717</p>
  229. </div>
  230. </div> </div>
  231. <div id="footer">
  232. <section class="footer-body">
  233. <p>Document generated by Confluence on Aug 11, 2014 13:39</p>
  234. </section>
  235. </div>
  236. </div> </body>
  237. </html>