- Home
- /
- Article
SIP settings on phones (BroadWorks)
Proper SIP configuration allows your phones to register with a SIP server to make and receive calls. The settings are for the phone in general and for the extensions. This Help article is for Cisco Desk Phone 9800 Series and Cisco Video Phone 8875 registered to Cisco BroadWorks.
Configure SIP settings for the phone
| 1 |
Access the phone administration web page. |
| 2 |
Select . |
| 3 |
Configure the parameters as described in Parameters for phone SIP settings |
| 4 |
Click Submit All Changes. |
Parameters for phone SIP settings
The following parameters are available on the tab on the phone administration web page. See the following tables for the respective parameters:
General parameters
The following table describes the SIP parameters available in the SIP Parameters section.
|
Parameter |
Description |
|---|---|
|
Max Forward |
Specifies SIP Max Forward value. Perform one of the following.
Allowed values: 1 to 255 Default: 70 |
|
Max Redirection |
Specifies number of times an invite can be redirected to avoid an infinite loop. Perform one of the following.
Default: 5 |
|
Max Auth |
Specifies the maximum number of times (from 0 to 255) a request can be challenged. Perform one of the following.
Allowed values: 0 to 255 Default: 2 |
|
SIP User Agent Name |
Used in outbound requests. Perform one of the following.
Default: $VERSION If empty, the header is not included. Macro expansion of $A to $D corresponding to GPP_A to GPP_D allowed |
|
SIP Server Name |
Server header used in responses to inbound responses. Perform one of the following.
Default: $VERSION |
|
SIP Reg User Agent Name |
User-Agent name to be used in a REGISTER request. If this is not specified, the SIP User Agent Name is also used for the REGISTER request. Perform one of the following.
Default: Blank |
|
SIP Accept Language |
Accept-Language the header used. Perform one of the following.
There is no default. If empty, the header is not included. |
|
DTMF Relay MIME Type |
MIME Type used in a SIP INFO message to signal a DTMF event. This field must match that of the Service Provider. Perform one of the following.
Default: application/dtmf-relay |
|
Hook Flash MIME Type |
MIME Type used in a SIPINFO message to signal a hook flash event. Perform one of the following.
Default: application/hook-flash |
|
Remove Last Reg |
Enables you to remove the last registration before registering a new one if the value is different. Set to Yes to remove the last registration. Perform one of the following.
Allowed values: Yes | No Default: No |
|
Use Compact Header |
If set to yes, the phone uses compact SIP headers in outbound SIP messages. If inbound SIP requests contain normal headers, the phone substitutes incoming headers with compact headers. If set to no, the phones use normal SIP headers. If inbound SIP requests contain compact headers, the phones reuse the same compact headers when generating the response, regardless of this setting. Perform one of the following.
Allowed values: Yes | No Default: No |
|
Escape Display Name |
Enables you to keep the Display Name private. Set to Yes if you want the IP phone to enclose the string (configured in the Display Name) in a pair of double quotes for outbound SIP messages. Perform one of the following.
Allowed values: Yes | No Default: No |
|
Talk Package |
Enables support for the BroadSoft Talk Package that lets users answer or resume a call by clicking a button in an external application. Perform one of the following.
Allowed values: Yes | No Default: No |
|
Hold Package |
Enables support for the BroadSoft Hold Package, which lets users place a call on hold by clicking a button in an external application. Perform one of the following.
Allowed values: Yes | No Default: No |
|
Conference Package |
Enables support for the BroadSoft Conference Package that enables users to start a conference call by clicking a button in an external application. Perform one of the following.
Allowed values: Yes | No Default: No |
|
RFC 2543 Call Hold |
If set to yes, unit includes c=0.0.0.0 syntax in SDP when sending a SIP re-INVITE to the peer to hold the call. If set to no, unit will not include the c=0.0.0.0 syntax in the SDP. The unit will always include a=sendonly syntax in the SDP in either case. Perform one of the following.
Allowed values: Yes | No Default: Yes |
|
Random REG CID on Reboot |
If set to yes, the phone uses a different random call-ID for registration after the next software reboot. If set to no, the Cisco IP phone tries to use the same call-ID for registration after the next software reboot. The Cisco IP phone always uses a new random Call-ID for registration after a power-cycle, regardless of this setting. Perform one of the following.
Allowed values: Yes | No Default: No |
|
SIP TCP Port Min |
Specifies the lowest TCP port number that can be used for SIP sessions. Perform one of the following.
Default: 5060 |
|
SIP TCP Port Max |
Specifies the highest TCP port number that can be used for SIP sessions. Perform one of the following.
Default: 5080 |
|
Caller ID Header |
Provides the option to take the caller ID from PAID-RPID-FROM, PAID-FROM, RPID-PAID-FROM, RPID-FROM, or FROM header. Perform one of the following.
Allowed values: PAID-RPID-FROM | AID-FROM | RPID-PAID-FROM | RPID-FROM | FROM Default: PAID-RPID-FROM |
|
Hold Target Before Refer |
Controls whether to hold call leg with transfer target before sending REFER to the transferee when initiating a fully-attended call transfer (where the transfer target has answered). Perform one of the following.
Allowed values: Yes | No Default: No |
|
Dialog SDP Enable |
When enabled and the Notify message body is too big causing fragmentation, the Notify message xml dialog is simplified; Session Description Protocol (SDP) is not included in the dialog xml content. Perform one of the following.
Allowed values: Yes | No Default: No |
|
Keep Referee When Refer Failed |
If set to yes, it configures the phone to immediately handle NOTIFY sipfrag messages. Perform one of the following.
Allowed values: Yes | No Default: No |
|
Display Diversion Info |
Display the Diversion info included in SIP message on LCD or not. Perform one of the following.
Allowed values: Yes | No Default: No |
|
Display Anonymous From Header |
Show the caller ID from the SIP INVITE message “From” header when set to Yes, even if the call is an anonymous call. When the parameter is set to no, the phone displays "Anonymous Caller" as the caller ID. Perform one of the following.
Allowed values: Yes | No Default: No |
|
Sip Accept Encoding |
Supports the content-encoding gzip feature. If gzip is selected, the SIP message header contains the string “Accept-Encoding: gzip”, and the phone is able to process the SIP message body, which is encoded with the gzip format. Perform one of the following.
Allowed values: none and gzip Default: none |
|
SIP IP Preference |
Sets if the phone uses IPv4 or IPv6. Perform one of the following.
Allowed values: IPv4 | IPv6 Default: IPv4 |
|
Disable Local Name To Header |
Controls the display name in “Directory”, “Call History”, and in the “To” header during an outgoing call. Perform one of the following.
Allowed values: Yes | No Default: No |
|
User Preferred OffHook Timer |
Time (in seconds) the phone waits after going off-hook before initiating dialing.
When configured, this setting takes precedent over the Perform one of the following.
Allowed values: 0-30 Default: Empty |
| Share Line Event Package Type |
Enables the dialog-based shared line, so that the phones in the shared line can subscribe to the dialog event package. Perform one of the following.
Allowed values: Call-Info | Dialog Default: Call-Info |
SIP Timer Values
The following table describes the SIP parameters available in the SIP Timer Values section.
|
Parameter |
Description |
|---|---|
|
SIP T1 |
RFC 3261 T1 value (RTT estimate) that can range from 0 to 64 seconds. Perform one of the following:
Default: 0.5 seconds |
|
SIP T2 |
RFC 3261 T2 value (maximum retransmit interval for non-INVITE requests and INVITE responses) that can range from 0 to 64 seconds. Perform one of the following:
Default: 4 seconds |
|
SIP T4 |
RFC 3261 T4 value (maximum duration a message remains in the network), which can range from 0 to 64 seconds. Perform one of the following:
Default: 5 seconds. |
|
SIP Timer B |
INVITE time-out value, which can range from 0 to 64 seconds. Perform one of the following:
Default: 16 seconds. |
|
SIP Timer F |
Non-INVITE time-out value, which can range from 0 to 64 seconds. Perform one of the following:
Default: 16 seconds. |
|
SIP Timer H |
INVITE final response, time-out value, which can from 0 to 64 seconds. Perform one of the following:
Default: 16 seconds. |
|
SIP Timer D |
ACK hang-around time, which can range from 0 to 64 seconds. Perform one of the following:
Default: 16 seconds. |
|
SIP Timer J |
Non-INVITE response hang-around time, which can range from 0 to 64 seconds. Perform one of the following:
Default: 16 seconds. |
|
INVITE Expires |
INVITE request Expires header value. If you enter 0, the Expires header is not included in the request. Ranges from 0 to 2000000. Perform one of the following:
Default: 240 seconds |
|
ReINVITE Expires |
ReINVITE request Expires header value. If you enter 0, the Expires header is not included in the request. Ranges from 0 to 2000000. Perform one of the following:
Default: 30 |
|
Reg Min Expires |
Minimum registration expiration time allowed from the proxy in the Expires header or as a Contact header parameter. If the proxy returns a value less than this setting, the minimum value is used. Perform one of the following:
Default: 1 |
|
Reg Max Expires |
Maximum registration expiration time allowed from the proxy in the Min-Expires header. If the value is larger than this setting, the maximum value is used. Perform one of the following:
Default: 7200 |
|
Reg Retry Intv |
Interval to wait before the Cisco IP Phone retries registration after failing during the last registration. The range is from 1 to 2147483647 Perform one of the following:
Default: 30 See the note below for additional details. |
|
Reg Retry Long Intvl |
When registration fails with a SIP response code that does not match<Retry Reg RSC>, the Cisco IP Phone waits for the specified length of time before retrying. If this interval is 0, the phone stops trying. This value should be much larger than the Reg Retry Intvl value, which should not be 0. Perform one of the following:
Default: 1200 See the note below for additional details. |
|
Reg Retry Random Delay |
Random delay range (in seconds) to add to <Register Retry Intvl> when retrying REGISTER after a failure. Minimum and maximum random delay to be added to the short timer. The range is from 0 to 2147483647. Perform one of the following:
Default: 0 |
|
Reg Retry Long Random Delay |
Random delay range (in seconds) to add to the Register Retry Long Intvl parameter when retrying REGISTER after a failure. Perform one of the following:
Default: 0 |
|
Reg Retry Intvl Cap |
Maximum value of the exponential delay. The maximum value to cap the exponential backoff retry delay (which starts at the Register Retry Intvl and doubles every retry). Defaults to 0, which disables the exponential backoff (that is, the error retry interval is always at the Register Retry Intvl). When this feature is enabled, the Reg Retry Random Delay is added to the exponential backoff delay value. The range is from 0 to 2147483647. Perform one of the following:
Default: 0 |
|
Sub Min Expires |
Sets the lower limit of the REGISTER expires value returned from the Proxy server. Perform one of the following:
Default: 10 |
|
Sub Max Expires |
Sets the upper limit of the REGISTER minexpires value returned from the Proxy server in the Min-Expires header. Perform one of the following:
Default: 7200 |
|
Sub Retry Intvl |
This value (in seconds) determines the retry interval when the last Subscribe request fails. Perform one of the following:
Default: 10 |
The phone can use a RETRY-AFTER value when it is received from a SIP proxy server that is too busy to process a request (503 Service Unavailable message). If the response message includes a RETRY-AFTER header, the phone waits for the specified length of time before to REGISTER again. If a RETRY-AFTER header is not present, the phone waits for the value specified in the Reg Retry Interval or the Reg Retry Long Interval.
Response Status Code Handling
The following table describes the SIP parameters available in the Response Status Code Handling section.
|
Parameter |
Description |
|---|---|
|
Try Backup RSC |
Specifies the SIP response status codes that trigger the phone to fail over and attempt registration with a backup server. For example, you can enter numeric values 500 or a combination of numeric values
plus wild cards if multiple values are possible. For the later, you can use
Perform one of the following:
Default: Empty |
|
Retry Reg RSC |
Specifies the SIP response status codes that trigger the phone to retry registration attempts. For example, you can enter numeric values 500 or a combination of numeric values
plus wild cards if multiple values are possible. For the later, you can use
Perform one of the following:
Default: Empty |
RTP Parameters
The following table describes the SIP parameters available in the RTP Parameters section.
|
Parameter |
Description |
|---|---|
|
RTP Port Min |
Minimum port number for RTP transmission and reception. Perform one of the following:
Allowed values: 2048 to 49151 If the value range (RTP Port Max - RTP Port Min) is less than 16 or you configure the parameter incorrectly, the RTP port range (16382 to 32766) is used instead. Default: 16384 |
|
RTP Port Max |
Maximum port number for RTP transmission and reception. Perform one of the following:
Allowed values: 2048 to 49151 If the value range (RTP Port Max - RTP Port Min) is less than 16 or you configure the parameter incorrectly, the RTP port range (16382 to 32766) is used instead. Default: 16482 |
|
RTP Packet Size |
Specifies the audio packetization interval (in seconds) for RTP voice streams Perform one of the following:
Allowed values: Ranges from 0.01 to 0.13. Valid values must be a multiple of 0.01 seconds. Default: 0.02 |
|
Max RTP ICMP Err |
Number of successive ICMP errors allowed when transmitting RTP packets to the peer before the phone terminates the call. If value is set to 0, the phone ignores the limit on ICMP errors. Perform one of the following:
Allowed values: 0-10 Default: 0 |
|
RTCP Tx Interval |
Interval for sending out RTCP sender reports on an active connection. Perform one of the following:
Allowed values: 0 to 255 seconds Default: 0 |
|
Call Statistics |
Specifies whether the phone sends end-of-call statistics within SIP messages when a call terminates or is put on hold. Perform one of the following:
Allowed values: Yes | No Default: No |
|
SDP IP Preferences |
Select the preferred IP that the phone uses as RTP address. If the phone is in dual-mode and has both ipv4 and ipv6 addresses, it will always include both addresses in SDP by attributes "a=altc … If IPv4 address is selected, then ipv4 address has higher priority than ipv6 address in SDP and indicates that phone prefers using ipv4 RTP address. If the phone has only ipv4 address or ipv6 address, SDP does not have ALTC attributes and RTP address is specified in “c=” line. For information about the behavior in dual mode, see SIP and RTP behaviors in dual mode. Perform one of the following:
Allowed values: IPv4 | IPv6 Default: IPv4 |
|
RTP Before ACK |
Allows you to specify whether an RTP session starts before or after an ACK is received from the calling party.
Perform one of the following:
Allowed values: Yes | No Default: No |
|
SSRC Reset on Rx RE-INVITE |
Controls whether to reset the Synchronization Source (SSRC) for the outgoing RTP and SRTP sessions on incoming RE-INVITE.
Perform one of the following:
Allowed values: Yes | No Default: No |
|
SSRC Reset on Tx RE-INVITE |
Controls whether to reset the Synchronization Source (SSRC) for the outgoing RTP and SRTP sessions on outgoing RE-INVITE.
Perform one of the following:
Allowed values: Yes | No Default: No |
SDP Payload Types
Your Cisco IP Phone supports RFC4733. You can choose from three audio-video transport (AVT) options to send DTMF pulses to the server.
Configured dynamic payloads are used for outbound calls only when the Cisco IP Phone presents a Session Description Protocol (SDP) offer. For inbound calls with an SDP offer, the phone follows the caller’s assigned dynamic payload type.
The Cisco IP Phone uses the configured codec names in outbound SDP. For incoming SDP with standard payload types of 0-95, the phone ignores the codec names. For dynamic payload types, the phone identifies the codec by the configured codec names. The comparison is case-sensitive, so you need to set the name correctly.
The following table describes the SIP parameters available in the SDP Payload Types section.
|
Parameter |
Description |
|---|---|
|
G711u Codec Name |
G711u codec name used in SDP. Perform one of the following:
Default: PCMU |
|
G711a Codec Name |
G711a codec name used in SDP. Perform one of the following:
Default: PCMA |
|
G729a Codec Name |
G729a codec name used in SDP. Perform one of the following:
Default: G729a |
|
G722 Codec Name |
G722 codec name used in SDP. Perform one of the following:
Default: G722 |
|
G722.2 Codec Name |
G722.2 codec name used in SDP. Perform one of the following:
Default: AMR-WB |
|
iLBC Codec Name |
iLBC codec name used in SDP. Perform one of the following:
Default: iLBC |
|
iSAC Codec Name |
iSAC codec name used in SDP. Perform one of the following:
Default: iSAC |
|
OPUS Codec Name |
OPUS codec name used in SDP. Perform one of the following:
Default: OPUS |
|
AVT Codec Name |
AVT codec name used in SDP. Perform one of the following:
Default: telephone-event |
|
G722.2 Dynamic Payload |
G722 Dynamic Payload type. Perform one of the following:
Allowed values: 96-127 Default: 96 |
|
G722.2 OA Dynamic Payload |
G722.2 OA Dynamic Payload type. Perform one of the following:
Allowed values: 96-127 Default: 103 |
|
iLBC 20ms Dynamic Payload |
iLBC 20ms Dynamic Payload type. Perform one of the following:
Allowed values: 96-127 Default: 97 |
|
iLBC 30ms Dynamic Payload |
iLBC 20ms Dynamic Payload type. Perform one of the following:
Allowed values: 96-127 Default: 105 |
|
iSAC Dynamic Payload |
iSAC Dynamic Payload type. Perform one of the following:
Allowed values: 96-127 Default: 98 |
|
OPUS Dynamic Payload |
OPUS Dynamic Payload type. Perform one of the following:
Allowed values: 96-127 Default: 99 |
|
RSFEC Dynamic Payload |
RSFEC Dynamic Payload type. Perform one of the following:
Allowed values: 96-127 Default: 113 |
|
AVT Dynamic Payload |
AVT dynamic payload type. Perform one of the following:
Allowed values: 96-127 Default: 101 |
|
AVT 16kHz Dynamic Payload |
AVT dynamic payload type for the 16 kHz clock rate. Perform one of the following:
Allowed values: 96-127 Default: 101 |
|
AVT 48kHz Dynamic Payload |
AVT dynamic payload type for the 48 kHz clock rate. Perform one of the following:
Allowed values: 96-127 Default: 101 |
|
INFOREQ Dynamic Payload |
INFOREQ Dynamic Payload type. Perform one of the following:
Allowed values: 96-127 Default: 101 |
NAT Support Parameters
For the parameters related to NAT Support, see NAT traversal with phones.
Configure SIP settings for an extension
With the SIP settings per line, you can define how the phone handles SIP signaling, registration, and media for an individual extension.
| 1 |
Access the phone administration web page. |
| 2 |
Select . |
| 3 |
In the SIP Settings section, configure the parameters as described in Parameters for extension SIP settings |
| 4 |
Click Submit All Changes. |
Parameters for extension SIP settings
The following table defines the function and usage of the parameters in the SIP Settings section under the tab in the phone web interface. It also defines the syntax of the string that is added in the phone configuration file with XML(cfg.xml) code to configure a parameter.
|
Parameter |
Description |
|---|---|
|
SIP Transport |
Specifies the transport protocol for SIP messages. When set to AUTO, the phone selects the appropriate protocol automatically, based on the NAPTR records on the DNS server. Perform one of the following:
Allowed values: UDP | TCP | TLS | AUTO Default: UDP |
|
SIP Port |
The phone's port number for SIP message listening and transmission. Specify the port number here only when you are using UDP as the SIP transport protocol. If you are using TCP, the system uses a random port within the range specified in SIP TCP Port Min and SIP TCP Port Max on the tab. If you need to specify a port of SIP proxy server, you can specify it using the Proxy field or the XSI Host Server field. Perform one of the following:
Default: 5060 |
|
SIP 100REL Enable |
Individually enables the SIP 100REL feature. When enabled, the phone supports the 100REL SIP extension for reliable transmission of provisional responses (18x) and uses the PRACK requests. Perform one of the following:
Allowed values: Yes | No Default: No |
|
EXT SIP Port |
The external SIP port number. Perform one of the following:
Allowed values: Default: 5060 |
|
Auth Resync-Reboot |
The Cisco IP Phone authenticates the sender when it receives a NOTIFY message with the following requests:
Perform one of the following:
Allowed values: Yes | No Default: Yes |
|
SIP Proxy-Require |
The SIP proxy can support a specific extension or behavior when it receives the Proxy-Require header from the user agent. If this field is configured and the proxy does not support it, it responds with the message, unsupported. Perform one of the following:
Default: Blank |
|
SIP Remote-Party-ID |
The Remote-Party-ID header to use instead of the From header. Select Yes to enable. Default: Yes |
|
Referor Bye Delay |
Controls when the phone sends BYE to terminate stale call legs upon completion of call transfers. Multiple delay settings (Referor, Refer Target, Referee, and Refer-To Target) are configured on this screen. Perform one of the following:
Allowed values: An integer from 0 through 65535 Default: 4 |
|
Refer-To Target Contact |
Indicates the refer-to target. Perform one of the following:
Allowed values: Yes | No Default: No |
|
Referee Bye Delay |
Specifies the Referee Bye Delay time in seconds. Perform one of the following:
Allowed values: An integer from 0 through 65535 Default: 0 |
|
Refer Target Bye Delay |
Specifies the Refer Target Bye Delay time in seconds. Perform one of the following:
Allowed values: An integer from 0 through 65535 Default: 0 |
|
Sticky 183 |
Controls the first 183 SIP response for an outbound INVITE. To enable this feature, Perform one of the following:
Allowed values: Yes | No Default: No |
|
Auth INVITE |
Controls if authorization is required for initial incoming INVITE requests from the SIP proxy. To enable this feature. Perform one of the following:
Allowed values: Yes | No Default: No |
|
Ntfy Refer On 1xx-To-Inv |
If set to Yes, as a transferee, the phone will send a NOTIFY with Event:Refer to the transferor for any 1xx response returned by the transfer target, on the transfer call leg. If set to No, the phone will only send a NOTIFY for final responses (200 and higher). Perform one of the following:
Allowed values: Yes | No Default: Yes |
|
Set G729 annexb |
Configure G.729 Annex B settings. Perform one of the following:
Allowed values: None | No |Yes | Follow silence supp setting Default: Yes |
|
Use low-bandwidth OPUS |
To improve bandwidth in your network, you can set up your phones to use the narrowband OPUS codec. The narrowband codec won't conflict with the wideband codec. Perform one of the following:
Allowed values: No |Yes Default: No |
|
Voice Quality Report Address |
Specifies the destination where the phone sends diagnostic reports about call quality. You can enter either a domain name or an IP address. You can also add a port number along with the domain name or an IP address for this parameter. If you don't enter a port number, the value of the SIP UDP Port (5060) is used by default. If the collector server URL parameter is blank, a SIP PUBLISH message is not sent out. Perform one of the following:
Default: Empty |
|
Voice Quality Report Interval |
Specifies how often the phone generates and sends voice quality reports to the configured report address. The interval is measured in minutes. Shorter intervals provide more frequent updates for monitoring but may increase reporting traffic, while longer intervals reduce overhead but provide less granularity. The default interval is 0, meaning that no periodic reports will be send. Perform one of the following:
Default: 0 |
| Voice Quality Report Group |
Defines the group identifier used when sending voice quality reports from the phone. This parameter allows multiple phones to be organized under the same reporting group, so that administrators can easily sort, filter, and analyze call quality data. Perform one of the following:
Default: Empty |
|
User Equal Phone |
When a tel URL is converted to a SIP URL and the phone number is represented by the user portion of the URL, the SIP URL includes the optional: user=phone parameter (RFC3261). For example: To: sip:+12325551234@example.com; user=phone Perform one of the following:
Allowed values: Yes | No Default: No |
|
Privacy Header |
Sets user privacy in the SIP message in the trusted network. The privacy header options are:
Perform one of the following:
Allowed values: Disabled | none | header | session | user | id Default: Disabled |
|
P-Early-Media Support |
Controls whether the P-Early-Media header is included in the SIP message for an outgoing call. Perform one of the following:
Allowed values: Yes | No Default: No |
|
SIP SessionID Support |
Enables the use of the SIP Session-ID header (defined in RFC 7989) to uniquely identify an end-to-end communication session. The Session-ID remains the same across call legs, even if the call is transferred, forwarded, or goes through multiple SIP intermediaries. Perform one of the following:
Allowed values: Yes | No Default: Yes |
|
MediaSec Request |
Specifies whether the phone requests the use of Media Security (MediaSec) during SIP call setup. When enabled, the phone includes Perform one of the following:
Allowed values: Yes | No Default: No |
|
MediaSec Over TLS Only |
Controls whether the phone uses Media Security (MediaSec, RFC 3329) only when the SIP signaling is protected with TLS. When enabled, the phone includes MediaSec ( Perform one of the following:
Allowed values: Yes | No Default: No |
|
Precondition Support |
Determines whether the phone includes the precondition tag (defined in RFC 3312) in the Supported header field.
Perform one of the following:
Allowed values: Disabled | Enabled Default: Disabled |
|
Auth Support RFC8760 |
Enables support for the authentication scheme defined in RFC 8760 – Digest Authentication for SIP (SHA-256/512). This standard extends SIP authentication to use stronger, more secure hash functions compared to the older MD5-based digest (RFC 2617). When enabled, the phone supports SHA-256/SHA-512 digest authentication when challenged by the SIP server. When disabled, the phone only supports legacy MD5 digest (RFC 2617) authentication. Perform one of the following:
Allowed values: Yes | No Default: No |
NAT traversal with phones
Network Address Translation (NAT) allows multiple devices to share a single, public, routable, IP address to establish connections over the Internet. NAT is present in many broadband access devices to translate public and private IP addresses. For VoIP to coexist with NAT, NAT traversal is required.
Not all service providers provide NAT traversal. If your service provider does not provide NAT traversal, you have several options:
-
NAT Mapping with Session Border Controller: We recommend that you choose an service provider that supports NAT mapping through a Session Border Controller. With NAT mapping provided by the service provider, you have more choices in selecting a router.
-
NAT Mapping with SIP-ALG Router: NAT mapping can be achieved by using a router that has a SIP Application Layer Gateway (ALG). By using a SIP-ALG router, you have more choices in selecting an service provider.
-
NAT Mapping with a Static IP Address: NAT mapping with an external (public) static IP address can be achieved to ensure interoperability with the service provider. The NAT mechanism used in the router must be symmetric. For more information, see Determine symmetric or asymmetric NAT.
Use NAT mapping only if the service provider network does not provide a Session Border Controller functionality. For more information on how to configure NAT mapping with a static IP, see Configure NAT mapping with the static IP address.
-
NAT Mapping with STUN: If the service provider network does not provide a Session Border Controller functionality and if the other requirements are met, it is possible to use Session Traversal Utilities for NAT (STUN) to discover the NAT mapping. For information on how to configure NAT mapping with STUN, see Configure NAT mapping with STUN.
Configure NAT mapping with the static IP address
Configure the NAT mapping on your phone to ensure interoperability with the service provider.
Before you begin
-
You must have an external (public) IP address that is static.
-
The NAT mechanism used in the router must be symmetric.
| 1 |
Access the phone administration web page. |
| 2 |
Select . |
| 3 |
In the NAT Support Parameters section, configure the parameters as described in Parameters for NAT mapping for static IP address. |
| 4 |
Go to , where n is the extension index. |
| 5 |
In the NAT Settings section, configure the parameters as described in Parameters for NAT Mapping on extensions. |
| 6 |
Click Submit All Changes. |
What to do next
Configure the firewall settings on your router to allow SIP traffic.
Configure NAT mapping with STUN
If the service provider network doesn't provide a Session Border Controller (SBC) and the other requirements are met, Session Traversal Utilities for NAT (STUN) can be used to discover the NAT mapping.
STUN enables applications operating behind an NAT to:
- Detect the presence of NAT in the communication path.
- Obtain the public (mapped) IP address and the port number that the NAT assigns for UDP connections to remote hosts.
The protocol requires a third-party STUN server located on the public side of the NAT, typically the Internet. By exchanging messages with this server, the client learns how the NAT translates its private IP address and ports.
STUN is considered a fallback mechanism and should only be used when other NAT traversal methods are unavailable.
Before you begin
-
The router must use asymmetric NAT. See Determine symmetric or asymmetric NAT.
-
A computer running STUN server software must be available. You can either use a public STUN server or set up your own STUN server.
| 1 |
Access the phone administration web page. |
| 2 |
Select . |
| 3 |
In the NAT Support Parameters section, set the parameters as described in the table of Parameters for NAT mapping with static IP address. |
| 4 |
Set the parameters as described in the table of Parameters for NAT mapping with STUN. |
| 5 |
Click the Ext(n) tab. |
| 6 |
In the NAT Settings section, set the parameters for the specific extension as described in table of Parameters for NAT mapping on extensions. |
| 7 |
Click Submit All Changes. |
What to do next
Configure the firewall settings on your router to allow SIP traffic.
Determine symmetric or asymmetric NAT
STUN does not work on routers with symmetric NAT. With symmetric NAT, IP addresses are mapped from one internal IP address and port to one external, routable destination IP address and port. If another packet is sent from the same source IP address and port to a different destination, a different IP address and port number combination is used. This method is restrictive because an external host can send a packet to a particular port on the internal host only if the internal host first sent a packet from that port to the external host.
This procedure assumes that a syslog server is configured and is ready to receive syslog messages.
Before you begin
Verify that the firewall is not running on your PC. (It can block the syslog port.) By default, the syslog port is 514.
| 1 |
Access the phone administration web page. |
| 2 |
Select and navigate to Optional Network Configuration section. |
| 3 |
Enter the IP address for the Syslog Server, if the port number is anything other than the default, 514. If the default port is used, it is not necessary to include the port number. The address and port number must be reachable from the Cisco IP phone. The port number
appears on the output log file name. If port number isn't specified, the default output
file name is |
| 4 |
Set the Debug Level to Error, Notice, or Debug. |
| 5 |
To capture SIP signaling messages, click the Ext (n) tab and navigate to SIP Settings. Set the SIP Debug Option to Full. |
| 6 |
To collect information about what type of NAT that your router uses, click the tab and navigate to NAT Support Parameters. |
| 7 |
Set STUN Test Enable to Yes. |
| 8 |
Determine the type of NAT by viewing the debug messages in the log file. If the messages indicate that the device is using symmetric NAT, you can't use STUN. |
| 9 |
Click Submit All Changes. |
Parameters for NAT mapping
Parameters for NAT mapping with static IP address
The following table defines the function and usage of NAT mapping with Static IP parameters in the NAT Support Parameters section under the tab in the phone web interface. It also defines the syntax of the string that is added in the phone configuration file with XML(cfg.xml) code to configure a parameter.
| Parameter | Description |
|---|---|
|
Handle VIA received |
Enables or disables the phone to process the received parameter in the VIA header. Perform one of the following:
Allowed values: Yes | No Default: No |
|
Handle VIA rport |
Enables or disables the phone to process the Perform one of the following:
Allowed values: Yes | No Default: No |
|
Insert VIA received |
Enables or disables the phone to insert the Perform one of the following:
Allowed values: Yes | No Default: No |
|
Insert VIA rport |
Enables or disables the phone to add the Perform one of the following:
Allowed values: Yes | No Default: No |
|
Substitute VIA Addr |
Enables the user to use NAT-mapped IP:port values in the VIA header. Perform one of the following:
Allowed values: Yes | No Default: No |
|
Send Resp To Src Port |
Enables to send responses to the request source port instead of the VIA sent-by port. Perform one of the following:
Allowed values: Yes | No Default: No |
|
EXT IP |
External IP address to substitute for the actual IP address of phone in all outgoing SIP messages. If 0.0.0.0 is specified, no IP address substitution is performed. If this parameter is specified, phone assumes this IP address when generating SIP messages and SDP (if NAT Mapping is enabled for that line). Perform one of the following:
Default: Empty |
|
EXT RTP Port Min |
The starting (minimum) port number in the external NAT mapping that the phone should use for RTP traffic. Perform one of the following:
Default: 0 |
|
NAT Keep Alive Intvl |
Interval between NAT-mapping keep alive messages. Perform one of the following:
Allowed values: Numeric ranges from 0 through 65535 Default: 15 |
|
Redirect Keep Alive |
Enable or disable the phone to send keep-alive messages to the redirected server to maintain connectivity when an issue occurs. Perform one of the following:
Allowed values: Yes | No Default: No |
Parameters for NAT mapping on extensions
The following table defines the function and usage of NAT mapping with Static IP parameters in the NAT Support Parameters section under the Voice>Ext tab in the phone web interface. It also defines the syntax of the string that is added in the phone configuration file with XML(cfg.xml) code to configure a parameter.
| Parameter | Description |
|---|---|
|
NAT Mapping Enable |
Controls the use of externally mapped IP addresses and SIP/ RTP ports in SIP messages. Perform one of the following:
Allowed values: Yes | No Default: No |
|
NAT Keep Alive Enable (Optional) |
Enables or disables the phone to send NAT keep alive message periodically to keep the phone’s SIP connection alive through NAT. Perform one of the following:
Allowed values: Yes | No Default: No |
Parameters for NAT mapping with STUN
The following table defines the function and usage of NAT mapping with STUN parameters in the NAT Support Parameters section under the tab in the phone web interface. It also defines the syntax of the string that is added in the phone configuration file with XML(cfg.xml) code to configure a parameter.
|
Parameter |
Description |
|---|---|
|
STUN Enable |
Enables the use of STUN to discover NAT mapping. Perform one of the following:
Allowed values: Yes and No. Default: No |
|
STUN Server |
IP address or fully-qualified domain name of the STUN server to contact for NAT mapping discovery. You can use a public STUN server or set up your own STUN server. Perform one of the following:
Default: Empty |
SIP and RTP behaviors in dual mode
You can control SIP and RTP parameters with SIP IP Preference and SDP IP Preference fields when phone is in dual mode.
SIP IP Preference parameter defines which IP address phone tries first when it is in dual mode.
|
IP Mode |
SIP IP Preference |
Address List from DNS, Priority, Result P1 - First Priority Address P2 - Second Priority Address |
Failover Sequence |
|---|---|---|---|
|
Dual Mode |
IPv4 |
P1- 1.1.1.1, 2009:1:1:1::1 P2 - 2.2.2.2, 2009:2:2:2::2 Result: Phone will send the SIP messages to 1.1.1.1 first. |
1.1.1.1 ->2009:1:1:1:1 -> 2.2.2.2 -> 2009:2:2:2:2 |
|
Dual Mode |
IPv6 |
P1- 1.1.1.1, 2009:1:1:1::1 P2 - 2.2.2.2, 2009:2:2:2::2 Result: Phone will send the SIP messages to 2009:1:1:1::1 first. |
2009:1:1:1:1 -> 1.1.1.1 -> 2009:2:2:2:2 -> 2.2.2.2 |
|
Dual Mode |
IPv4 |
P1- 2009:1:1:1::1 P2 - 2.2.2.2, 2009:2:2:2::2 Result: Phone will send the SIP messages to 2009:1:1:1::1 first. |
2009:1:1:1:1 -> 2.2.2.2 -> 2009:2:2:2:2 |
|
Dual Mode |
IPv6 |
P1- 2009:1:1:1::1 P2 - 2.2.2.2, 2009:2:2:2::2 Result: Phone will send the SIP messages to 1.1.1.1 first. |
2009:1:1:1:1 -> 2009:2:2:2:2 ->2.2.2.2 |
|
IPv4 Only |
IPv4 or IPv6 |
P1 - 1.1.1.1, 2009:1:1:1::1 P2 - 2.2.2.2, 2009:2:2:2::2 Result: Phone will send the SIP messages to 1.1.1.1 first. |
1.1.1.1 -> 2.2.2.2 |
|
IPv6 Only |
IPv4 or IPv6 |
P1 - 1.1.1.1, 2009:1:1:1::1 P2 - 2.2.2.2, 2009:2:2:2::2 Result: Phone will send the SIP messages to 2009:1:1:1::1 first. |
2009:1:1:1:1 -> 2009:2:2:2::2 |
Configure media reliability and quality settings
Media Associated Resource Information (MARI) is a signaling and reporting mechanism — often used in SIP and RTP-based networks — that allows phones and call control servers to exchange media quality information about a call in real time or after the call ends. Enable MARI if you want to monitor or log call quality metric. When enabled, the phone sends statistics about the media stream — such as jitter, packet loss, delay, MOS (Mean Opinion Score), etc. — back to the monitoring system
Forward Error Correction (FEC) is a method used to recover lost RTP packets in real time without retransmission. It works by adding redundant data to the media stream, so if a packet is lost, the receiver can reconstruct it from the redundant information. FEC improves call quality on lossy or unstable networks. When enabled, the phone sends and receives redundant RTP data to protect against packet loss.
| 1 |
Access the phone administration web page. |
| 2 |
Select . |
| 3 |
In the MARI Configuration section, set MARI Enabled and FEC Enabled to Yes to enable the features. By default, these features are disabled. You can also configure the settings using the phone configuration file with XML(cfg.xml) by entering strings in this format:
|
| 4 |
Click Submit All Changes. |