Guest

Cisco PGW 2200 Softswitch

SIP Service Enhancements

  • Viewing Options

  • PDF (394.4 KB)
  • Feedback
SIP Service Enhancements

Table Of Contents

SIP Service Enhancements

Feature Overview

Benefits

Related Documents

Supported Platforms

Supported Standards, MIBs, and RFCs

Provisioning Tasks

Provisioning Procedures

Provisioning Basics

Modifying Session Timers

Adding a SIP Profile

Reference Information

Properties

Cause Codes

ISUP Cause Code to SIP Status Code Mapping

ISUP Event Code to SIP Status Code Mapping

SIP Status Code to ISUP Message Mapping

SIP Status Code to ISDN Cause Code Mapping

Internal Cause Code to SIP Status Code Mapping

SIP Status Code to Internal Cause Code Mapping

Obtaining Documentation

Cisco.com

Documentation CD-ROM

Ordering Documentation

Documentation Feedback

Obtaining Technical Assistance

Cisco TAC Website

Opening a TAC Case

TAC Case Priority Definitions

Obtaining Additional Publications and Information

Glossary


SIP Service Enhancements


Document Release History

Publication Date
Comments

October 21, 2003

Initial version of the document.


Feature History

Release
Modification

9.4(1)

Feature is introduced in this release of the Cisco Media Gateway Controller (MGC) software


The Session Initiation Protocol (SIP) Service Enhancements feature adds new SIP service functionality to the Cisco MGC software.

This feature is described in the following sections:

Feature Overview

Supported Platforms

Supported Standards, MIBs, and RFCs

Provisioning Tasks

Reference Information

Obtaining Documentation

Obtaining Technical Assistance

Obtaining Additional Publications and Information

Glossary

Feature Overview

This feature enhances the SIP services currently available in the Cisco MGC software. The new and modified SIP services are as follows:

Updated support of the Session timer—Enables support of draft 10 of the Session timer, and is backward-compatible to draft 4.

Support of the REFER method. The Replaces header in the REFER method is not supported.

Updated the SIP-ISUP Cause Code mapping—Enables MGC software to follow sections 7 and 8 of the ISUP-to-SIP Mapping RFC (RFC 3398).

Support of privacy for the SIP Diversion Header—Enables mapping of the privacy tag to the redirection number in outgoing signaling messages, specifically in the outgoing ISUP IAM message. The privacy token has the fields full and off (privacy=[full|off]).

Support for the Remote-Party-ID header and P-Asserted-Identity header—The present SIP implementation always derives the calling party number from the user name field of From header. But if P-Asserted-Identity header or Remote-Party-ID header is present in an incoming SIP INVITE message the user name should be derived from those headers.

Updates display-name field settings—Current SIP implementation sets the display-name field of the From/Contact headers to Anonymous when the calling party number is unavailable. This feature enables the display-name to be set to Anonymous only when the presentation is restricted from the ISUP side of the call. The MGC now sets the display-name field to Unknown when the calling party number is not available from the other half of the call.

Support of the UPDATE method (session renewal).

Update of Unsolicited NOTIFY method—Enhanced to support transporting of Message Waiting Indicator (MWI) strings. This enhancement support the following interworking scenarios:

SIP Unsolicited NOTIFY/MWI to QSIG MWI

SIP Unsolicited NOTIFY/MWI to DPNSS MWI

Benefits

This feature has the following benefit:

Ensures that the MGC SIP implementation is current

This feature enhances the existing MGC SIP implementation with additional and up-to-date versions of various methods.

Related Documents

This document contains information that is related strictly to this feature. The documents that contain additional information related to the Cisco Media Gateway Controller (MGC) are listed below:

Release notes for Cisco Media Gateway Controller Software Release 9.4(1)

Cisco Media Gateway Controller Hardware Installation Guide

Regulatory Compliance and Safety Information for the Cisco Media Gateway Controller

Cisco Media Gateway Controller Software Release 9 Installation and Configuration Guide

Cisco Media Gateway Controller Software Release 9 Provisioning Guide

Cisco Media Gateway Controller Software Release 9 Dial Plan Guide

Cisco Media Gateway Controller Software Release 9 MML Command Reference Guide

Cisco Media Gateway Controller Software Release 9 Messages Reference Guide

Cisco Media Gateway Controller Software Release 9 Billing Interface Guide

Cisco Media Gateway Controller Software Release 9 MIB Guide

Cisco Media Gateway Controller Software Release 9 Operations, Maintenance, and Troubleshooting Guide

Supported Platforms

The hardware platforms supported for the Cisco MGC software are described in the Release Notes for Cisco Media Gateway Controller Software Release 9.4(1).

Supported Standards, MIBs, and RFCs

The following new or modified standards, MIBs, or RFCs are supported by this feature.

Standards

No new or modified standards are supported by this feature.

MIBs

No new or modified MIBs are supported by this feature. For more information on the MIBs used in the Cisco MGC software, refer to the Cisco Media Gateway Controller Release 9 MIB Guide.

RFCs

This feature supports the following RFCs:

RFC 3398—Integrated Services Digital Network (ISDN) User Part (ISUP) to SIP Mapping

RFC 3311—SIP UPDATE Method

This feature supports the following IETF drafts:

