Asterisk-13-Configuration_res_pjsip_outbound_registration_29394801.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 Configuration_res_pjsip_outbound_registration</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_res_pjsip_outbound_registration
  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_res_pjsip_outbound_registration-SIPresourceforoutboundregistrations">SIP resource for outbound registrations</h1>
  37. <p>This configuration documentation is for functionality provided by <code>res_pjsip_outbound_registration</code>.</p>
  38. <h2 id="Asterisk13Configuration_res_pjsip_outbound_registration-Overview">Overview</h2>
  39. <p><strong>Outbound Registration</strong></p>
  40. <p>This module allows <code>res_pjsip</code> to register to other SIP servers.</p>
  41. <h2 id="Asterisk13Configuration_res_pjsip_outbound_registration-pjsip.conf">pjsip.conf</h2>
  42. <h3 id="Asterisk13Configuration_res_pjsip_outbound_registration-registration">registration</h3>
  43. <p>The configuration for outbound registration</p>
  44. <h4 id="Asterisk13Configuration_res_pjsip_outbound_registration-ConfigurationOptionReference">Configuration Option Reference</h4>
  45. <div class="table-wrap"><table class="confluenceTable"><tbody>
  46. <tr>
  47. <th class="confluenceTh"><p> Option Name </p></th>
  48. <th class="confluenceTh"><p> Type </p></th>
  49. <th class="confluenceTh"><p> Default Value </p></th>
  50. <th class="confluenceTh"><p> Regular Expression </p></th>
  51. <th class="confluenceTh"><p> Description </p></th>
  52. </tr>
  53. <tr>
  54. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_pjsip_outbound_registration_29394801.html"><code>auth_rejection_permanent</code></a> </p></td>
  55. <td class="confluenceTd"><p> <code>Boolean</code> </p></td>
  56. <td class="confluenceTd"><p> <code>yes</code> </p></td>
  57. <td class="confluenceTd"><p> <code>false</code> </p></td>
  58. <td class="confluenceTd"><p> Determines whether failed authentication challenges are treated as permanent failures. </p></td>
  59. </tr>
  60. <tr>
  61. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_pjsip_outbound_registration_29394801.html"><code>client_uri</code></a> </p></td>
  62. <td class="confluenceTd"><p> <code>String</code> </p></td>
  63. <td class="confluenceTd"><p> </p></td>
  64. <td class="confluenceTd"><p> <code>false</code> </p></td>
  65. <td class="confluenceTd"><p> Client SIP URI used when attemping outbound registration </p></td>
  66. </tr>
  67. <tr>
  68. <td class="confluenceTd"><p> <code>contact_user</code> </p></td>
  69. <td class="confluenceTd"><p> <code>String</code> </p></td>
  70. <td class="confluenceTd"><p> </p></td>
  71. <td class="confluenceTd"><p> <code>false</code> </p></td>
  72. <td class="confluenceTd"><p> Contact User to use in request </p></td>
  73. </tr>
  74. <tr>
  75. <td class="confluenceTd"><p> <code>expiration</code> </p></td>
  76. <td class="confluenceTd"><p> <code>Unsigned Integer</code> </p></td>
  77. <td class="confluenceTd"><p> <code>3600</code> </p></td>
  78. <td class="confluenceTd"><p> <code>false</code> </p></td>
  79. <td class="confluenceTd"><p> Expiration time for registrations in seconds </p></td>
  80. </tr>
  81. <tr>
  82. <td class="confluenceTd"><p> <code>max_retries</code> </p></td>
  83. <td class="confluenceTd"><p> <code>Unsigned Integer</code> </p></td>
  84. <td class="confluenceTd"><p> <code>10</code> </p></td>
  85. <td class="confluenceTd"><p> <code>false</code> </p></td>
  86. <td class="confluenceTd"><p> Maximum number of registration attempts. </p></td>
  87. </tr>
  88. <tr>
  89. <td class="confluenceTd"><p> <code>outbound_auth</code> </p></td>
  90. <td class="confluenceTd"><p> <code>Custom</code> </p></td>
  91. <td class="confluenceTd"><p> </p></td>
  92. <td class="confluenceTd"><p> <code>false</code> </p></td>
  93. <td class="confluenceTd"><p> Authentication object to be used for outbound registrations. </p></td>
  94. </tr>
  95. <tr>
  96. <td class="confluenceTd"><p> <code>outbound_proxy</code> </p></td>
  97. <td class="confluenceTd"><p> <code>String</code> </p></td>
  98. <td class="confluenceTd"><p> </p></td>
  99. <td class="confluenceTd"><p> <code>false</code> </p></td>
  100. <td class="confluenceTd"><p> Outbound Proxy used to send registrations </p></td>
  101. </tr>
  102. <tr>
  103. <td class="confluenceTd"><p> <code>retry_interval</code> </p></td>
  104. <td class="confluenceTd"><p> <code>Unsigned Integer</code> </p></td>
  105. <td class="confluenceTd"><p> <code>60</code> </p></td>
  106. <td class="confluenceTd"><p> <code>false</code> </p></td>
  107. <td class="confluenceTd"><p> Interval in seconds between retries if outbound registration is unsuccessful </p></td>
  108. </tr>
  109. <tr>
  110. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_pjsip_outbound_registration_29394801.html"><code>forbidden_retry_interval</code></a> </p></td>
  111. <td class="confluenceTd"><p> <code>Unsigned Integer</code> </p></td>
  112. <td class="confluenceTd"><p> <code>0</code> </p></td>
  113. <td class="confluenceTd"><p> <code>false</code> </p></td>
  114. <td class="confluenceTd"><p> Interval used when receiving a 403 Forbidden response. </p></td>
  115. </tr>
  116. <tr>
  117. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_pjsip_outbound_registration_29394801.html"><code>server_uri</code></a> </p></td>
  118. <td class="confluenceTd"><p> <code>String</code> </p></td>
  119. <td class="confluenceTd"><p> </p></td>
  120. <td class="confluenceTd"><p> <code>false</code> </p></td>
  121. <td class="confluenceTd"><p> SIP URI of the server to register against </p></td>
  122. </tr>
  123. <tr>
  124. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_pjsip_outbound_registration_29394801.html"><code>transport</code></a> </p></td>
  125. <td class="confluenceTd"><p> <code>String</code> </p></td>
  126. <td class="confluenceTd"><p> </p></td>
  127. <td class="confluenceTd"><p> <code>false</code> </p></td>
  128. <td class="confluenceTd"><p> Transport used for outbound authentication </p></td>
  129. </tr>
  130. <tr>
  131. <td class="confluenceTd"><p> <code>type</code> </p></td>
  132. <td class="confluenceTd"><p> <code>None</code> </p></td>
  133. <td class="confluenceTd"><p> </p></td>
  134. <td class="confluenceTd"><p> <code>false</code> </p></td>
  135. <td class="confluenceTd"><p> Must be of type 'registration'. </p></td>
  136. </tr>
  137. <tr>
  138. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_pjsip_outbound_registration_29394801.html"><code>support_path</code></a> </p></td>
  139. <td class="confluenceTd"><p> <code>Boolean</code> </p></td>
  140. <td class="confluenceTd"><p> <code>no</code> </p></td>
  141. <td class="confluenceTd"><p> <code>false</code> </p></td>
  142. <td class="confluenceTd"><p> Enables Path support for outbound REGISTER requests. </p></td>
  143. </tr>
  144. </tbody></table></div>
  145. <h4 id="Asterisk13Configuration_res_pjsip_outbound_registration-ConfigurationOptionDescriptions">Configuration Option Descriptions</h4>
  146. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_pjsip_outbound_registration-registration_auth_rejection_permanent"></span></p>
  147. <h5 id="Asterisk13Configuration_res_pjsip_outbound_registration-auth_rejection_permanent">auth_rejection_permanent</h5>
  148. <p>If this option is enabled and an authentication challenge fails, registration will not be attempted again until the configuration is reloaded.</p>
  149. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_pjsip_outbound_registration-registration_client_uri"></span></p>
  150. <h5 id="Asterisk13Configuration_res_pjsip_outbound_registration-client_uri">client_uri</h5>
  151. <p>This is the address-of-record for the outbound registration (i.e. the URI in the To header of the REGISTER).</p>
  152. <p>For registration with an ITSP, the client SIP URI may need to consist of an account name or number and the provider's hostname for their registrar, e.g. client_uri=1234567890@example.com. This may differ between providers.</p>
  153. <p>For registration to generic registrars, the client SIP URI will depend on networking specifics and configuration of the registrar.</p>
  154. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_pjsip_outbound_registration-registration_forbidden_retry_interval"></span></p>
  155. <h5 id="Asterisk13Configuration_res_pjsip_outbound_registration-forbidden_retry_interval">forbidden_retry_interval</h5>
  156. <p>If a 403 Forbidden is received, chan_pjsip will wait <em>forbidden_retry_interval</em> seconds before attempting registration again. If 0 is specified, chan_pjsip will not retry after receiving a 403 Forbidden response. Setting this to a non-zero value goes against a &quot;SHOULD NOT&quot; in RFC3261, but can be used to work around buggy registrars.</p>
  157. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_pjsip_outbound_registration-registration_server_uri"></span></p>
  158. <h5 id="Asterisk13Configuration_res_pjsip_outbound_registration-server_uri">server_uri</h5>
  159. <p>This is the URI at which to find the registrar to send the outbound REGISTER. This URI is used as the request URI of the outbound REGISTER request from Asterisk.</p>
  160. <p>For registration with an ITSP, the setting may often be just the domain of the registrar, e.g. sip:sip.example.com.</p>
  161. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_pjsip_outbound_registration-registration_transport"></span></p>
  162. <h5 id="Asterisk13Configuration_res_pjsip_outbound_registration-transport">transport</h5>
  163. <div class="aui-message hint shadowed information-macro">
  164. <p class="title">Note</p>
  165. <span class="aui-icon icon-hint">Icon</span>
  166. <div class="message-content">
  167. <p>A <em>transport</em> configured in <code>pjsip.conf</code>. As with other <code>res_pjsip</code> modules, this will use the first available transport of the appropriate type if unconfigured.</p>
  168. </div>
  169. </div>
  170. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_pjsip_outbound_registration-registration_support_path"></span></p>
  171. <h5 id="Asterisk13Configuration_res_pjsip_outbound_registration-support_path">support_path</h5>
  172. <p>When this option is enabled, outbound REGISTER requests will advertise support for Path headers so that intervening proxies can add to the Path header as necessary.</p>
  173. <h3 id="Asterisk13Configuration_res_pjsip_outbound_registration-ImportVersion">Import Version</h3>
  174. <p>This documentation was imported from Asterisk Version SVN-branch-13-r420538</p>
  175. </div>
  176. </div> </div>
  177. <div id="footer">
  178. <section class="footer-body">
  179. <p>Document generated by Confluence on Aug 11, 2014 13:49</p>
  180. </section>
  181. </div>
  182. </div> </body>
  183. </html>