Asterisk-13-Function_PJSIP_ENDPOINT_29394692.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 Function_PJSIP_ENDPOINT</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-Dialplan-Functions_29394287.html">Asterisk 13 Dialplan Functions</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 Function_PJSIP_ENDPOINT
  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="Asterisk13Function_PJSIP_ENDPOINT-PJSIP_ENDPOINT()">PJSIP_ENDPOINT()</h1>
  37. <h3 id="Asterisk13Function_PJSIP_ENDPOINT-Synopsis">Synopsis</h3>
  38. <p>Get information about a PJSIP endpoint</p>
  39. <h3 id="Asterisk13Function_PJSIP_ENDPOINT-Description">Description</h3>
  40. <h3 id="Asterisk13Function_PJSIP_ENDPOINT-Syntax">Syntax</h3>
  41. <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
  42. <pre>PJSIP_ENDPOINT(name,field)</pre>
  43. </div></div>
  44. <h5 id="Asterisk13Function_PJSIP_ENDPOINT-Arguments">Arguments</h5>
  45. <ul>
  46. <li><code>name</code> - The name of the endpoint to query.</li>
  47. <li><code>field</code> - The configuration option for the endpoint to query for. Supported options are those fields on the <em>endpoint</em> object in <code>pjsip.conf</code>.
  48. <ul>
  49. <li><code>100rel</code> - Allow support for RFC3262 provisional ACK tags</li>
  50. <li><code>aggregate_mwi</code> - Condense MWI notifications into a single NOTIFY.</li>
  51. <li><code>allow</code> - Media Codec(s) to allow</li>
  52. <li><code>aors</code> - AoR(s) to be used with the endpoint</li>
  53. <li><code>auth</code> - Authentication Object(s) associated with the endpoint</li>
  54. <li><code>callerid</code> - CallerID information for the endpoint</li>
  55. <li><code>callerid_privacy</code> - Default privacy level</li>
  56. <li><code>callerid_tag</code> - Internal id_tag for the endpoint</li>
  57. <li><code>context</code> - Dialplan context for inbound sessions</li>
  58. <li><code>direct_media_glare_mitigation</code> - Mitigation of direct media (re)INVITE glare</li>
  59. <li><code>direct_media_method</code> - Direct Media method type</li>
  60. <li><code>connected_line_method</code> - Connected line method type</li>
  61. <li><code>direct_media</code> - Determines whether media may flow directly between endpoints.</li>
  62. <li><code>disable_direct_media_on_nat</code> - Disable direct media session refreshes when NAT obstructs the media session</li>
  63. <li><code>disallow</code> - Media Codec(s) to disallow</li>
  64. <li><code>dtmf_mode</code> - DTMF mode</li>
  65. <li><code>media_address</code> - IP address used in SDP for media handling</li>
  66. <li><code>force_rport</code> - Force use of return port</li>
  67. <li><code>ice_support</code> - Enable the ICE mechanism to help traverse NAT</li>
  68. <li><code>identify_by</code> - Way(s) for Endpoint to be identified</li>
  69. <li><code>redirect_method</code> - How redirects received from an endpoint are handled</li>
  70. <li><code>mailboxes</code> - NOTIFY the endpoint when state changes for any of the specified mailboxes</li>
  71. <li><code>moh_suggest</code> - Default Music On Hold class</li>
  72. <li><code>outbound_auth</code> - Authentication object used for outbound requests</li>
  73. <li><code>outbound_proxy</code> - Proxy through which to send requests, a full SIP URI must be provided</li>
  74. <li><code>rewrite_contact</code> - Allow Contact header to be rewritten with the source IP address-port</li>
  75. <li><code>rtp_ipv6</code> - Allow use of IPv6 for RTP traffic</li>
  76. <li><code>rtp_symmetric</code> - Enforce that RTP must be symmetric</li>
  77. <li><code>send_diversion</code> - Send the Diversion header, conveying the diversion information to the called user agent</li>
  78. <li><code>send_pai</code> - Send the P-Asserted-Identity header</li>
  79. <li><code>send_rpid</code> - Send the Remote-Party-ID header</li>
  80. <li><code>timers_min_se</code> - Minimum session timers expiration period</li>
  81. <li><code>timers</code> - Session timers for SIP packets</li>
  82. <li><code>timers_sess_expires</code> - Maximum session timer expiration period</li>
  83. <li><code>transport</code> - Desired transport configuration</li>
  84. <li><code>trust_id_inbound</code> - Accept identification information received from this endpoint</li>
  85. <li><code>trust_id_outbound</code> - Send private identification details to the endpoint.</li>
  86. <li><code>type</code> - Must be of type 'endpoint'.</li>
  87. <li><code>use_ptime</code> - Use Endpoint's requested packetisation interval</li>
  88. <li><code>use_avpf</code> - Determines whether res_pjsip will use and enforce usage of AVPF for this endpoint.</li>
  89. <li><code>force_avp</code> - Determines whether res_pjsip will use and enforce usage of AVP, regardless of the RTP profile in use for this endpoint.</li>
  90. <li><code>media_use_received_transport</code> - Determines whether res_pjsip will use the media transport received in the offer SDP in the corresponding answer SDP.</li>
  91. <li><code>media_encryption</code> - Determines whether res_pjsip will use and enforce usage of media encryption for this endpoint.</li>
  92. <li><code>inband_progress</code> - Determines whether chan_pjsip will indicate ringing using inband progress.</li>
  93. <li><code>call_group</code> - The numeric pickup groups for a channel.</li>
  94. <li><code>pickup_group</code> - The numeric pickup groups that a channel can pickup.</li>
  95. <li><code>named_call_group</code> - The named pickup groups for a channel.</li>
  96. <li><code>named_pickup_group</code> - The named pickup groups that a channel can pickup.</li>
  97. <li><code>device_state_busy_at</code> - The number of in-use channels which will cause busy to be returned as device state</li>
  98. <li><code>t38_udptl</code> - Whether T.38 UDPTL support is enabled or not</li>
  99. <li><code>t38_udptl_ec</code> - T.38 UDPTL error correction method</li>
  100. <li><code>t38_udptl_maxdatagram</code> - T.38 UDPTL maximum datagram size</li>
  101. <li><code>fax_detect</code> - Whether CNG tone detection is enabled</li>
  102. <li><code>t38_udptl_nat</code> - Whether NAT support is enabled on UDPTL sessions</li>
  103. <li><code>t38_udptl_ipv6</code> - Whether IPv6 is used for UDPTL Sessions</li>
  104. <li><code>tone_zone</code> - Set which country's indications to use for channels created for this endpoint.</li>
  105. <li><code>language</code> - Set the default language to use for channels created for this endpoint.</li>
  106. <li><code>one_touch_recording</code> - Determines whether one-touch recording is allowed for this endpoint.</li>
  107. <li><code>record_on_feature</code> - The feature to enact when one-touch recording is turned on.</li>
  108. <li><code>record_off_feature</code> - The feature to enact when one-touch recording is turned off.</li>
  109. <li><code>rtp_engine</code> - Name of the RTP engine to use for channels created for this endpoint</li>
  110. <li><code>allow_transfer</code> - Determines whether SIP REFER transfers are allowed for this endpoint</li>
  111. <li><code>sdp_owner</code> - String placed as the username portion of an SDP origin (o=) line.</li>
  112. <li><code>sdp_session</code> - String used for the SDP session (s=) line.</li>
  113. <li><code>tos_audio</code> - DSCP TOS bits for audio streams</li>
  114. <li><code>tos_video</code> - DSCP TOS bits for video streams</li>
  115. <li><code>cos_audio</code> - Priority for audio streams</li>
  116. <li><code>cos_video</code> - Priority for video streams</li>
  117. <li><code>allow_subscribe</code> - Determines if endpoint is allowed to initiate subscriptions with Asterisk.</li>
  118. <li><code>sub_min_expiry</code> - The minimum allowed expiry time for subscriptions initiated by the endpoint.</li>
  119. <li><code>from_user</code> - Username to use in From header for requests to this endpoint.</li>
  120. <li><code>mwi_from_user</code> - Username to use in From header for unsolicited MWI NOTIFYs to this endpoint.</li>
  121. <li><code>from_domain</code> - Domain to user in From header for requests to this endpoint.</li>
  122. <li><code>dtls_verify</code> - Verify that the provided peer certificate is valid</li>
  123. <li><code>dtls_rekey</code> - Interval at which to renegotiate the TLS session and rekey the SRTP session</li>
  124. <li><code>dtls_cert_file</code> - Path to certificate file to present to peer</li>
  125. <li><code>dtls_private_key</code> - Path to private key for certificate file</li>
  126. <li><code>dtls_cipher</code> - Cipher to use for DTLS negotiation</li>
  127. <li><code>dtls_ca_file</code> - Path to certificate authority certificate</li>
  128. <li><code>dtls_ca_path</code> - Path to a directory containing certificate authority certificates</li>
  129. <li><code>dtls_setup</code> - Whether we are willing to accept connections, connect to the other party, or both.</li>
  130. <li><code>srtp_tag_32</code> - Determines whether 32 byte tags should be used instead of 80 byte tags.</li>
  131. <li><code>set_var</code> - Variable set on a channel involving the endpoint.</li>
  132. <li><code>message_context</code> - Context to route incoming MESSAGE requests to.</li>
  133. <li><code>accountcode</code> - An accountcode to set automatically on any channels created for this endpoint.</li>
  134. </ul>
  135. </li>
  136. </ul>
  137. <h3 id="Asterisk13Function_PJSIP_ENDPOINT-SeeAlso">See Also</h3>
  138. <h3 id="Asterisk13Function_PJSIP_ENDPOINT-ImportVersion">Import Version</h3>
  139. <p>This documentation was imported from Asterisk Version SVN-branch-13-r420538</p>
  140. </div>
  141. </div> </div>
  142. <div id="footer">
  143. <section class="footer-body">
  144. <p>Document generated by Confluence on Aug 11, 2014 13:47</p>
  145. </section>
  146. </div>
  147. </div> </body>
  148. </html>