<!DOCTYPE html
  PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html xmlns:jxb="http://java.sun.com/xml/ns/jaxb" xmlns:none="http://none"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>PlcmExtSipPeerOutboundRegistration.json</title><meta http-equiv="X-UA-Compatible" content="IE=7"><style type="text/css"><!--@import url("https://staged.poly.com/clariti2/apidocs/3.8.0/representations/book_conversion_apr2012.css");--></style><link rel="stylesheet" type="text/css" href="../css/plcm-wadl-xsd.css"><!--
             [if IE]>
             <STYLE type="text/css">.altova-rotate-left-textbox{filter: progid:DXImageTransform.Microsoft.BasicImage(rotation=3)} .altova-rotate-right-textbox{filter: progid:DXImageTransform.Microsoft.BasicImage(rotation=1)} </STYLE>
             <![endif]
          --><!--[if !IE]><!--><style type="text/css">.altova-rotate-left-textbox{-webkit-transform: rotate(-90deg) translate(-100%, 0%); -webkit-transform-origin: 0% 0%;-moz-transform: rotate(-90deg) translate(-100%, 0%); -moz-transform-origin: 0% 0%;-ms-transform: rotate(-90deg) translate(-100%, 0%); -ms-transform-origin: 0% 0%;}.altova-rotate-right-textbox{-webkit-transform: rotate(90deg) translate(0%, -100%); -webkit-transform-origin: 0% 0%;-moz-transform: rotate(90deg) translate(0%, -100%); -moz-transform-origin: 0% 0%;-ms-transform: rotate(90deg) translate(0%, -100%); -ms-transform-origin: 0% 0%;}</style><!--<![endif]--><style type="text/css">@page { margin-left:0.60in; margin-right:0.60in; margin-top:0.79in; margin-bottom:0.79in } @media print { br.altova-page-break { page-break-before: always; } }</style></head><body><h1><span>PlcmExtSipPeerOutboundRegistration</span></h1><dl style="margin-left: 18.000pt;"><dt><span><a name="plcm-ext-sip-peer-outbound-registration" href="plcm-ext-sip-peer-outbound-registration.json.htm#PlcmExtSipPeerOutboundRegistration">PlcmExtSipPeerOutboundRegistration</a></span></dt><dd><p>
        Some external SIP peers require peers to register with them 
        as an endpoint does, using a REGISTER message (also known as pilot 
        registration). You can add outbound registration configurations that 
        the system can use to register with the SIP peer that you’re adding 
        or editing, following the rules specified in RFC 3261.
      </p></dd></dl><hr><h4><a name="PlcmExtSipPeerOutboundRegistration"><span>PlcmExtSipPeerOutboundRegistration Fields</span></a></h4><table style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; " rules="all"><thead style="background-color:#ccc; "><tr bgcolor="#d2d2d2"><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>Name</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Type</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><span>Description</span></th><th style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Attributes</span></th></tr></thead><tbody><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>id</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
              A read-only unique identifier for this outbound 
              registration assigned by the system on create.
            </td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>enabled</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>boolean</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
              Allows you to stop using this registration without 
              deleting the registration information.
            </td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Mandatory</span></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>username</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
              The user name to use for the authentication credentials 
              if the external peer challenges the registration request. 
              Note: The authentication credentials specified here are specific 
              to this SIP peer and are not tied to any other authentication 
              configuration values.
            </td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>password</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
              Passwords are set on Create and may be updated in Update. 
              Passwords are never sent in responses. A missing password element 
              on update of an existing Registration means to leave the password 
              for that Registration unchanged. A password element with no text
              content on update of an existing Registration means to set that
              password to an empty string.
            </td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>addressOfRecord</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
              The AOR with which the system registers (see registration 
              rules in RFC 3261), such as sip:1000@dma.polycom.com.
            </td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Mandatory</span></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>territoryToPerformRegistration</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-ext-sip-peer-outbound-registration.json.htm#TerritoryToPerformRegistration">TerritoryToPerformRegistration</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
              Responsibility for registering must be assigned to a 
              territory, thus making the primary or backup DMA cluster for 
              the territory responsible, depending on which is active. Valid
              values may be obtained by querying the DMA Territories API.
            </td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Mandatory</span></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>contactAddressFormat</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-ext-sip-peer-outbound-registration.json.htm#ContactAddressFormat">ContactAddressFormat</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
              Specify IP or DNS to specify that the contact header 
              should use the virtual IP address or virtual DNS name of the 
              cluster currently managing the territory. If the territory 
              responsibility switches to the other cluster, it re-sends the 
              registration using its IP address or DNS name. Select Free Form 
              to specify that the contact header should use the FQDN you enter. 
              This contact header is mandatory if FREE_FORM is specified.
              The external peer must be able to resolve this FQDN.
            </td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Mandatory</span></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>freeformAddress</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
              The free form contact address. This is required if 
              contact-address-format is FREE_FORM.
            </td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>requestUri</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
              The Request-URI to include when registering with this 
              SIP peer, specified using the variables (#delimited) defined in 
              Free Form Template Variables.
            </td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>header</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Array of </span><a href="plcm-ext-sip-peer-outbound-registration.json.htm#Header">Header</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
              Additional headers to include when registering with this SIP peer.
              Click Add to add a header. In the Add Header dialog box, specify the header 
              name and value(s), using the variables (#delimited) defined in Free Form 
              Template Variables. Click Edit or Delete to edit or delete the selected 
              header.
            </td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr></tbody></table><br><h4><a name="Header"><span>Header Fields</span></a></h4><table style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; " rules="all"><thead style="background-color:#ccc; "><tr bgcolor="#d2d2d2"><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>Name</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Type</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><span>Description</span></th><th style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Attributes</span></th></tr></thead><tbody><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>name</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
              Header name.
            </td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Mandatory</span></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>value</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
              Header value.
            </td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Mandatory</span></td></tr></tbody></table><br><hr><h3><span>Nested Types/Restrictions</span></h3><br><table style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; " rules="all"><thead><tr bgcolor="#d2d2d2"><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>Name</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Type</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><span>Restrictions</span></th></tr></thead><tbody><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><a name="ContactAddressFormat"><span>ContactAddressFormat</span></a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><br><span>Value must be one of:</span><ul><li><span style="top:auto; vertical-align:top;">IP</span></li><li><span style="top:auto; vertical-align:top;">DNS</span></li><li><span style="top:auto; vertical-align:top;">FREE_FORM</span></li></ul></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><a name="TerritoryToPerformRegistration"><span>TerritoryToPerformRegistration</span></a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><br><span>Length of value must be &gt;=</span><span>1</span></td></tr></tbody></table></body></html>