Session Timer Draft version 10 (http://www.ietf.org/internet-drafts/draft-ietf-sip-session-timer-10.txt)

REFER Method Draft version 7 (http://www.ietf.org/internet-drafts/draft-ietf-sip-refer-07.txt)

SIP Call Control - Transfer Draft version 1 (http://www.ietf.org/internet-drafts/draft-ietf-sipping-cc-transfer-01.txt)

Provisioning Tasks

This section provides provisioning information for this feature. Additional examples of provisioning for the Cisco MGC software can be found in the Cisco Media Gateway Controller Software Release 9 Provisioning Guide.

The provisioning information appears in the following sections:

Provisioning Procedures

Provisioning Procedures

This section contains the procedures necessary for provisioning this feature. This section covers the following topics:

Provisioning Basics

Modifying Session Timers

Adding a SIP Profile

Provisioning Basics

The procedures in this section describe how to start a provisioning session and how to save and activate the changes you have made.

Starting a Provisioning Session

Saving and Activating your Provisioning Changes

Ending a Provisioning Session Without Activating your Changes

Retrieving Provisioning Data

For more detailed information about provisioning your Cisco MGC, refer to the Cisco Media Gateway Controller Software Release 9 Provisioning Guide.

Starting a Provisioning Session

You may need to start a provisioning session as part of your system operations. To do this, log into the active Cisco MGC, start an MML session, and enter the following command:

prov-sta::srcver="curr_ver",dstver="mod_ver"

Where:

curr_ver—The name of the current configuration version. In place of the name of the current configuration version, you can also enter:

new—A new default session configuration; no existing source configuration is available.

active—Selects the active configuration as the source for configuration changes.


Note If you do not know the name of your current configuration session, you can use the procedure in the "Retrieving Data on the Current Provisioning Session" section.


mod_ver—A new configuration version name that contains your provisioning changes.

For example, to use a configuration version called ver1 as the basis for a version to be called ver2, you would enter the following command:

prov-sta::srcver="ver1",dstver="ver2"

Once a provisioning session is underway, you may use the prov-add, prov-ed, or prov-dlt MML commands to add, modify, and delete components on your system. This document describes how to provision this feature. For more information on provisioning other components on your Cisco MGC, refer to the Cisco Media Gateway Controller Software Release 9 Provisioning Guide.

There are two ways to close your provisioning session: saving and activating your provisioning changes, as described in the "Saving and Activating your Provisioning Changes" section or ending your provisioning session without saving and activating your changes, as described in the "Ending a Provisioning Session Without Activating your Changes" section.

Saving and Activating your Provisioning Changes

When you have completed making provisioning changes in your session, you must enter a command to save and activate your changes. There are two different provisioning MML commands that do this: prov-cpy and prov-dply.


Caution Using the prov-cpy and prov-dply MML commands can severely impact your system's call processing performance, depending on the extent of your provisioning changes. We recommend that these commands be issued during a maintenance window when traffic is minimal.

The prov-cpy MML command is used to save and activate your changes on simplex Cisco MGC (single host) systems.


Note When you enter the prov-cpy command, your provisioning session is also automatically ended. If you want to make additional provisioning changes, you must start a new provisioning session as described in the "Starting a Provisioning Session" section.



Caution Do not use the prov-cpy command to save and activate your changes on a continuous-service Cisco MGC (active and standby hosts) system. Saving and activating using prov-cpy on such a system would require using the prov-sync MML command to synchronize the provisioning data on the active and standby hosts. The system does not indicate when the synchronization process fails, which would create problems when a switchover operation occurs.

The prov-dply MML command is used to save and activate your changes on the active and standby
Cisco MGCs in a continuous-service system. This command should not be used on a Cisco MGC in a simplex configuration.


Note When you enter the prov-dply command, your provisioning session is also automatically ended, unless an error occurs during execution. If you want to make additional provisioning changes, you must start a new provisioning session as described in the "Starting a Provisioning Session" section.


Ending a Provisioning Session Without Activating your Changes

You may find that you want to end a provisioning session without saving and activating the changes you have entered during your session. If this is the case, you can enter the prov-stp MML command. This command ends your current provisioning session and your changes are not entered.

Retrieving Provisioning Data

You can use the prov-rtrv MML command to retrieve information about your current provisioning settings. The ways in which you can use this command to retrieve provisioning data are described in the following sections:

Retrieving Data for an Individual Component

Retrieving Data for All Components

Retrieving Data for All Components of a Particular Type

Retrieving Data on the Current Provisioning Session

Retrieving Data on Supported Signaling Protocols

Retrieving Data for an Individual Component

You can retrieve provisioning data on any individual component on your system. To do this, log in to the active Cisco MGC, start an MML session, and enter the following command:

prov-rtrv:component:name=MML_name

Where:

component—The MML component type associated with the desired component. You can find a complete list of MML component types in the Cisco Media Gateway Controller Software Release 9 Provisioning Guide.

MML_name—The MML name for the desired component. You can determine the MML names for the various components using the prov-rtrv:all MML command.

For example, to view the provisioning data for a SS7 signaling service called ss7svc1, you would enter the following command:

prov-rtrv:ss7path:name="ss7svc1"

The response to the command is dependent upon the component type associated with the desired component. For example, to view the properties for an SUA routing key called suakey1, you would enter the following command:

prov-rtrv:suakey:name="suakey1"

Retrieving Data for All Components

You can retrieve data on all of the components provisioned on your system. To do this, log in to the active Cisco MGC, start an MML session, and enter the following command:

prov-rtrv:all

Retrieving Data for All Components of a Particular Type

You can retrieve provisioning data on all components of a particular type on your system. To do this, log in to the active Cisco MGC, start an MML session, and enter the following command:

prov-rtrv:component:"all"

Where: component is the MML component type associated with the desired component group. You can find a complete list of MML component types in the Cisco Media Gateway Controller Software Release 9 Provisioning Guide.

For example, to view the provisioning data for all SS7 signaling services, you would enter the following command:

prov-rtrv:ss7path:"all"

Retrieving Data on the Current Provisioning Session

You can retrieve provisioning data on the current provisioning session. To do this, log in to the active Cisco MGC, start an MML session, and enter the following command:

prov-rtrv:session

The system returns a response similar to the following:

MGC-02 - Media Gateway Controller 2003-01-13 13:39:19
M  RTRV
   "session=jtest:session"
   /*
Session ID = mml1
SRCVER = active
DSTVER = jtest
   */

Retrieving Data on Supported Signaling Protocols

You can retrieve protocol data for the current provisioning session. To do this, log in to the active Cisco MGC, start an MML session, and enter the following command:

prov-rtrv:variants

Modifying Session Timers

The procedures for modifying the Session Timers are in the following sections:

Modifying Session Timer for Incoming SIP Trunk Groups

Modifying Session Timer for Outgoing SIP Trunk Groups

Modifying Session Timer for Incoming SIP Trunk Groups

Use the following steps to modify the session timer for an incoming SIP trunk group:


Step 1 Start a provisioning session as described in the "Starting a Provisioning Session" section.

Step 2 Modify the session timer for an incoming SIP trunk group with the following command:

mml> prov-ed:trnkgrpprop:name="trnkgrpnum", InSessionTimer="timerval"

Where:

trnkgrpnum—Number identifying a previously provisioned SIP trunk group.

timerval—Maximum amount of session time, in milliseconds, allowed for a call routed through an incoming SIP trunk group.

For example, to modify the session timer for an incoming SIP trunk group called 3333, you would enter the following command:

mml> prov-ed:trnkgrpprop:name="3333", InSessionTimer="26000"

Step 3 If there are no other components that you need to provision, end your provisioning session as described in the "Saving and Activating your Provisioning Changes" section.


Modifying Session Timer for Outgoing SIP Trunk Groups

Use the following steps to modify the session timer for an outgoing SIP trunk group:


Step 1 Start a provisioning session as described in the "Starting a Provisioning Session" section.

Step 2 Modify the session timer for an outgoing SIP trunk group with the following command:

mml> prov-ed:trnkgrpprop:name="trnkgrpnum", OutSessionTimer="timerval"

Where:

trnkgrpnum—Number identifying a previously provisioned SIP trunk group.

timerval—Maximum amount of session time, in milliseconds, allowed for a call routed through an outgoing SIP trunk group.

For example, to modify the session timer for an outgoing SIP trunk group called 3333, you would enter the following command:

mml> prov-ed:trnkgrpprop:name="3333", OutSessionTimer="26000"

Step 3 If there are no other components that you need to provision, end your provisioning session as described in the "Saving and Activating your Provisioning Changes" section.


Adding a SIP Profile


Note Adding a SIP profile is not necessary to enable this feature. However, this feature does impact the manner in which the calling party number is derived. This is described below in Table 1.


To add a SIP profile, perform the following steps:


Step 1 Start a provisioning session as described in the "Starting a Provisioning Session" section.

Step 2 Create a SIP trunk group and set its basic properties using the following commands:

mml>prov-add:trnkgrp:name="trnkgrpnum", svc="sip-sigpath", type="IP_SIP"
mml>prov-add:trnkgrpprop:name="trnkgrpnum", custgrpid="num", MGCdomain="addr"

Where:

trnkgrpnum—Number identifying a SIP trunk group.

num—Number identifying the customer group associated with this SIP trunk group.

addr—IP address for the associated SIP element destination.

For example to create a SIP trunk group called 378 and establish its basic properties, you would enter the following commands:

mml>prov-add:trnkgrp:name="378", svc="sip-sigpath", type="IP_SIP"
mml>prov-add:trnkgrpprop:name="378", custgrpid="1111", MGCdomain="172.22.121.191"

Step 3 Create a SIP profile and associate it with a SIP trunk group using the following commands:

mml>prov-add:profile:name="profname", type="grprofile", cgpnInclude="x"
mml>prov-add:trnkgrpprof:name="trnkgrpnum", grprofile="profname"

Where:

profname—Name of the SIP profile to be associated with the SIP trunk group.

x—Indicates whether the calling party number should be included as part of the outgoing data. Valid values:

0—Do not include the calling party number

1—Include the calling party number

trnkgrpnum—Number identifying a previously provisioned SIP trunk group.


Note For software Revision 9.2(2) and above, to suppress the Calling Line Identification (CLID) in a SIP environment, set the cgpnInclude trunk group property to 0. See Table 1 for a matrix of CLID suppression values based upon the incoming PSTN signaling settings for a SIP terminated call through a SIP trunk group.


Table 1 CLID Suppression in a SIP Environment

cgpnInclude Value (of terminating/outgoing SIP trunk group)
Received CLI
(in IAM)
Received CLIR
(in IAM)
Outgoing header
Displayname field
Outgoing header
Username field

Not applicable

Not available

Not available

Unknown

Unknown

0 (do not include)

Available

0 (no restriction)

CLID (or presentation number, if present for the ISUP variant)

CLID

0 (do not include)

Available

1 (restriction)

Anonymous

Anonymous

1 (include)

Available

0 (no restriction)

CLID (or presentation number, if present for the ISUP variant)

CLID

1 (include)

Available

1 (restriction)

Anonymous (or presentation number, if present for the ISUP variant)

CLID


For example, to add a SIP profile to suppress CLI on a SIP trunk group called 378, you would enter the following commands:

mml>prov-add:profile:name="sip-profile", type="grprofile", cgpnInclude="0"
mml>prov-add:trnkgrpprof:name="378", grprofile="sip-profile"

Step 4 If there are no other components that you need to provision, end your provisioning session as described in the "Saving and Activating your Provisioning Changes" section.


Reference Information

The following sections contain reference material related to this feature. Information is included on the following areas:

Properties

Cause Codes

Properties

The properties in this section are used for this feature. For information on other properties for the Cisco MGC software, refer to the Cisco Media Gateway Controller Software Release 9 Provisioning Guide.

The parent objects for the properties involved in this feature are found in Table 2.

Table 2 Software Properties Related to this Feature

Property Name
Parent Object
AVM
DPNSS
EISUP
IOCC
ISDNPRI
MGCP
RLM
SESSION
SGCP
SS7-ANSI
SS7-China
SS7-ITU
SS7-Japan
SS7-UK
TALI-IOCC
TCAPOverIP
TrunkGroup
VSI

InSessionTimer

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

X

 

OutSessionTimer

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

X

 


The properties used for this feature are described in Table 3.


Note The two properties listed below are existing properties whose definition was modified for this feature. The valid values and default values have not changed.


Table 3 Properties 

Property
Definition

InSessionTimer

The minimum session interval time (in milliseconds) allowed for a SIP call. When used in an INVITE or UPDATE request, it indicates the smallest value of the session interval that a call can be extended. This value may require being increased to reduce performance impact. Valid range: any value greater than 0.

Valid Values: any integer value greater than 0.

Default Value: 1800000

OutSessionTimer

The amount of session interval time (in milliseconds) at which an element considers a session timed out, if no successful session refresh transaction occurs beforehand. This value may require being increased to reduce performance impact.

Valid Values: any integer value greater than 0.

Default Value: 1800000


Cause Codes

The cause codes in this section are added for this feature. For information on other cause and location codes for the Cisco MGC software, refer to the Cisco Media Gateway Controller Software Release x Dial Plan Guide. The new cause codes can be found in the following sections:

ISUP Cause Code to SIP Status Code Mapping

ISUP Event Code to SIP Status Code Mapping

SIP Status Code to ISUP Message Mapping

Internal Cause Code to SIP Status Code Mapping

SIP Status Code to Internal Cause Code Mapping

ISUP Cause Code to SIP Status Code Mapping

Table 4 provides received ISUP cause codes and the corresponding SIP status code.

Table 4 ISUP Cause Code to SIP Status Code Mapping  

ITU ISUP
ANSI ISUP
Q.931
SIP response

1 unallocated number

1 unallocated number

1 unallocated number

404 Not found

2 No route to network

2 No route to network

2 No route to network

404 Not found

3 no route to destination

3 no route to destination

3 no route to destination

404 Not found

4 send special information tone

4 send special information tone

4 send special information tone

500 Server internal error

5 Misdialled trunk prefix

-

5 Misdialled trunk prefix

500 Server internal error

-

-

6 Channel Unacceptable

500 Server internal error

-

-

7 Call awarded

500 Server internal error

8 Preemption

8 Preemption

8 Preemption

500 Server internal error

9 Preemption - Circuit Reserved

9 Preemption - Circuit Reserved

-

500 Server internal error

16 normal call clearing

16 normal call clearing

16 normal call clearing

BYE or CANCEL

17 user busy

17 user busy

17 user busy

486 Busy here

18 no user responding

18 no user responding

18 no user responding

408 Request Timeout

19 no answer from the user

19 no answer from the user

19 no answer from the user

480 Temporarily unavailable

20 Subscriber absent

20 Subscriber absent

20 Subscriber absent

480 Temporarily unavailable

21 call rejected

21 call rejected

21 call rejected

603 Decline, if the cause location is user. Otherwise, response is 403 Forbidden

22 number changed (without diagnostic)

22 number changed (without diagnostic)

22 number changed (without diagnostic)

410 Gone

22 number changed (with diagnostic)

22 number changed (with diagnostic)

22 number changed (with diagnostic)

301 Moved Permanently

23 redirection to new destination

23 Unallocated destination number

23 redirection to new destination

410 Gone

-

24 Undefined business group

-

500 Server internal error

-

25 Exchange routing error

-

500 Server internal error

26 Non-selected user clearing

26 Non-selected user clearing (Overloaded to signify misrouted ported number, indicates that a number portability dip should have been performed by a prior network. Otherwise, this cause is not typically used.)

26 Non-selected user clearing

404 Not found

27 destination out of order

27 destination out of order

27 destination out of order

502 Bad Gateway

28 address incomplete

28 address incomplete

28 address incomplete

484 Address incomplete

29 facility rejected

29 facility rejected

29 facility rejected

501 Not implemented

-

-

30 Response to STAUS ENQUIRY

500 Server internal error

31 normal unspecified

31 normal unspecified

31 normal unspecified

480 Temporarily unavailable

34 no circuit available

34 no circuit available

34 no circuit available

503 Service unavailable

38 network out of order

38 network out of order

38 network out of order

503 Service unavailable

-

-

39 Frame mode OOS

500 Server internal error

-

-

40 Frame mode operational

500 Server internal error

41 temporary failure

41 temporary failure

41 temporary failure

503 Service unavailable

42 switching equipment congestion

42 switching equipment congestion

42 switching equipment congestion

503 Service unavailable

43 Access information discarded

43 Access information discarded

43 Access information discarded

500 Server internal error

44 requested channel not available

44 requested channel not available

44 requested channel not available

500 Server internal error

-

45 Preemption

-

500 Server internal error

46 Precedence call blocked

46 Precedence call blocked

46 Precedence call blocked

500 Server internal error

47 resource unavailable

47 resource unavailable

47 resource unavailable

503 Service unavailable

-

-

49 QoS not available

500 Server internal error

50 Requested Facility Not Subscribed

50 Requested Facility Not Subscribed

50 Requested Facility Not Subscribed

500 Server internal error

-

51 Call type incompatible with service request

-

500 Server internal error

53 Outgoing calls barred within CUG

-

53 Outgoing calls barred within CUG

500 Server internal error

-

54 Call blocked due to group restrictions

-

500 Server internal error

55 incoming calls barred within CUG

-

55 incoming calls barred within CUG

403 Forbidden

57 bearer capability not authorized

57 bearer capability not authorized

57 bearer capability not authorized

403 Forbidden

58 bearer capability not presently

58 bearer capability not presently

58 bearer capability not presently

503 Service unavailable

62 Inconsistency

62 Inconsistency

62 Inconsistency

500 Server internal error

63 service/option not available

63 service/option not available

63 service/option not available

500 Server internal error

65 Bearer capability not implemented

65 Bearer capability not implemented

65 Bearer capability not implemented

488 Not Acceptable Here

-

-

66 Channel type not implemented

500 Server internal error

69 Requested facility not implemented

69 Requested facility not implemented

69 Requested facility not implemented

500 Server internal error

70 Only restricted digital information capability available

70 Only restricted digital information capability available

70 Only restricted digital information capability available

488 Not Acceptable Here

79 Service or option not implemented

79 Service or option not implemented

79 Service or option not implemented

501 Not implemented

-

-

81 Invalid call reference

500 Server internal error

-

-

82 Identified channel does not exist

500 Server internal error

-

-

83 Suspended call exists

500 Server internal error

-

-

84 Call identity in use

500 Server internal error

-

-

85 No call suspended

500 Server internal error

-

-

86 Call has been cleared

500 Server internal error

87 User not member of CUG

-

87 User not member of CUG

403 Forbidden

88 Incompatible destination

88 Incompatible destination

88 Incompatible destination

503 Service unavailable

90 Non-existent CUG

-

90 Non-existent CUG

500 Server internal error

91 Invalid transit network selection

91 Invalid transit network selection

91 Invalid transit network selection

500 Server internal error

95 Invalid message

95 Invalid message

95 Invalid message

500 Server internal error

-

-

96 IE missing

500 Server internal error

97 Message type non-existent

97 Message type non-existent

97 Message type non-existent

500 Server internal error

-

-

98 Incompatible message type

500 Server internal error

99 Parameter non-existent

99 Parameter non-existent

99 Parameter non-existent

500 Server internal error

-

-

100 Invalid IE contents

500 Server internal error

-

-

101 Message not compatible with call state

500 Server internal error

102 Recovery of timer expiry

102 Recovery of timer expiry

102 Recovery of timer expiry

504 Gateway timeout

103 Non-existent parameter passed on

-

103 Non-existent parameter passed on

500 Server internal error

110 Message discarded - unrecognized parameter

110 Message discarded - unrecognized parameter

110 Message discarded - unrecognized parameter

500 Server internal error

111 protocol error

111 protocol error

111 protocol error

500 Server internal error

127 interworking unspecified

127 interworking unspecified

127 interworking unspecified

500 Server internal error


ISUP Event Code to SIP Status Code Mapping

Table 5 provides received ISUP event codes and the corresponding SIP status codes.

Table 5 ISUP Event Code to SIP Status Code Mapping  

ITU ISUP
ANSI ISUP
Q.931
SIP response

1 Alerting

1 Alerting

1 Alerting

180 Ringing

2 Progress

2 Progress

2 Progress

183 Session progress

3 In-band information

3 In-band information

3 In-band information

183 Session progress

4 Call forward; line busy

4 Call forward; line busy

4 Call forward; line busy

181 Call is being forwarded

5 Call forward; no reply

5 Call forward; no reply

5 Call forward; no reply

181 Call is being forwarded

6 Call forward; unconditional

6 Call forward; unconditional

6 Call forward; unconditional

181 Call is being forwarded

- (no event code present)

- (no event code present)

- (no event code present)

183 Session progress


SIP Status Code to ISUP Message Mapping

Table 6 provides received SIP status codes and the corresponding ISUP messages.

Table 6 SIP Status Code to ISUP Message Mapping  

Response received
ANSI ISUP
ITU ISUP
Q.931

100 Trying

Nothing

Nothing

Nothing

180 Ringing (no SDP)

ACM (BCI = subscriber free) or CPG (event = 1 [Alerting]) if ACM already sent

Apply ring-back tone at GW

ACM (BCI = subscriber free) or CPG (event = 1 [Alerting]) if ACM already sent

Apply ring-back tone at GW

ALERTING

180 Ringing (with SDP)

ACM (BCI = subscriber free) or CPG (event = 1 [Alerting]) if ACM already sent

ACM (BCI = subscriber free) or CPG (event = 1 [Alerting]) if ACM already sent

ALERTING

181 Call is being forwarded

Early ACM and CPG (event = 6 [Forwarding]) or CPG (event = 6 [Forwarding]) if ACM already sent

Early ACM and CPG (event = 6 [Forwarding]) or CPG (event = 6 [Forwarding]) if ACM already sent

FORWARDING

182 Queued

ACM (BCI = no indication) or CPG (event = 2 [Progress]) if ACM already sent

ACM (BCI = no indication) or CPG (event = 2 [Progress]) if ACM already sent

PROGRESS

183 Session progress message (no SDP)

ACM (BCI = no indication) or CPG (event = 2 [Progress]) if ACM already sent

Do not apply ring-back tone at GW

ACM (BCI = no indication) or CPG (event = 2 [Progress]) if ACM already sent

Do not apply ring-back tone at GW

PROGRESS with PI=8

183 Session progress message (with SDP)

ACM or CPG (event = Inband Info) if ACM already sent

Do not apply ring-back tone at GW

ACM or CPG (event = Inband Info) if ACM already sent

Do not apply ring-back tone at GW

PROGRESS with PI=8

200 OK

ANM and ACK or
ANM and CON when 200 OK arrives before gateway has sent an ACM (if CON is supported)

ANM and ACK or
ANM and CON when 200 OK arrives before gateway has sent an ACM (if CON is supported)

CONNECT

3xx (any redirection)

Gateway tries to reach destination by sending one or more call setup requests using URIs found in the Contact header fields of the response.

If URI is best reached via the PSTN (according to routing policies), the gateway sends an IAM and act as a normal PSTN switch (no SIP involved), or the gateway sends a REL message to the PSTN with a redirection indicator (23) and a diagnostic field containing the telephone number in the URI.

If URI is best reached using SIP (URI does not contain telephone number), MGC sends an Invite with a Request-URI in the message body.

While the redirection is being processed, the gateway sends a CPG (event = 6 [Forwarding]) to the PSTN to indicate that the call is still in progress.

Gateway tries to reach destination by sending one or more call setup requests using URIs found in the Contact header fields of the response.

If URI is best reached via the PSTN (according to routing policies), the gateway sends an IAM and act as a normal PSTN switch (no SIP involved), or the gateway sends a REL message to the PSTN with a redirection indicator (23) and a diagnostic field containing the telephone number in the URI.

If URI is best reached using SIP (URI does not contain telephone number), MGC sends an Invite with a Request-URI in the message body.

While the redirection is being processed, the gateway sends a CPG (event = 6 [Forwarding]) to the PSTN to indicate that the call is still in progress.

 

4xx through 6xx

When a response code of 400 or greater is receive by the gateway, the previously sent Invite has been rejected.

Gateway typically releases resources, sends an REL to the PSTN with a cause value, and sends an ACK to the SIP network.

Specific circumstances in which a gateway may attempt to retry the request without releasing the call are detailed in Table 7.

When a response code of 400 or greater is receive by the gateway, the previously sent Invite has been rejected.

Gateway typically releases resources, sends an REL to the PSTN with a cause value, and sends an ACK to the SIP network.

Specific circumstances in which a gateway may attempt to retry the request without releasing the call are detailed in Table 7.

When a response code of 400 or greater is receive by the gateway, the previously sent Invite has been rejected.

Gateway typically releases resources, sends an REL to the PSTN with a cause value, and sends an ACK to the SIP network.

Specific circumstances in which a gateway may attempt to retry the request without releasing the call are detailed in Table 7.


SIP Status Code to ISDN Cause Code Mapping

Table 7 details the specific SIP status codes (and their associated ISDN cause codes) that cause a gateway to attempt to retry a request without releasing the call.

Table 7 SIP Status Code to ISDN Cause Code Mapping  

Response received
ANSI ISUP
ITU ISUP
Q.931

400 Bad request

41 Temporary Failure

41 Temporary Failure

41 Temporary Failure

401 Unauthorized

21 Call Rejected (only when gateway cannot provide credentials)

21 Call Rejected (only when gateway cannot provide credentials)

21 Call Rejected (only when gateway cannot provide credentials)

402 Payment required

21 Call Rejected

21 Call Rejected

21 Call Rejected

403 Forbidden

21 Call Rejected

21 Call Rejected

21 Call Rejected

404 Not found

1 Unallocated number

1 Unallocated number

1 Unallocated number

405 Method not allowed

63 Service or option unavailable

63 Service or option unavailable

63 Service or option unavailable

406 Not acceptable

79 Service or option not implemented (only when gateway cannot remedy unacceptable behavior and re-originate the session)

79 Service or option not implemented (only when gateway cannot remedy unacceptable behavior and re-originate the session)

79 Service or option not implemented (only when gateway cannot remedy unacceptable behavior and re-originate the session)

407 Proxy authentication required

21 Call Rejected (only when gateway cannot provide credentials)

21 Call Rejected (only when gateway cannot provide credentials)

21 Call Rejected (only when gateway cannot provide credentials)

408 Request timeout

102 Recovery on timer expiry

102 Recovery on timer expiry

102 Recovery on timer expiry

409 Conflict

41 Temporary failure

41 Temporary failure

41 Temporary failure

410 Gone

22 Number changed (without diagnostic)

22 Number changed (without diagnostic)

22 Number changed (without diagnostic)

413 Request Entity too long

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

414 Request-URI too long

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

415 Unsupported media type

79 Service or option not implemented (only when gateway cannot remedy unacceptable behavior and re-originate the session)

79 Service or option not implemented (only when gateway cannot remedy unacceptable behavior and re-originate the session)

79 Service or option not implemented (only when gateway cannot remedy unacceptable behavior and re-originate the session)

416 Unsupported URI Scheme

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

420 Bad extension

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

421 Extension required

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

423 Interval Too Brief

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

480 Temporarily unavailable

18 No user responding

18 No user responding

18 No user responding

481 Call leg/transaction
does not exist

41 Temporary failure

41 Temporary failure

41 Temporary failure

482 Loop detected

25 Exchange - routing error

25 Exchange - routing error

25 Exchange - routing error

483 Too many hoops

25 Exchange - routing error

25 Exchange - routing error

25 Exchange - routing error

484 Address incomplete

28 Invalid Number Format (only when gateway cannot remedy unacceptable behavior and re-originate the session)

28 Invalid Number Format (only when gateway cannot remedy unacceptable behavior and re-originate the session)

28 Invalid Number Format (only when gateway cannot remedy unacceptable behavior and re-originate the session)

485 Ambiguous

1 Unallocated number

1 Unallocated number

1 Unallocated number

486 Busy here

17 User busy

17 User busy

17 User busy

487 Request Cancelled

- (no mapping)

- (no mapping)

- (no mapping)

488 Not acceptable here

31 Normal, unspecified

or 63 Bearer Capability Not Implemented (only when the Warning code indicates an unavailable bearer capability)

31 Normal, unspecified

or 63 Bearer Capability Not Implemented (only when the Warning code indicates an unavailable bearer capability)

31 Normal, unspecified

or 63 Bearer Capability Not Implemented (only when the Warning code indicates an unavailable bearer capability)

500 Internal server error

41 Temporary Failure

41 Temporary Failure

41 Temporary Failure

501 Not implemented

79 Not implemented, unspecified

79 Not implemented, unspecified

79 Not implemented, unspecified

502 Bad gateway

38 Network out of order

38 Network out of order

38 Network out of order

503 Service unavailable

41 Temporary failure

41 Temporary failure

41 Temporary failure

504 Server time-out

102 Recovery on timer expiry

102 Recovery on timer expiry

102 Recovery on timer expiry

505 Version not supported

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

513 Message Too Large

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

127 Interworking (only when gateway cannot remedy unacceptable behavior and re-originate the session)

600 Busy everywhere

17 User busy

17 User busy

17 User busy

603 Decline

21 Call rejected

21 Call rejected

21 Call rejected

604 Does not exist anywhere

1 Unallocated number

1 Unallocated number

1 Unallocated number

606 Not acceptable

31 Normal, unspecified

or 63 Bearer Capability Not Implemented (only when the Warning code indicates an unavailable bearer capability)

31 Normal, unspecified

or 63 Bearer Capability Not Implemented (only when the Warning code indicates an unavailable bearer capability)

31 Normal, unspecified

or 63 Bearer Capability Not Implemented (only when the Warning code indicates an unavailable bearer capability)


Internal Cause Code to SIP Status Code Mapping

Table 8 describes the internal-to-protocol location mappings supported in the ANSI SS7 protocol. The transmitted bit code values are in binary.

Table 8 Internal Cause Code to SIP Status Code Mappings  

Internal Cause Code
SIP Status Code

IC_UNALLOCATED_NUMBER
IC_NO_ROUTE_TO_DEST
IC_NO_ROUTE_TO_TNS
IC_NON_SELECTED_USER_CLEARING
IC_MISDIALLED_TK_PREFIX
IC_UNALLOCATED_DEST_NUMBER
IC_UNDEFINED_BG
IC_NON_EXISTENT_CUG
IC_ROUTING_ERROR

404 Not_Found

IC_USER_BUSY

486 Busy_Here

IC_NO_USER_RESPONDING

408 Request_Timeout

IC_NO_ANSWER_ALERTED_USER
IC_NORMAL_UNSPECIFIED
IC_SUB_ABSCENT

480 Temporarily_Not_Available (

IC_SPECIAL_INFORMATION_TONE

604 Does_Not_Exist_Anywhere

IC_INCOMING_CALLS_BARRED_IN_CUG
IC_USER_NOT_MEMBER_OF_CUG
IC_OUTGOING_CALLS_BARRED_IN_CUG
IC_INCON_OUTGOING_ACC_AND_SUB_CLASS

403 Forbidden

IC_CALL_REJECTED

603 Decline (if location = user)
403 Forbidden

IC_NUMBER_CHANGED

301 Moved_Permanently

IC_REDIRECTION_TO_NEW_DEST

410 Gone

IC_ADDRESS_INCOMPLETE

484 Address_Incomplete

IC_FACILITY_REJECTED
IC_REQ_FACILITY_NOT_IMP
IC_SERVICE_OR_OPTION_NOT_IMP_UNSPEC

501 Not_Implemented

IC_NETWORK_OUT_OF_ORDER
IC_TEMPORARY_FAILURE
IC_SWITCHING_EQUIP_CONGESTION
IC_RESOURCES_UNAVAIL_UNSPEC
IC_BEARCAP_NOT_AVAIL
IC_INCOMPATIBLE_DEST
IC_SERVICE_OR_OPTION_NOT_AVAIL
IC_ACCESS_INFO_DISCARDED
IC_REQ_CIRCUIT_UNAVAIL

503 Service_Unavailable

IC_BEARCAP_NOT_IMP
IC_ONLY_RESTRICT_DIG_INFO_BEARER

488 Not_Acceptable_Here

IC_DEST_OUT_OF_ORDER

502 Bad_Gateway

IC_RECOVERY_ON_TIMER_EXPIRY

504 Gateway_Time-out

IC_PROTOCOL_ERROR_UNSPEC
IC_NORMAL_CLEARING

500 Internal_Server_Error

IC_INVALID_TNS
IC_INVALID_MSG_UNSPEC
IC_MSG_TYPE_NOT_IMP
IC_ELEM_TYPE_NOT_IMP
IC_PARAM_UNREC_PASSED
IC_MESG_WITH_UNREC_ELEM_DISCARDED

400 Bad_Request

All other internal cause codes

500 Internal_Server_Error


SIP Status Code to Internal Cause Code Mapping

Table 8 describes the internal-to-protocol location mappings supported in the ANSI SS7 protocol. The transmitted bit code values are in binary.

Table 9 SIP Status Code to Internal Cause Code Mappings  

SIP Status Code
Internal Cause Code

OK

IC_NORMAL_CLEARING

Request_Timeout

IC_RECOVERY_ON_TIMER_EXPIRY

Bad_Request

IC_TEMPORARY_FAILURE

Use_Proxy (305)

IC_UNALLOCATED_NUMBER

Alternative_Service (380)

IC_SERVICE_OR_OPTION_NOT_AVAIL

Unauthorized (401)
Payment_Required (402)
Forbidden (403)
Proxy_Authentication_Required (40)

IC_CALL_REJECTED

Decline (603)

IC_CALL_REJECTED

Method_Not_Allowed (405)

IC_SERVICE_UNAVAILABLE

Bad_Request (400)
Length_Required (411)
Requested_Entity_Too_Large (413)
Request_URI_Too_Large (414)
Bad_Extension (420)
Extension_Required (421)
Session_Interval_Too_Small (422)
Interval_Too_Brief (423)
Version_Not_Supported (505)
Message_Too_Large (513)
Not_Acceptable_606 (606)

IC_INTERWORK_UNSPEC

Loop_Detected (482)
Too_Many_Hops (483)

IC_ROUTING_ERROR

Gone (410)

IC_NUMBER_CHANGED

Ambiguous (485)
Not_Found (404)

IC_UNALLOCATED_NUMBER

Does_Not_Exist_Anywhere (604)

IC_UNALLOCATED_NUMBER

Conflict (409)
Does_Not_Exist (481)
Internal_Server_Error (500)

IC_TEMPORARY_FAILURE

Unsupported_Media_Type (415)
Unsupported_URI_Scheme (416)
Not_Acceptable (406 or 604)
Not_Implemente (501)

IC_SERVICE_OR_OPTION_NOT_IMP_UNSPEC

Busy_Here (486)
Busy_Everywhere (600)

IC_USER_BUSY

Temporarily_Not_Available (480)

IC_NO_USER_RESPONDING

Request_Cancelled (487)

IC_NORMAL_CLEARING

Bad_Gateway (502)

IC_NETWORK_OUT_OF_ORDER

Service_Unavailable (503)
Precondition_Failure (580)

IC_TEMPORARY_FAILURE

Request_Timeout (408)
Gateway_Timeout (504)

IC_RECOVERY_ON_TIMER_EXPIRY

Address_Incomplete (484)

IC_INVALID_NUMBER_FORMAT

All other SIP status codes

IC_NORMAL_UNSPECIFIED


Obtaining Documentation

Cisco provides several ways to obtain documentation, technical assistance, and other technical resources. These sections explain how to obtain technical information from Cisco Systems.

Cisco.com

You can access the most current Cisco documentation on the World Wide Web at this URL:

http://www.cisco.com/univercd/home/home.htm

You can access the Cisco website at this URL:

http://www.cisco.com

International Cisco websites can be accessed from this URL:

http://www.cisco.com/public/countries_languages.shtml

Documentation CD-ROM

Cisco documentation and additional literature are available in a Cisco Documentation CD-ROM package, which may have shipped with your product. The Documentation CD-ROM is updated regularly and may be more current than printed documentation. The CD-ROM package is available as a single unit or through an annual or quarterly subscription.

Registered Cisco.com users can order a single Documentation CD-ROM (product number DOC-CONDOCCD=) through the Cisco Ordering tool:

http://www.cisco.com/en/US/partner/ordering/ordering_place_order_ordering_tool_launch.html

All users can order annual or quarterly subscriptions through the online Subscription Store:

http://www.cisco.com/go/subscription

Ordering Documentation

You can find instructions for ordering documentation at this URL:

http://www.cisco.com/univercd/cc/td/doc/es_inpck/pdi.htm

You can order Cisco documentation in these ways:

Registered Cisco.com users (Cisco direct customers) can order Cisco product documentation from the Networking Products MarketPlace:

http://www.cisco.com/en/US/partner/ordering/index.shtml

Nonregistered Cisco.com users can order documentation through a local account representative by calling Cisco Systems Corporate Headquarters (California, USA) at 408 526-7208 or, elsewhere in North America, by calling 800 553-NETS (6387).

Documentation Feedback

You can submit comments electronically on Cisco.com. On the Cisco Documentation home page, click Feedback at the top of the page.

You can send your comments in e-mail to bug-doc@cisco.com.

You can submit comments by using the response card (if present) behind the front cover of your document or by writing to the following address:

Cisco Systems
Attn: Customer Document Ordering
170 West Tasman Drive
San Jose, CA 95134-9883

We appreciate your comments.

Obtaining Technical Assistance

For all customers, partners, resellers, and distributors who hold valid Cisco service contracts, the Cisco Technical Assistance Center (TAC) provides 24-hour, award-winning technical support services, online and over the phone. Cisco.com features the Cisco TAC website as an online starting point for technical assistance.

Cisco TAC Website

The Cisco TAC website (http://www.cisco.com/tac) provides online documents and tools for troubleshooting and resolving technical issues with Cisco products and technologies. The Cisco TAC website is available 24 hours a day, 365 days a year.

Accessing all the tools on the Cisco TAC website requires a Cisco.com user ID and password. If you have a valid service contract but do not have a login ID or password, register at this URL:

http://tools.cisco.com/RPF/register/register.do

Opening a TAC Case

The online TAC Case Open Tool (http://www.cisco.com/tac/caseopen) is the fastest way to open P3 and P4 cases. (Your network is minimally impaired or you require product information). After you describe your situation, the TAC Case Open Tool automatically recommends resources for an immediate solution. If your issue is not resolved using these recommendations, your case will be assigned to a Cisco TAC engineer.

For P1 or P2 cases (your production network is down or severely degraded) or if you do not have Internet access, contact Cisco TAC by telephone. Cisco TAC engineers are assigned immediately to P1 and P2 cases to help keep your business operations running smoothly.

To open a case by telephone, use one of the following numbers:

Asia-Pacific: +61 2 8446 7411 (Australia: 1 800 805 227)
EMEA: +32 2 704 55 55
USA: 1 800 553-2447

For a complete listing of Cisco TAC contacts, go to this URL:

http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml

TAC Case Priority Definitions

To ensure that all cases are reported in a standard format, Cisco has established case priority definitions.

Priority 1 (P1)—Your network is "down" or there is a critical impact to your business operations. You and Cisco will commit all necessary resources around the clock to resolve the situation.

Priority 2 (P2)—Operation of an existing network is severely degraded, or significant aspects of your business operation are negatively affected by inadequate performance of Cisco products. You and Cisco will commit full-time resources during normal business hours to resolve the situation.

Priority 3 (P3)—Operational performance of your network is impaired, but most business operations remain functional. You and Cisco will commit resources during normal business hours to restore service to satisfactory levels.

Priority 4 (P4)—You require information or assistance with Cisco product capabilities, installation, or configuration. There is little or no effect on your business operations.

Obtaining Additional Publications and Information

Information about Cisco products, technologies, and network solutions is available from various online and printed sources.

The Cisco Product Catalog describes the networking products offered by Cisco Systems, as well as ordering and customer support services. Access the Cisco Product Catalog at this URL:

http://www.cisco.com/en/US/products/products_catalog_links_launch.html

Cisco Press publishes a wide range of networking publications. Cisco suggests these titles for new and experienced users: Internetworking Terms and Acronyms Dictionary, Internetworking Technology Handbook, Internetworking Troubleshooting Guide, and the Internetworking Design Guide. For current Cisco Press titles and other information, go to Cisco Press online at this URL:

http://www.ciscopress.com

Packet magazine is the Cisco quarterly publication that provides the latest networking trends, technology breakthroughs, and Cisco products and solutions to help industry professionals get the most from their networking investment. Included are networking deployment and troubleshooting tips, configuration examples, customer case studies, tutorials and training, certification information, and links to numerous in-depth online resources. You can access Packet magazine at this URL:

http://www.cisco.com/go/packet

iQ Magazine is the Cisco bimonthly publication that delivers the latest information about Internet business strategies for executives. You can access iQ Magazine at this URL:

http://www.cisco.com/go/iqmagazine

Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering professionals involved in designing, developing, and operating public and private internets and intranets. You can access the Internet Protocol Journal at this URL:

http://www.cisco.com/en/US/about/ac123/ac147/about_cisco_the_internet_protocol_journal.html

Training—Cisco offers world-class networking training. Current offerings in network training are listed at this URL:

http://www.cisco.com/en/US/learning/index.html

Glossary

Table 10 contains definitions of acronyms and technical terms used in this feature module.

Table 10 Glossary  

Term
Description

CLID

Calling Line Identification

DPNSS

Digital Private Network Signaling System

IETF

Internet Engineering Task Force

ISDN

Integrated Services Digital Network

ISUP

ISDN User Part

MGC

Media Gateway Controller

MML

Man-Machine Language

MWI

Message Waiting Indicator

PSTN

Public Switched Telephone Network

QSIG

Q Signaling

RFC

Request For Comment

SIP

Session Initiation Protocol

SS7

Signaling System 7

SUA

Service Connection Control Part (SCCP) User Application v