Configuring Customized SIP Response Codes

The Custom SIP Reason Codes table lets you configure up to 100 customized SIP response codes--both standard and non-standard--along with their corresponding textual descriptions. These codes may appear in the Request-URI and/or the Reason header of the incoming SIP response message.

For incoming unknown or non-standard response codes (e.g., 452 "Block transfer"), you can add them to the table so that the device recognizes and preserves (forwards) them in the outgoing leg. This is useful for interoperability with third-party systems that use proprietary or non-standard SIP response codes.

For standard SIP response codes, you can customize their accompanying text description. For example, an incoming 200 "OK" can be customized and forwarded to the other leg as 200 "Connected successfully".

Below is an example of a non-standard SIP response code, shown in the Request-URI and the Reason header:

SIP/2.0 452 Block transfer
Via: SIP/2.0/TCP 10.1.1.1:5060;alias;branch=z9hG4;rport=529;received=10.2.2.2
From: <sip:4011111@acme.com>;tag=1abcd12345
To: <sip:sue@example.com:5070>;tag=12245abcd.1234aa56
Call-ID: 12345678@10.1.1.1
CSeq: 1 REFER
Content-Length: 0
Reason: SIP ;cause=452 ;text=”Block transfer”

If the device receives an unknown SIP response code that is not listed in this table, it automatically converts it into the nearest standard response code (x00). For example, if the device receives a 452 response, it converts it into the standard 200 (OK) response code.

The following procedure describes how to configure custom SIP response codes through the Web interface. You can also configure it through ini file [CustomSIPReasonCodes] or CLI (configure voip > sip-definition cust-sip-reason-codes).

➢ To configure custom SIP reason codes:
1. Open the Custom SIP Reason Codes table (Setup menu > Signaling & Media tab > SIP Definitions folder > Custom SIP Reason Codes).
2. Click New; the following dialog box appears:

3. Configure a custom response code according to the parameters described in the table below, and then click Apply.

Custom SIP Reason Codes Table Parameter Descriptions

Parameter

Description

'Index'

[Index]

Defines an index number for the new table row.

Note: Each row must be configured with a unique index.

'SIP Response Code'

sip-reason-code

[SIPReasonCode]

Defines the SIP response code.

The valid value is a number between 100 and 699.

'Reason Text'

reason-text

[ReasonText]

Defines a textual description for the SIP response code.

The valid value is a string of up to 100 characters.