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.
| Name | Type | Description | Attributes |
|---|---|---|---|
| id | xs:string | A read-only unique identifier for this outbound registration assigned by the system on create. | |
| enabled | xs:boolean | Allows you to stop using this registration without deleting the registration information. | Mandatory |
| username | xs:string | 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. | |
| password | xs:string | 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. | |
| address-of-record | xs:string | The AOR with which the system registers (see registration rules in RFC 3261), such as sip:1000@dma.polycom.com. | Mandatory |
| territory-to-perform-registration | TerritoryToPerformRegistration | 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. | Mandatory |
| contact-address-format | ContactAddressFormat | 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. | Mandatory |
| freeformAddress | xs:string | The free form contact address. This is required if contact-address-format is FREE_FORM. | |
| request-uri | xs:string | The Request-URI to include when registering with this SIP peer, specified using the variables (#delimited) defined in Free Form Template Variables. | |
| header | List of Header | 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. |
| Name | Type | Description | Attributes |
|---|---|---|---|
| name | xs:string | Header name. | Mandatory |
| value | xs:string | Header value. | Mandatory |
| Name | Type | Restrictions |
|---|---|---|
| ContactAddressFormat | xs:string | Value must be one of:
|
| TerritoryToPerformRegistration | xs:string | Length of value must be >=1 |