Beruflich Dokumente
Kultur Dokumente
8
Dial Plan Guide
September 7, 2010
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at
www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1005R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display
output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in
illustrative content is unintentional and coincidental.
Preface xv
Document Objectives xv
Audience xv
Related Documentation xv
APPENDIX A NOA and NPI Codes, CPC and TMR Values A-1
INDEX
This preface describes the objectives, audience, organization, and conventions of this document. It also
explains how to find additional information on related Cisco products and services and how to obtain
technical assistance, should it be needed. It contains the following sections:
• Document Objectives, page xv
• Audience, page xv
• Related Documentation, page xv
• Obtaining Documentation and Submitting a Service Request, page xvi
• Document Change History, page xvi
Document Objectives
This document describes the information that you will need to create, implement, and deploy dial plans
for the Cisco PGW 2200 Softswitch Release 9.8.
The document also contains tables and worksheets for you to use to create dial plans for your system.
Audience
This guide is for network operators and administrators who have experience with telecommunications
networks, protocols, and equipment and who have familiarity with data communications networks,
protocols, and equipment.
Related Documentation
This document contains information that is related to Cisco PGW 2200 Softswitch dial plans. For
additional information on other system-level documents, see the documents at this URL:
http://www.cisco.com/en/US/products/hw/vcallcon/ps2027/tsd_products_support_series_home.html
You can find the Cisco PGW 2200 Softswitch Documentation Map at the following URL:
http://www.cisco.com/en/US/products/hw/vcallcon/ps2027/products_documentation_roadmaps_list.ht
ml
Release
Number Document Number Change Date Change Summary
9.8(1) OL-18082-07 May 10, 2010 Added the section “AOC Generation
for PRI” in Chapter 1.
Added the section“Adding a
LINEXLATE Table to the Dial Plan
for Configurable NOA Mapping” in
Chapter 4.
Added the section “Provisioning
Conditional A-Number Digit
Modification” in Chapter 4.
Added the section “Provisioning
E911 Mapping” in Chapter 4.
Added the sections “Adding the
BCMOD Result Type” and “Adding
the HLCMOD Result Type” to
Chapter 4.
9.8(1) OL-18082-06 January 22, 2010 Added new and modified result types
in Chapter 1, “Dial Plan and
Routing,” and dial plan provisioning
procedures in Chapter 4,
“Provisioning Dial Plans with MML.”
9.8(1) OL-18082-05 December 15, 2009 Added the internal cause code,
IC_IN_SERVICE_UNAVAILABLE
in Appendix B “Cause and Location
Codes.”
Removed detailed parameter
information in Chapter 4. The
detailed parameter information can be
found in Cisco PGW 2200 Softswitch
Release 9 MML Command Reference.
9.8(1) OL-18082-04 November 23, 2009 Updated cause analysis description on
cause codes and locations in
Chapter 1.
Updated Figure 1-3, Pre-analysis
Stages.
9.8(1) OL-18082-03 November 5, 2009 Updated Full Number Translations
behavior option enhancement for
result type NUM_TRANS, in
Chapter 1.
9.8(1) OL-18082-02 October 19, 2009 Updated cause code and Calling Party
Category (CPC) code mapping in
Appendix A and B.
Updated the section, Deleting a
Component from a Dial Plan, in
Chapter 4.
9.8(1) OL-18082-01 August 26, 2009 Initial release
This chapter provides an overview of the role the dial plan plays in call processing on the
Cisco PGW 2200 Softswitch. Dial plans let the Cisco PGW 2200 Softswitch running the MGC software
communicate with the Signaling System 7 (SS7) network and with the system components that control
media gateways and bearer-traffic routing.
This chapter contains the following sections:
• Dial Plan and Routing Introduction, page 1-1
• Result Analysis, page 1-9
• Pre-analysis, page 1-70
• Number Analysis, page 1-78
• Cause Analysis, page 1-78
• Routing Analysis, page 1-107
The dial plan provisioning processes described in this document apply to all Cisco telephony solutions
running the Cisco PGW 2200 Softswitch Release 9.3 and later.
Figure 1-1 provides a high-level overview of call analysis and routing stages.
Calls routed
Calls routed to another MGC
Calls
SS7 IAM completed
A-number B-number Routing Circuit
Pre-analysis
analysis analysis analysis selection
ISDN PRI
Setup,
51201
SIP INVITE
Pre-analysis lets you make decisions based on parameters received in the incoming IAM, Setup, or SIP
INVITE message and optionally manipulate data within those parameters.
A-number analysis lets you make decisions based on the calling number received in the incoming
message and optionally manipulate data based on the calling number. The calling number is the number
from which the call is originating. The incoming calling number for A-number analysis might have been
previously manipulated within the Pre-analysis stage.
B-number analysis lets you make decisions based on the called number received in the incoming
message and optionally manipulate data based on the called number. The called number is the number
to which the call is destined. The incoming called number for B-number analysis might have been
previously manipulated within the Pre-analysis stage and/or the A-number analysis stage.
In a signaling call environment, Route analysis is not performed because the terminating gateway is
already determined based on the incoming trunk.
In a call control environment, decisions are always made in the dial plan about whether the call is
switched using the routing analysis stage, or is treated as a signaling call. The routing analysis stage can
be initiated from Pre-analysis, B-number analysis, or Cause analysis stages.
Routing analysis lets you direct the call to an outgoing trunk group. Currently the supported entry points
into routing are
• Directly into Route analysis
• Conditional route analysis (Release 9.3(2) functionality)
• Percentage based route analysis (Release 9.3(2) functionality)
Cause analysis lets you make decisions based on parameter information received in the release messages,
or internally set failure information. These messages can result in a cause message being sent to the
gateway, to route advance, and to change to another dial plan with a restart of analysis.
57193
Other result sets
A Cisco PGW 2200 Softswitch can be presented with calls from public switched telephone network
(PSTN) service providers that could be handled in different ways. Here are some examples:
• National calls tandem switched through theCisco PGW 2200 Softswitch
• International calls requiring different treatment before being tandem switched by the
Cisco PGW 2200 Softswitch
• Re-seller calls tandem switched through the Cisco PGW 2200 Softswitch
• Private branch exchange (PBX) calls requiring breakout to the PSTN
• Internet calls terminating over ISDN primary rate interfaces (PRIs) hosted on the
Cisco PGW 2200 Softswitch
Calls originating from a virtual private network (VPN) on a PBX (PRI) ingress can be routed within a
“local” dial plan (the dial plan for the VPN) by analyzing extension digits; or calls can be routed out over
the PSTN with a full national number by dialing a PSTN access code, such as 9.
For reseller type calls the customer line is “virtual” to the re-seller service provider and is known only
to that provider by the calling party number (A-number). Thus, the required switching actions must be
determined according to the A-number; hence the requirement to change dial plans according to this
number. It must be understood that in such a scenario the volume of A-numbers is constrained by the
level of usage of the Cisco PGW 2200 Softswitch, as described later.
The system must support the ability to start call processing within the dial plan defined against an ingress
trunk group or sigpath and then, depending on Pre-analysis, A-number analysis, B-number analysis, or
Cause analysis identify a new dial plan to continue call processing.
Pre-analysis Overview
The Pre-analysis stages, shown in Figure 1-3, are as follows:
• A/B-number NOA and NPI Analysis (NOA/NPI) for calling number (A-number)
• Calling Party Category Analysis (CPC)*
• Transmission Medium Requirement Analysis (TMR)*
• A/B-number NOA and NPI Analysis (NOA/NPI) for called number (B-number)
• Transit Network Selection Analysis (TNS)*
• NANP B-Number Normalization
* Indicates MGC software Release 9.3(2) functionality.
The initial analysis request, made after the reception of an SS7 IAM, ISDN PRI setup, or SIP INVITE
message, is called Pre-analysis. Pre-analysis, if required, is performed according to the data in the
received message. Pre-analysis enables you to perform calling party category (CPC) analysis,
transmission medium requirement (TMR) analysis, NOA/NPI analysis, transit network selection (TNS),
and North American Numbering Plan (NANP) number normalization before number analysis.
Each Pre-analysis stage is completed and leads to the next Pre-analysis stage unless there is analysis
failure or a blacklist result. Once all Pre-analysis stages are completed, the result handling is completed
including any dial plan changeover before the call goes to the next analysis stage.
Routing Overview
The objective of a dial plan, in a call control scenario, is to establish a connection or circuit between the
calling number (A-number) and the called number (B-number). Here are definitions for four important
call routing terms:
• Trunk—A trunk (or circuit), in Cisco PGW 2200 Softswitch terms, is a single TDM voice channel
(DS0). It is a physical connection between two points through which a call can be established.
• Trunk group—A trunk group is a collection of trunks (or circuits). For the sake of simplicity,
Cisco PGW 2200 Softswitch trunk groups are often arranged exactly the same as the trunk groups
on the switches on the opposing ends of the packet network.
• Route—The route defines the path that a call uses. It might be a collection of trunk groups with the
same destination, or a logical path over a packet network fabric.
• Route List—A route list is a collection of routing alternatives that can be used to transport a call
between the origination and the destination points. Individual routes within a route list can connect
the same two origination and destination points, but over different physical paths.
SS7 exchanges
between switches
2: MGC reads IAM 3: MGC selects
messages and performs route
number analysis
SS7 network
4: MGC selects
1: Circuit selected trunk group
by originating switch
MGC
Terminating leg
node
Originating leg
51187
with gateways A to B circuit
The Cisco PGW 2200 Softswitch routing functionality includes the following, as shown in Figure 1-4:
• When the MGC is used for tandem (transit) applications, all calls originate or terminate outside the
MGC-controlled packet network.
• The MGC receives and analyzes signaling messages, either SS7 or ISDN PRI, determines ingress
and egress gateways, and selects the egress trunks (or circuits) to external TDM switches and
networks.
• The MGC controls the ingress and egress media gateways on the packet network edges; however, it
does not control the route taken within the packet network.
• The MGC connects the ingress trunk to the egress trunk and routes the call from the origination to
the destination.
TheCisco PGW 2200 Softswitch supports random distribution of calls across multiple trunk groups
belonging to a particular route. Enabling or disabling random distribution is supported on a
route-by-route basis.
Call routing can be accomplished based on factors such as, including the NOA value in the incoming
IAM or Setup message, or combining the NOA value and the incoming NPI value. If routing is not
determined solely based on Pre-analysis, then number analysis is performed.
Once a route is chosen, the Cisco PGW 2200 Softswitch selects a trunk group and an available trunk
(circuit). If no trunk is available, the Cisco PGW 2200 Softswitch releases the call with a cause code
indicating all circuits are busy. As shown in Figure 1-1, calls can also be rejected at any point during
analysis and released with an appropriate cause code, or routed to an announcement server that informs
the caller why the call was not completed.
SS7 exchanges
between switches
2: MGC reads IAM 3: MGC selects
messages and performs route
number analysis
SS7 network
4: MGC selects
1: Circuit selected IP trunk group
by originating switch
Originating leg
84422
with gateway A to B SDP/H.245
The Cisco PGW 2200 Softswitch routing functionality includes the following, as shown in Figure 1-5:
• When the MGC is used to terminate calls to a SIP or H.323 end point; calls terminate inside the
packet network.
• The MGC receives and analyzes signaling messages, either SS7 or ISDN PRI, determines the
ingress gateway, and selects the egress SIP or H.323 signaling path.
• The MGC controls the ingress media gateways on the ingress packet network edge and signals to
the SIP or H.323 endpoint; however, it does not control the route taken within the packet network.
• The MGC connects the ingress trunk to the egress SIP or H.323 endpoint and routes the call from
the origination to the destination.
SS7 exchanges
between switches
1: MGC reads SIP INVITE 2: MGC selects
or H.323 SETUP and route
returns number analysis
SS7 network
3: MGC selects
trunk group
MGC
Terminating leg
node
Originating leg
84421
with gateway A to B circuit
TheCisco PGW 2200 Softswitch routing functionality includes the following, as shown in Figure 1-6:
• When the MGC is used to originate calls from a SIP or H.323 endpoint; calls originate inside the
packet network.
• The MGC receives and analyzes signaling messages, either SIP or H.323, determines the egress
gateway and selects the egress trunks (or circuits) to external TDM switches and networks.
• The MGC controls the egress media gateway on the packet network edge; however, it does not
control the route taken within the packet network.
These are basic call processing and routing functions of a dial plan. Creating a complete, efficient, and
comprehensive dial plan requires thorough planning and foresight. Organization can simplify dial plan
implementation.
Result Analysis
Result analysis lets you group actions into result sets that can be attached at different points of analysis.
The main attachment points are Pre-analysis, A-number analysis, B-number analysis, and Cause
analysis.
When configuring results, there are certain result types, which require extra configuration to provide
additional data, that enables the required action. The following are examples of two such result types.
• Number modification where digits are to be inserted into a number. These new digits must be
configured first and stored in data before the actual result, which will make use of these digits, is
defined. For example, if the B-number is 4841234 and the intention with a B-number modification
(BMODDIG result) is to insert 703 at the front of the number, the 703 digit string must be created
first. Once the digit string is created, the actual B-number modification result can be defined by
means of the 703 digit string data. This is more fully described in the following section.
• When A-number screening is required, if this action is triggered from the B-number digit analysis,
it is necessary to identify the database area that contains the A-number screening data for calls
destined to this particular B-number. The database area is called the service name. The service name
data must be defined separately before the actual A-number screening result is defined. Once again
the two following sections explain this more fully.
Finally, when you configure results to invoke Routing actions, there are three types of Routing results
ROUTE, COND_ROUTE*, and PERC_ROUTE* which are more fully explained in the following
sections.
*Indicates software Release 9.3(2) functionality.
Note Digit modification names are limited to 20 alphanumeric characters. Spaces are not allowed.
Service Name
Example 1-2 gives service name examples. Table C-5 in Appendix C, “Dial Planning Worksheets,” can
be used to plan the service name.
A service name, shown in Example 1-2, provides additional call screening capabilities. Thus, calls made
from a B-number may be allowed to dial Washington and FreePhone, but not allowed to dial TollLine.
Service Name
Washington
FreePhone
TollLine
Note Service names are limited to 10 alphanumeric characters. Spaces are not allowed in service
names.
Results
A result is a specific action on the Cisco PGW 2200 Softswitch. When you configure a result, you set
the result type for this result. You also set values for data words in this result.
Table 1-1 lists all the result type names and their data words. Result types prescribe the actions that are
taken when the last analyzed digit in a digit string is reached. See the “Result Type Definitions” section
on page 1-17 section following this table for definitions of result types and their associated data words.
Note The result number is only seen in an MDL trace. The result number is not provisionable.
A-digit Analysis
B-digit Analysis
Result Number
Intermediate
Pre-analysis
End Point
Cause
Result Type Data Word 1 Data Word 2 Data Word 3 Data Word 4
1 DIGIT_REQ Num. of digits 0 (not used) 0 (not used) 0 (not used) X X
2 ROUTE RouteListName 0 (not used) 0 (not used) 0 (not used) X X X X
3 INC_NUMBERING Numbering Type Min. digits Max. digits 0 (not used) X X X
4 BMODDIG Application Num. of digits Modification 0 (not used) X X X X X
Point to remove Name
5 AMODDIG Application Num. of digits Modification Conditional X X X X
Point to remove Name Indicator
6 CAUSE Cause Code Location 0 (not used) 0 (not used) X X X X X
value
7 FACILITY type treatment 0 (not used) 0 (not used) X X X X
8 ANNOUNCEMENT Announcement Local/Remote RouteListId Announceme X X X X X
ID nt Data
A-digit Analysis
B-digit Analysis
Result Number
Intermediate
Pre-analysis
End Point
Cause
Result Type Data Word 1 Data Word 2 Data Word 3 Data Word 4
10 CHARGE TariffRate/ Scale Factor ChargeData Charge Type X X
Dest for Discriminator
Charging/
Charge Band
Number/
Charge Unit
11 CPC_REQ 0 (not used) 0 (not used) 0 (not used) 0 (not used) X X X
12 CLI_REQ 0 (not used) 0 (not used) 0 (not used) 0 (not used) X X X
13 BSM_REQ 0 (not used) 0 (not used) 0 (not used) 0 (not used) X X
14 FSM_REQ 0 (not used) 0 (not used) 0 (not used) 0 (not used) X X
15 A_NUMBER_TYPE A-number Type 0 (not used) 0 (not used) 0 (not used) X X X X
16 B_NUMBER_TYPE B-number Type 0 (not used) 0 (not used) 0 (not used) X X X X X
17 OTG_NUMBERING Numbering Type Min. digits Max. digits 0 (not used) X X
18 BLACKLIST Screening 0 (not used) 0 (not used) 0 (not used) X X X X
Criteria
19 CLI_NBR_LENGTH Numbering Type Min. digits Max. digits 0 (not used) X X
21 ROUTE_PREFERENCE Route Pref 0 (not used) 0 (not used) 0 (not used) X X
22 IN_TRIGGER Service Type SCP/STP Min digits Req Timer X X
Index
23 SCREENING Screen Type Service Name Pass_DpIdx Fail_DpIdx X X X
24 DATA_EXCHANGE Action Type 0 (not used) 0 (not used) 0 (not used) X X
25 E_PORTED_NUM Number of Use partial 0 (not used) 0 (not used) X X
digits to remove number
26 E_ROUTE_NUM Number of 0 (not used) 0 (not used) 0 (not used) X X
digits to remove
27 TERM_INFO 0 (not used) 0 (not used) 0 (not used) 0 (not used) X X
28 TESTCALLDETECTED TestLineType TestLine TestLineName 0 (not used) X X
Duration
31 ADDRESSCLASS Geographic 0 (not used) 0 (not used) 0 (not used) X X
32 WHITELIST 0 (not used) 0 (not used) 0 (not used) 0 (not used) X X
33 NEW_DIALPLAN CustGrpId Analysis Type 0 (not used) 0 (not used) X X X X X
34 A_NUM_DP_TABLE searchMin 0 (not used) 0 (not used) 0 (not used) X X X
35 RTRN_START_ANAL Number of 0 (not used) 0 (not used) 0 (not used) X X X
digits to remove
A-digit Analysis
B-digit Analysis
Result Number
Intermediate
Pre-analysis
End Point
Cause
Result Type Data Word 1 Data Word 2 Data Word 3 Data Word 4
36 CHARGEORIGIN Charge Origin 0 (not used) 0 (not used) 0 (not used) X X X
37 CG_PRES_IND Presentation 0 (not used) 0 (not used) 0 (not used) X X X X
Indicator
38 CALL_CUTOFF_TIME callcutoffvalue callcutoffunit 0 (not used) 0 (not used) X X X X
R (values: 1-48, s
1-2880, or (values: 0, 1,
1-172800) or 2)
42 RETRY_ACTION RetryType (1 to 0 (not used) 0 (not used) 0 (not used) X X
3)
43 COND_ROUTE CondRteName 0 (not used) 0 (not used) 0 (not used) X X X X
44 MGCPDIALPKG Digital, Analog, 0 or 1 0 (not used) 0 (not used) X X
or Dynamic
45 CPCMOD Integer (0–255) Integer 0 0 (not used) 0 (not used) X X X
Calling party Default-callin
CPC parameter g party CPC
45 CPCMOD Integer (0-3) Integer 1 0 (not used) 0 (not used) X X X
Called party Called party
CPC parameter CPC
46 CC_DIG CCModName 0 (not used) 0 (not used) 0 (not used) X X
47 CODEC CodecStringNa Action CodecStringTy 0 (not used) X X X X
me pe
48 PERC_ROUTE PercRteName 0 (not used) 0 (not used) 0 (not used) X X X X
49 PNMODDIG Application Number of Modification 0 (not used) X X X
point digits to Name
remove
50 PN_NUMBER_TYPE Internal NOA 0 (not used) 0 (not used) 0 (not used) X X X
value (0-53)
51 PN_PRES_IND 1 = Restricted Local/Remote RouteListId AnnData X X X
2 = Allowed
3 = Unavailable
52 CG_SCREEN_IND 1 = Network 0 (not used) 0 (not used) 0 (not used) X X X
Provided
2 = UPVP
3 = UPNV
4 = UPVF
5 = spare1
A-digit Analysis
B-digit Analysis
Result Number
Intermediate
Pre-analysis
End Point
Cause
Result Type Data Word 1 Data Word 2 Data Word 3 Data Word 4
53 PN_SCREEN_IND 1 = Network 0 (not used) 0 (not used) 0 (not used) X X X
Provided
2 = UPVP
3 = UPNV
4 = UPVF
5 = spare1
54 A_NUM_NPI_TYPE Internal NPI 0 (not used) 0 (not used) 0 (not used) X X X
value (0-10)
55 CG_PN_COPY Index to 0 (not used) 0 (not used) 0 (not used) X X X
Network
Numbering
string
56 PN_NPI_TYPE Internal NPI 0 (not used) 0 (not used) 0 (not used) X X X
value (0-10)
57 RMODDIG Application Number of Modification Remove X X X X X
point digits to Index leading digits
remove
58 R_NUMBER_TYPE Remote Number 0 = OCN 0 (not used) 0 (not used) X X X X X
Type NOA is not
updated based
on redirecting
number.
1 = OCN
NOA is
updated based
on redirecting
number.
59 ATM_ORIG_PROFILE AtmProfIdx Action 0 (not used) 0 (not used) X X X
60 ATM_TERM_PROFILE AtmProfIdx Action 0 (not used) 0 (not used) X X X
61 SCRIPT ScriptId CallType AcmReqdInd. N/A X X
62 CHARGE_MODE_IND ChargeModeInd 0 (not used) 0 (not used) 0 (not used) X X X
63 CHARGE_IND ChargeInd 0 (not used) 0 (not used) 0 (not used) X X X
64 B_NBR_MOD_MWI MWI ON MWI OFF 0 (not used) 0 (not used) X X
65 IN_SERVICE_KEY InServiceKey Global Title Digits Name 0 (not used) X X
Digits Type
66 LOC_LABEL Location Label 0 (not used) 0 (not used) 0 (not used) X X X
67 OVERRIDE_CALLIM 0 (not used) 0 (not used) 0 (not used) 0 (not used) X X X X
A-digit Analysis
B-digit Analysis
Result Number
Intermediate
Pre-analysis
End Point
Cause
Result Type Data Word 1 Data Word 2 Data Word 3 Data Word 4
69 NUM_TRANS Service Key Number Type NOA Dial Plan X X X
70 E911PROF Route Pref 0 (not used) 0 (not used) 0 (not used) X X X
71 ORIG_VPN_ID VPN ID On-net index Off-net index 0 (not used) X X X X
72 DTMFCAP DTMF 0 (not used) 0 (not used) 0 (not used) X X X X
Capability
73 BCMOD BC name 0 (not used) 0 (not used) 0 (not used) X X X
74 HLCMOD HLC name 0 (not used) 0 (not used) 0 (not used) X X X
76 DB_XLATED searchMin matchNewDp nonMatchedNe 0 (not used) X X
wDp
77 REDIRECT serviceKey 0 (not used) 0 (not used) 0 (not used) X X X
78 IP_SOURCE_SCREEN screenType serviceName foundSetName notFoundSet X X
Name
79 IP_DEST_TRANS inputAndAction serviceName foundSetName notFoundSet X X
Name
80 IP_SET_SOURCE_DM dmnString applicationSt applyTo 0 (not used) X X X X
N atus
81 IP_ROUTE_SEL inputDataType serviceName foundSetName notFoundSet X X
Name
82 DRP_EXIT drpExitType 0 (not used) 0 (not used) 0 (not used) X X
83 SIPTNS Circuit Code 0 (not used) 0 (not used) 0 (not used) X X
Value (0-15)
84 SIPI_CONTROL Enable the route 0 (not used) 0 (not used) 0 (not used) X X
preference
85 GATEWAYPOOL Ingress gateway AnchorMedia Egress gateway AnchorMedia X X X
pool ID property pool ID property
value on the value on the
ingress side egress side
86 VIDEO_ALLOWED Allows or 0 (not used) 0 (not used) 0 (not used) X X X X
prohibits video
calls
87 DEFAULT_TMR Specifies the 0 (not used) 0 (not used) 0 (not used) X X X
default TMR
value
88 CALL_TAG Call tag list 0 (not used) 0 (not used) 0 (not used) X X X X
A-digit Analysis
B-digit Analysis
Result Number
Intermediate
Pre-analysis
End Point
Cause
Result Type Data Word 1 Data Word 2 Data Word 3 Data Word 4
89 CALL_REPORT Call severity: Predefined 0 (not used) 0 (not used) X X X
text that you
• 0 = Minor
configure to
• 1 = Major be sent as part
• 2 = Critical of the SNMP
90 PREFIX_CONVERT 0 (not used) 0 (not used) 0 (not used) 0 (not used) X X X
Note All result matches for a digit string are added together and only duplicate result types are overwritten by
the longest match.
Intermediate result types can be followed with another intermediate result type or with an end point
result type. When an end point result type is encountered in a result set the analysis is complete. An end
point result type cannot be followed by any other result type and no more results or result sets can be
connected further on in the analysis. End point result types currently used include CAUSE,
ANNOUNCEMENT, BLACKLIST, WHITELIST, and MGCPDIALPKG.
For example, intermediate result types can allow you to provision a route to an operator center based on
the digit string 703 in the called number (B-number). Later in the analysis you can provision more
precise routings for calls that include the 703 digit string, such as a ROUTE result for longer digit strings
such as 703484, which routes the call to route 1, 703544, which routes the call to route 2, and so on. The
longest string matched wins; however, if you don't get a longer match, then the earlier route based on the
shorter 703 digit string is taken.
Depending on the analysis area that invokes them, the AMODDIG and BMODDIG result types have
different functions.
ADDRESSCLASS
The ADDRESSCLASS result type is returned from B-number analysis (the called number) indicating
whether the number is geographic or nongeographic. This result type can be encountered during
B-number analysis and indicates the class of the B-number. The ADDRESSCLASS result type value
indicates the class of address.
Valid ADDRESSCLASS values are
• 0 = Geographic (default)
• 1 = Non-geographic
It is possible to encounter more than one ADDRESSCLASS result for a given B-number and all these
results are applied to the B-number. This allows for the addition of future new ADDRESSCLASS results
that might not be mutually exclusive.
AMODDIG
The AMODDIG result type is for digit modification on the A-number. You can remove a specified
number of digits from any point in the A-digit string and replace them with whatever digits are required.
Here is an example of the A-number modification:
If you get result type AMODDIG to modify the A-number, you receive the following datawords:
• Application point—The point (digit) in the digit string to begin applying the modification.
The range is from 1 through the total number of digits in the digit string (32 maximum). Entering a
value of “98” causes the removal of digits to begin at the end of the digit string and move backward.
• Number of digits to remove—The range is from 0 through the number of digits remaining in the
digit string from the application point (32 maximum). To remove the entire number, regardless of
the number of digits it contains, enter the value “99” for this dataword.
• Modification name—If required, this is a name that specifies the digit modification string that is to
be inserted beginning at the application point.
• ConditionalInd—Provides an indication of conditional modification. 0 indicates unconditional
modification and 1 indicates presentation restriction dependent. (Added in software Release 9.5(2).)
Dataword rules:
• Dataword1 must be 1 through 32 or 98.
• Dataword2 must be 0 through 32 or 99.
• Dataword3 must be 0 or an existing digit modification name.
• If dataword4 is 1, then dataword 2 is not allowed and should be 0.
• If dataword 4 is 0, then allow dataword 2 as normal.
For example, if the application point = 1, the number of digits to remove = 5, and the modification name
gives a result of 1321, then begin at the start of the digit string, remove 5 digits, and replace them with
the digit string 1321. This yields the two following A-number values:
• A-number received pre-analysis = 01444 567891
• A-number post analysis = 1321 567891
Here is another example. If the application point = 98, the number of digits to remove = 4, and the
modification name gives a result of 1321, then begin at the end of the digit string, remove 4 digits, and
replace them with the digit string 1321. This yields the two following A-number values:
• A-number received pre-analysis = 12345567891
• A-number post analysis =12345561321
Depending on the analysis area that invokes it, the AMODDIG result type has different functionality.
The following are examples of this different functionality.
• In Pre-Analysis there are currently four serial stages that can produce the AMODDIG result type.
In Pre-analysis, the results are cumulative. For example, if the CPC stage generates an AMODDIG
result type, then the A-number is modified according to the result and this modified number then is
the new A-number passed as input to the next Pre-analysis stage (TMR analysis). If the TMR
analysis provokes another AMODDIG result type, then it further modifies the number and so on.
Even though multiple modifications like this would seem excessive and unnecessary, the capability
exists to ensure the required flexibility is provided.
• In Number analysis (A-number or B-number), functionality is different. Here digit analysis is
applied (digit by digit), and it is possible to have the AMODDIG result type at multiple points if
required. However, only the last modification result type is applied.
Note Digit modification is applied to the initial number input to this analysis stage. There is no
cumulative digit modification performed.
For example, if the received A-number is 1234 and at “1” an AMODDIG result type is received
making the number 441234, the digit string is modified and analysis continues according to the digit
analysis configuration. If another AMODDIG result type is received at 1234, making the number
551234, the earlier AMODDIG result type (“1”) is discarded and the number now sent forward is
551234.
ANNOUNCEMENT
The ANNOUNCEMENT result type provides an announcement ID, local or remote indication, and a
route ID. These fields are defined as follows:
• AnnouncementId—Indicates the identity value corresponding to the announcement identity (or
tone identity) that is played to the caller. This is one of the two access keys for which the table is
searched. It is a 4-digit integer value.
• Local/Remote—Indicates if the Announcement is to be played on a local gateway or routed to a
remote announcement server elsewhere in the network. Values: 0—Local (gateway), 1—Remote
(gateway).
• RouteListId—Indicates the RouteListId that is used to route to a remote announcement server. This
dataword is applicable only when dataword2 is set to remote (1).
• AnnData—Enables the switching off of a trunk group property announcement for certain
A-numbers or B-numbers. It also enables the applying of an announcement for certain A-numbers
or B-numbers if no trunk group property has been configured. Values are 0-Off, 1-Interim
announcement on, or 2-Final announcement on. This dataword is applicable only when dataword2
is set to local (0).
A_NUM_DP_TABLE
The A_NUM_DP_TABLE result type is relevant to Pre-analysis, A-number, and B-number analysis. Dial
plan selection can be triggered by Pre-analysis, the A-number, or the called party number (B-number).
The Cisco PGW 2200 Softswitch searches the dial plan for a match on the A-number and, if found, a
new dial plan identity is returned that is then used to continue call processing. An external tool
encapsulating ttBulkCp supports fast importing/exporting of ported numbers.
This result type has the searchMin dataword. The searchMin dataword indicates how far to search back
in the number when longest matching.
A_NUMBER_TYPE
The A_NUMBER_TYPE result type lets you change the A-number type NOA from that presented in the
IAM or Setup message. The value given as data in the result type (dataword1) is the
Cisco PGW 2200 Softswitch internal call context value for the NOA relating to the A-number. This
result type is available to A-number analysis.
Note The NOA value needs to be the MGC internal value and not the protocol-specific value. See Appendix A,
“NOA and NPI Codes, CPC and TMR Values” for specific protocol values.
A_NUM_NPI_TYPE
The A_NUM_NPI_TYPE result type is for CgPN; PN (GN-ACgPN) should be mapped from the original
CgPN if it was populated by a swap; or, if it is a new provision, use a default value (E.164).
Dataword1 indicates the internal NPI value. The value range is 0 (default) through 10.
ATM_ORIG_PROFILE
The ATM_ORIG_PROFILE result type is used to deliver a profile list configured according to the
Service Level Agreement requirements for the originating side. The ATM_ORIG_PROFILE result type
has the following datawords:
• Dataword1—AtmProfIdx provides an index value that is used to read the ATM Profiles table from
the routeAnalysis.dat file. This enables retrieving a list of ATM profiles for use in the profile
negotiation process.
• Dataword2—Action provides an indication as to whether this profile list is to be considered
preferred or mandatory. Values are 0 (mandatory) or 1 (preferred).
Possible profile entries are
• ITU1
• ITU2
• ITU3
• ITU7
• ITU8
• ITU12
• Custom100
• Custom101
• Custom110
• Custom200
ATM_ORIG_PROFILE provisioning for analysis results can be performed for either the A-numbers or
the B-numbers.
ATM_TERM_PROFILE
The ATM_TERM_PROFILE result type is used to deliver a profile list configured according to the
Service Level Agreement requirements for the terminating side. The ATM_TERM_PROFILE result type
has the following datawords:
• Dataword1—AtmProfIdx provides an index value that is used to read the ATM Profiles table from
the routeAnalysis.dat file. This enables retrieving a list of ATM profiles for use in the profile
negotiation process.
• Dataword2—Action provides an indication as to whether this profile list is to be considered
preferred or mandatory. Values are 0 (mandatory) or 1 (preferred).
Possible profile entries are
• ITU1
• ITU2
• ITU3
• ITU7
• ITU8
• ITU12
• Custom100
• Custom101
• Custom110
• Custom200
ATM_TERM_PROFILE provisioning for analysis results can be performed for either the A-numbers or
the B-numbers.
BCMOD
The BCMOD result type allows you to modify the Bearer Capability of outgoing Initial Address
Message (IAMs) based on the dialed Called Party Number. You can provision this result type using A-
and B-number analysis.
The BCMOD result type has the BC name dataword. The BC name dataword indicates the Bearer
Capability name, such as “fax-bc01.”
BLACKLIST
The BLACKLIST result type provides the basic ability to terminate a call during Pre-analysis and number
analysis. If this result is received, the call is immediately released with the cause value
IC_BLACKLIST_CLI_MATCHED (which may be changed by the protocol when the
Cisco PGW 2200 Softswitch sends the release message to the line). The call is terminated immediately,
so there is no screening involved with this result type.
The possible result types (screening criteria) and their application are as follows:
• 1 = Calling Line Identity (CLI)—Analysis of the A-number reveals that this calling line is restricted.
It is only supported in A-digit analysis.
• 2 = Dialed Address—Analysis of the B-number reveals that this called line is restricted. It is
supported only in B-digit analysis.
BMODDIG
The BMODDIG result type is for digit modification on the B-number. You can remove a specified
number of digits from any point in the B-digit string and replace them with whatever digits are required.
Here is an example of the B-number modification:
If we get result type BMODDIG to modify the B-number, we receive the following datawords:
• Application point—The point (digit) in the digit string that the Cisco PGW 2200 Softswitch begins
applying the modification. The range is from 1 through the total number of digits in the digit string
(32 maximum). Entering a value of “98” causes the removal of digits to begin at the end of the digit
string and move backward.
• Number of digits to remove—The range is from 0 through the number of digits remaining in the
digit string from the application point (32 maximum). To remove the entire number, regardless of
the number of digits it contains, enter the value “99” for this dataword.
• Modification name—If required, this is a name that specifies the digit modification string that is to
be inserted beginning at the application point.
Dataword rules:
• Dataword1 must be 1 through 32 or 98.
• Dataword2 must be 0 through 32 or 99.
• Dataword3 must be 0 or an existing digit modification name.
• Dataword4 must be 0.
For example, if the application point = 1, the number of digits to remove = 5, and the modification name
gives a result of 1321, then begin at the start of the digit string, remove 5 digits, and replace them with
the digit string 1321. This yields the two following B-number values:
• B-number received pre-analysis = 01444 567891
• B-number post analysis = 1321 567891
For example, if the application point = 98, the number of digits to remove = 4, and the modification name
gives a result of 1321, then begin at the end of the digit string, remove 4 digits, and replace them with
the digit string 1321. This yields the two following B-number values:
• B-number received pre-analysis = 12345567891
• B-number post analysis = 12345561321
Depending on the analysis area that invokes it, the BMODDIG result type has different functionality.
The following are examples of this different functionality:
• In Pre-Analysis there are currently four serial stages that can produce the BMODDIG result type. In
Pre-analysis, the results are cumulative. For example, if the CPC stage generates a BMODDIG result
type, then the B-number is modified according to the result and this modified number is then the
new B-number passed as input to the next Pre-analysis stage (TMR analysis). If the TMR analysis
provokes another BMODDIG result type, then it further modifies the number and so on. Even though
multiple modifications like this would seem excessive and unnecessary, the capability exists to
ensure that the required flexibility is provided.
Note Digit modification is applied to the initial number input to this analysis stage. There is no
cumulative digit modification performed.
For example, if the received B-number is 1234 and at “1” a BMODDIG result type is received
making the number 441234, the digit string is modified and analysis continues according to the digit
analysis configuration. If another BMODDIG result type is received at 1234, making the number
551234, the earlier BMODDIG result type (“1”) is discarded and the number now sent forward is
551234.
B_NBR_MOD_MWI
B_NBR_MOD_MWI result type is used to modify the B-number received on any incoming DPNSS
message with NSI string for MWI. If the service indicator is set to NULL, this result is ignored. If the
indicator is set to 0, then copy the B-number into the A-number and copy the digit string indexed by
DW1 in the DIGMODSTRING list into the B-number. If the indicator is set to 1, then copy the B-number
into the A-number and copy the digit string indexed by DW2 in the DIGMODSTRING list into the
B-number. This result type is used to provision the B-number in DPNSS for MWI.
Dataword1 is the MWI ON digit modification string.
Dataword2 is the MWI OFF digit modification string.
If this result type is not configured, and the MGC receives a virtual MWI string and this service indicator
is set to 0 or 1, then the call is released.
B_NUMBER_TYPE
The B_NUMBER_TYPE result type lets you change the A-number or B-number type NOA from that
presented in the IAM or Setup message. The value given as data in the result type (dataword1) is the
Cisco PGW 2200 Softswitch internal call context value for the new NOA relating to either the A-number
or B-number. This result type is available to A-number analysis or B-number analysis.
Note The NOA value needs to be the MGC internal value and not the protocol-specific value. See Appendix A,
“NOA and NPI Codes, CPC and TMR Values” for specific protocol values.
BSM_REQ
The BSM_REQ result type indicates that the basic service markings (BSM) have not been supplied and
are required for the outgoing side.
CALL_CUTOFF_TIMER
The CALL_CUTOFF_TIMER result type terminates any call that exceeds the preset duration of the timer.
The timer value is initially read from the XECfgParm.dat file. The default value range is 0 to 48 hours,
in 1 hour intervals. The timer value can also be set by dataword1 in the CALL_CUTOFF_TIMER result
type.
Note In software Release 9.5(2), dataword1 values for minutes (1–2880) and seconds (1–172800) were added,
along with dataword2 (callcutoffunits).
Dataword1 is the call cutoff timer value. The value range is 0 through 2.
• 0 = 1–48 (A value of 0, default, disables the call cutoff timer.)
• 1 = 1–2880
• 2 = 1–172800
Dataword2 is the call cutoff timer units. The value range is 0 through 2.
• 0 = Hours (default)
• 1 = Minutes
• 2 = Seconds
If the timer value is set to 0 by means of dataword1 for the CALL_CUTOFF_TIMER result type, then
the call cutoff timer is disabled, which takes precedence over the global timer value set in the
XECfgParm.dat file for calls associated with this result type.
If the timer value is set to any other value (1 through 48 hours) by means of dataword1 in the result type,
then the cutoff timer is set to this value, which also takes precedence over the global timer value set in
the XECfgParm.dat file for calls associated with this result type.
If this result is not configured against the call during setup, the Cisco PGW 2200 Softswitch uses the
global timer value set in the XECfgParm.dat file.
Note In the rare event where failover occurs multiple times, and CALL_CUTOFF_TIMER is enabled, each
failover causes the timer value to be re-applied to the currently active platform. As a result, the actual
time for a call to be released might exceed the call cutoff timer value setting.
CALL_REPORT
To use the call reporting feature, you must use this result type to indicate that a call should be reported
to the management station. When a call triggers the CALL_REPORT result type, the
Cisco PGW 2200 Softswitch generates a new SNMP trap. When you configure the dial plan result, you
can define a text string (for example, "Emergency"), which the Cisco PGW 2200 Softswitch can pass in
the SNMP trap. Also, the Cisco PGW 2200 Softswitch can pass other call details (such as calling and
called numbers) that are identified by the new MIB objects that have been added to the
CISCO-TRANSPATH-MIB (tp.my file).
See the “Provisioning Call Reporting” section on page 4-68 for provisioning procedures of the call
reporting feature.
CALL_TAG
The generic call tagging feature introduced this result type. You can use this result type to apply a tag
list in Pre-analysis, A-number analysis, or B-number analysis on the Cisco PGW 2200 Softswitch.
Dataword1 of the CALL_TAG result type names a tag list. A tag list contains tag pairs, which are formed
by a tag name and a tag value. However, a tag list can contain just a tag name with the default tag value
"true".
See the “Provisioning Generic Call Tagging” section on page 4-75 for provisioning procedures of the
generic call tagging feature.
CAUSE
The Cause analysis data specifies what actions to take when a given cause code and location are
presented to analysis. The cause might have been retrieved from a received message, set internally on
the MGC, or delivered as a CAUSE result. Currently, the given cause value is passed into the Cause
analysis process and determines whether or not to
1. Reattempt, redirect, or reroute the call on an alternate route.
2. Return an announcement (that is, route to the announcement server).
3. Clear the call down, writing the cause value returned into call context for protocol use.
The cause code corresponds to any provisioned value that complies with the range of cause values
permitted in call context. See Appendix B, “Cause and Location Codes” for cause code values.
The CAUSE result type has the following datawords:
• Cause
Valid values for this dataword are
– 0 = No cause mapping (default).
The 0 value is added to enable using a wildcard for the cause value. Provides a default value for
cause values not manually provisioned. Use the received cause value.
– 1 through 173 = Cause mapping value.
• Location
Valid values for this dataword are
– 0 = No location mapping (default). The 0 value enables a wildcard location value. Use the
default location value if no location is received.
– 1 through 13 = Location mapping value. The location value corresponds to any provisioned
value that complies with the range of location values permitted in call context. See Appendix B,
“Cause and Location Codes,” for location values.
CC_DIG
The CC_DIG result type retrieves and stores the Country code digits for the B-number during B-number
analysis. These digits can then be used to prefix the B-number when the Cisco PGW 2200 Softswitch is
functioning in a National switching node capacity.
Dataword1 provides a Modification name that the Cisco PGW 2200 Softswitch uses to read the
DIGMODSTRING in the dial plan. This enables the applicable Country code digits to be provisioned in
the DIGMODSTRING as any other set of number modification digits. See the “Provisioning the CC_DIG
Result Type” section on page 4-58 for more detailed information.
The decision to apply the stored Country code digits as a prefix to the B-number is based on the
BDigitCCPrefix property setting on the selected egress Trunk Group, which occurs after analysis. Thus,
at this stage of call processing, if the BDigitCCPrefix property is set to applying the Country code prefix,
then the Cisco PGW 2200 Softswitch uses previously retrieved digits (from DIGMODSTRING) to
modify the B-number.
See the “Adding or Removing Country Code” section on page 1-100 for more detailed information on
how to prefix the country code to an A- or B-number when the Cisco PGW 2200 Softswitch is
functioning in a National switching node capacity.
CG_PN_COPY
The CG_PN_COPY result type copies the Calling Party number (CgPn) to the value of the presentation
number parameter. This allows automatic filling of the CgPN address with the provisioned network
number when the existing address digits are moved to the Generic Number-Additional calling party
number (GN-ACgPN). The associated NOA, NPI, Screening Indicator (SI), and Presentation Indicator
(PI) fields are copied from the calling party number to GN-ACgPN. Currently the following associated
data is set in Call Context for CgPn: NOA- NAT, SI-Network Provided, and PI- Allowed. If the calling
number is displayed on a called party’s phone, it is the presentation number and not the CgPn, because
the result type has changed it. If dataword1 is null, then the CgPN is left intact after the existing digits
are moved. PN is a historical term, although still used a lot, but the correct term is GN-ACgPN.
CG_PRES_IND
The CG_PRES_IND result type changes the presentation indicator based on number analysis. The
possible values are
• 0—default
• 1—restricted
• 2—allowed
• 3—unavailable
CG_SCREEN_IND
The CG_SCREEN_IND result type is the screening indicator of the calling party number. The screening
indicator of the calling party number is modified with this result type.
Dataword1 is the calling party number screening indicator value. The screening indicator values are
• 1—NP (network provided)
• 2—UPVP (user provided verified and passed)
• 3—UPNV (user provided not verified)
• 4—UPVF (user provided verified and failed)
• 5—spare1
CHARGE
The CHARGE result type provides charging information relevant to the call and it supports the German,
India, and Polish Advice of Charge (AOC) functionality (shown in Table 1-3) as determined by the
ingress trunk group property AOC Enabled. Number analysis is responsible for obtaining the Charge
Origin and Charge Destination information from the dial plan and passing this information to the CDR
Manager, where it is used to access the Charge values. The information fields retrieved from the
CHARGE result type are defined as follows:
• Charge Data Discriminator—Determines the type of data in dataword1. Values are as follows:
– 1 = Tariff Rate—Used when the tariff rate is fixed and is independent of origin or time.
– 2 = Charge destination—Used for origin and/or time dependent tariff rates for customers
requiring this capability due to inter-operability agreements or certification requirements.
– 3 = Charge Band—Used for AOC to generate a charge band number to the preceding exchange
in the SS7 network as part of the charge message. When an originating switch that is to charge
the call receives this value, it is used as an index into the charging table being used to calculate
the charge amount for the call; or to start charging the call based on the value derived from the
charging table.
– 4 = Charge Unit—When an originating switch that is supposed to charge the call receives this
value (0-255), it starts charging the call based on this charge unit value. For example, a number
of seconds is associated with each charge unit (or charge rate); thus the call duration after the
answer signal is divided into charge units until the end of the call. The charge units are then
converted into a monetary value and the user is billed accordingly.
– 5 = Meter Pulse—Indicates that the meter pulse table is read instead of the tariff table with the
tariff descriptor value obtained from Charge table reading.
• Scale Factor—Determines the value that corresponds to a multiplication factor (see Table 1-2) that
is applied to the tariff rate. Set to 1 for metering pulses.
• Charge Type—Set to 1 (for German AOC) or to 0 (for India and Polish AOC) to indicate AOC. This
value is determined by the selected protocol variant.
The result data is returned only when analysis and routing are completed. For the
Cisco PGW 2200 Softswitch, this is when a trunk group is returned for circuit selection.
Protocol
Result Type Variant Dataword1 Dataword2 Dataword3 Dataword4
CHARGE TariffRate/ Scale Factor ChargeData Charge Type
Dest for Charging/ Discriminator
Charge Band Number/
Charge Unit
German 0-999999 0-3, 249-255 1 (Tariff Rate) 1
1-9999 0 2 (Charge 1
Destination)
India 0-255 0 3 (Charge Band) 0
Polish ISUP 0-255 0 3 (Charge Band) 0
V2 0-255 0 4 (Charge Unit) 0
Finnish 0-999999 0 5 (Meter Pulse) 1
Note When provisioning the CHARGE result type, use the values shown in Table 1-3 for the protocol variant
you are using.
CHARGE_IND
The CHARGE_IND result type (Charge indication) indicates whether the Cisco PGW 2200 Softswitch
should change the value of the charge indicator. The CHARGE_IND result type can be provisioned for
A-number and B-number analysis and is an intermediate result.
ChargeModeInd—This dataword (dataword1) has the following values:
0 = Leave as it is (default)
1 = Charge
2 = No charge
CHARGE_MODE_IND
The Charge Mode Indicator (CHARGE_MODE_IND) result type indicates how the metering pulses
generated by the MGC are applied in relation to possible other metering pulses (generated by some other
node). The CHARGE_MODE_IND result type is assignable against the ADIGTREE or BDIGTREE
component and is an intermediate result.
ChargeModeInd—This dataword (dw1) has the following values:
1 = Add on charge
2 = Replace charge
3 = Free of charge
CHARGEORIGIN
The CHARGEORIGIN result type contains an integer value in the range of 1–9999 and is returned during
A-number analysis if the Advice of Charge feature is enabled on the ingress trunk group or sigpath.
The charge origin value is determined in one of three ways:
• From the charge origin value ACHGORIGIN
Note For the CPC_REQ, CLI_REQ, BSM_REQ, and FSM_REQ result types, the required information can be
retrieved by an internal request signal if the originating protocol supports backward requests. If the
protocol does not support such requests, the call progresses without this information and the next
exchange determines if it is required.
CLI_NBR_LENGTH
The CLI_NUMBER_LENGTH result type basically indicates that the calling line identity has the
incorrect number of digits. The Numbering Type field is not processed, but the maximum and minimum
digit fields are used to determine whether the CLI is too long or too short. If the CLI is too long or too
short, a negative result is returned, the cause is set to IC_BLACKLIST_CLI_LENGTH_INVALID, and the
call is released. The protocol can apply a different cause code in the outgoing release message.
CLI_REQ
The CLI_REQ result type indicates that the calling line identity (CLI) has not been supplied and is
required for the outgoing side.
CODEC
The CODEC result type indicates the codec support required for an incoming message. Dataword1
indicates the codec string name used by the result and dataword2 indicates if the codec action is
mandatory (0) or preferred (1). Dataword3 indicates the type of the codec string that Dataword1
contains:
1 = Indicates that the codec string in dataword1 is an audio codec string.
2 = Indicates that the codec string in dataword1 is a video codec string.
COND_ROUTE
This result should be configured only when time conditional routing is required. When this result type
is returned, the Cisco PGW 2200 Softswitch prepares data and enters the Conditional Routing analysis
stage.
When the COND_ROUTE result type is added, the user configures the CondRouteName. The result is
added with the start name in dataword1. The dataword CondRouteName is also one of the access keys
used to read the Day/Time data associated with this result from the condRoute value in the Routing data
file.
For more information see the “Conditional Route Description” section on page 1-114.
CPCMOD
In A-number analysis, you can use the CPCMOD result type to modify the CPC of the IAM message to
include the desired indicator. For example, the Cisco PGW 2200 Softswitch A-number can be
provisioned with a list of the numbers that are configured as payphones. A-number analysis then handles
calls from these numbers by returning the CPCMOD result type with the payphone indicator (0xF) set
in dataword1. This result type is then used to modify the CPC information in the IAM message. When
calls from payphones are routed to the PSTN or other carriers, the CPC information in the IAM message
indicates that the call originated from a payphone so the proper billing information is provided.
Note The CPC value needs to be the MGC internal value and not the protocol-specific value.
CPC_REQ
The CPC_REQ result type indicates that the calling party category (CPC) has not been supplied and is
required for the outgoing side.
DATA_EXCHANGE
The DATA_EXCHANGE result type delivers a result from B-number analysis indicating that there are
actions required to move certain data from one call context location to another. For example, if the result
indicates a home-based local routing number (LRN), then the B-number and the generic address
parameter (GAP) number must be exchanged, and then new B-number analysis is invoked. The entry in
the associated ActionType field indicates the type of action that is required. Currently the only value is
1 = Home LRN—This number is a home LRN, that is, local to this Cisco PGW 2200 Softswitch. This
signifies that the Cisco PGW 2200 Softswitch must complete the call to the dialed number contained in
the GAP (not the number in the B-number). Consequently the GAP and B-numbers must be exchanged.
DB_XLATED
The DB_XLATED result type provides database look up and number translation for both ported and
non-ported types of calls. The DB_XLATED result type also allows you to change the dial plan based
on a matched or non-matched database query. This removes the previous requirement (by means of the
E_PORTED_NUM result type) to provision a default ROUTE result, which was used in the event that
the database query failed to find a match. However, if no dial plan options are configured in the
DB_XLATED result (dataword2 and dataword3), a default ROUTE or NEW_DIALPLAN result is still
necessary.
This result type has the following data words:
• searchMin—Value indicating how far to search back in the number when longest matching.
• matchNewDp—Entry index (integer) to a new dial plan in the dial plan selection table for
Cisco PGW 2200 Softswitch to switch to for further processing following a database reading
indicating that the target was matched. The dataword is provisioned as a dial plan name. It is then
internally converted to an integer value to point to an entry in the dial plan selection table.
• nonMatchedNewDp—Entry index (integer) to a new dial plan in the dial plan selection table for
Cisco PGW 2200 Softswitch to switch to for further processing following a database reading
indicating the target was not matched. The dataword is provisioned as a dial plan name. It is then
internally converted to an integer value to point to an entry in the dial plan selection table.
The following items further describe the behavior of the DB_XLATED result type:
• It is possible to collect DB_XLATED at any point in B-number analysis and always issue a database
query regardless of any later ROUTE or other final result.
• For enbloc calls or for overlap calls where sending is complete, a longest matching database query
is made.
• For overlap calls without a ST digit present, the Cisco PGW 2200 Softswitch performs a partial
matching query.
• For overlap calls without a ST digit present, if the initial partial matching database query finds no
matches, the Cisco PGW 2200 Softswitch launches a new query using longest matching.
• Result types DB_XLATED, E_PORTED_NUM, E_ROUTE_NUM, and TERM_INFO are all
mutually exclusive; the last one collected is the one processed.
• Multiple retrievals of the DB_XLATED result also mean that the last DB_XLATED result is the
result that is processed.
• The existing E_PORTED_NUM result is unchanged and provides the current level of LNP-only
functionality.
• The DB_XLATED result provides database lookup and number translation for ported and
non-ported calls.
• Both the E_PORTED_NUM and DB_XLATED result types query the ported number table, but use
different methods to read the table.
DEFAULT_TMR
The DEFAULT_TMR result type allows the Cisco PGW 2200 Softswitch to set or overwrite the TMR
value.
Dataword1 specifies the TMR value for this call:
• 1 = Set the TMR value to SPEECH.
• 2 = Set the TMR value to UNRES_64K.
• 3 = Set the TMR value to AUDIO_3K.
In the following example, you overwrite the TMR value for all of the calls whose calling numbers start
with 400. The TMR values for these calls are set to unrestricted 64k (UNRES_64K).
numan-add:resultset:custgrpid="1111",name="sip-tmr"
numan-add:resulttable:custgrpid="1111",resulttype="DEFAULT_TMR",dw1="2",setname="sip-tmr",
name="tmrdata"
numan-add:adigtree:custgrpid="1111",callside="originating",setname="sip-tmr",digitstring="
400"
DIGIT_REQ
The DIGIT_REQ result type indicates that insufficient digits were received for analysis to provide a
result with which call processing can be continued. This result type returns an indication to the call
module of how many more digits are required for analysis to be completed by subtracting the number of
digits returned in the analysis result type from the number of digits that have already been received.
Note This result type is for use with overlap signaling. Thus this result might not be initiated if the
protocol receiving it does not support overlap signaling.
DRP_EXIT
The DRP_EXIT result type directs the Cisco PGW 2200 Softswitch to exit from the DRP stage of
preanalysis.
For more information on provisioning procedures, see “Provisioning Domain Based Routing” section on
page 4-73.
DRP_EXIT has dataword1, drpExitType. DW1 drpExitType specifies the type of DRP exit. Valid values
are:
• 1 = Directs the Cisco PGW 2200 Softswitch to exit current DRP Step and move to the next step.
• 2 = Directs the Cisco PGW 2200 Softswitch to exit from entire DRP stage of pre-analysis.
DTMFCAP
The DTMF result type is returned from A-number or B-number analysis indicating the DTMF capability
of the number in the dial plan. This result type can be encountered during A-number or B-number
analysis and indicates the DTMF capability of the associated number in the dial plan. DTMF capability
on B-number analysis overrides DTMF capability on A-number analysis.
Dataword1 defines the capability of egress trunk group. The value range is 0 through 2.
• 0—Ignore DTMF capability
• 1—RFC 2833 DTMF capability
• 2—Out of band DTMF capability
E_PORTED_NUM
The E_PORTED_NUM result type is an indication to read the ported number data. The ported number
data can only be read if all digits have been received. Thus in enbloc processing can continue directly;
in overlap the Cisco PGW 2200 Softswitch must wait until sending is complete. The ported result can
be provisioned at the area code level, but the ported number is not accessed until the complete number
is received. See the “European Local Number Portability” section on page 1-88 for more information.
Note The E_PORTED_NUM result type is provisioned only when the Cisco PGW 2200 Softswitch is
in the donor switch capacity for European LNP.
E_ROUTE_NUM
The E_ROUTE_NUM result type indicates that the Cisco PGW 2200 Softswitch must remove the routing
number prefixing the Called Number, then access the number termination table to get a route list name
with which to route the call. See the “European Local Number Portability” section on page 1-88 for more
information.
Note The E_ROUTE_NUM result type is provisioned only when the Cisco PGW 2200 Softswitch is in
the recipient switch capacity for European LNP.
E911PROF
The E911PROF result type is returned from B-number analysis (the called number) indicating if the
B-number is an emergency call and the profile mapping to apply to emergency numbers.
Valid E911PROF dataword1 values are listed in Table 1-4.
FACILITY
The FACILITY result allows you to
• control redirection and call transfer behavior for originating and terminating devices.
• set SIP call handling to proxy mode for an individual call.
Note This capability requires that the sipModeSelectionControl parameter be set to permit B2BUA or
Proxy mode.
• observe how the Cisco PGW 2200 Softswitch handles redirection and SIP Refer.
Note You can configure FACILITY for source (A-number) or destination (B-number).
Note Value 5 and 6 determine the action taken when the terminating side of a call issues a redirect.
The Cisco PGW 2200 Softswitch can allow a SIP REFER on the terminating side of the call to be
propagated back to the originating side (SS7) of the call by sending a REL message containing the
redirection number and redirection information. You can enable this service by provisioning a
FACILITY result with DW1 set to 3 and DW2 set to 2.
Table 1-5 provides the call processing treatment applied according to the combinations of parameter
sipModeSelectionControl and the dataword values from the FACILITY result type. Unless otherwise
stated, sipModeSelectionControl is set to value 1 (b2bua optional).
Table 1-5 SIP and Non-SIP Call Processing Actions According to FACILITY Configuration
Dataword1 Dataword2
Value Value Call Processing Action on the Cisco PGW 2200 Softswitch
1 Any. Action is according to the value of the XECfgParm parameter sipModeSelectionControl:
• If sipModeSelectionControl=2, then the result-type is ignored because the main
parameter is set for proxy mode.
• If sipModeSelectionControl=1, then set the Cisco PGW 2200 Softswitch to indicate
that Proxy mode is required for this call.
2 (Originating 1 (Backward This combination of dw1 and dw2 sets the originating side redirection action to indicate
Redirection transit of that backward transit of a redirection is not supported on the originating side of the
treatment redirection to Cisco PGW 2200 Softswitch.
action) originating side When Cisco PGW 2200 Softswitch call control receives a redirection request from the
not allowed.) Cisco PGW 2200 Softswitch terminating side, it does not try to send back the redirection
to the preceding switch. The existing local handling of redirection (that is, using cause
analysis) applies.
(Applicable to SIP, DPNSS, and QSIG.)
2 (Originating 2 (Backward This combination of dw1 and dw2 sets the originating side redirection action to indicate
Redirection transit of that backward transit of a redirection is supported on the originating side of the
treatment redirection to Cisco PGW 2200 Softswitch.
action) originating side
If Cisco PGW 2200 Softswitch call control receives a redirection request from the
is supported
terminating side, it transits the request back to the originating side for sending out to the
unconditionally.
preceding switch. The only limitation is if the Cisco PGW 2200 Softswitch originating
)
side protocol cannot support this handling.
(Applicable to SIP, DPNSS, and QSIG.)
2 (Originating 3 (Backward This combination of dw1 and dw2 is appropriate for a SIP B2BUA call (that is, SIP
Redirection transit of originating and SIP terminating).
treatment redirection to If Cisco PGW 2200 Softswitch call control receives a redirection request from the SIP
action) originating side terminating side, it transits the request back to the SIP originating side for sending out to
is conditionally
the preceding network entity. This happens only if the domain in the From header received
supported on
within the original INVITE on the OCC side matches the domain received within the
matching
Contact header received back in the 302 message on the SIP terminating side.
domains.)
The redirection is transited back if the required domain of the redirected destination is the
same as that of the originator of this call.
(Applicable to SIP.)
Table 1-5 SIP and Non-SIP Call Processing Actions According to FACILITY Configuration (continued)
Dataword1 Dataword2
Value Value Call Processing Action on the Cisco PGW 2200 Softswitch
2 (Originating 4 (Backward This combination of dw1 and dw2 is appropriate for a SIP-originated call and can be
Redirection transit of either a B2BUA mode call or an interworking call.
treatment redirection to
If Cisco PGW 2200 Softswitch call control receives a redirection request from the
action) originating side
Cisco PGW 2200 Softswitch terminating side, it transits this back to the originating side
is conditionally
for sending out to the preceding switch, provided that the domain received within the
supported on
Contact header received back in the 302 message (terminating side) does not match the
nonmatching
Cisco PGW 2200 Softswitch domain.
domains.)
In an interworking call, this provision is met because the Contact header domain is absent
from the terminating side. If the call is SIP B2BUA, the provision is subject to the check
as described.
The redirection is transited back if the required domain of the redirected destination is not
the Cisco PGW 2200 Softswitch domain. Otherwise, the Cisco PGW 2200 Softswitch
can deal with this redirection locally.
(Applicable to SIP originating side.)
3 (Originating 1 (Backward This combination of dw1 and dw2 sets the originating side call transfer action to indicate
Call Transfer transit of call that backward transit is not supported on the originating side of the
treatment transfer to Cisco PGW 2200 Softswitch.
action) Originating side When Cisco PGW 2200 Softswitch call control receives a call transfer request from the
is not allowed.) Cisco PGW 2200 Softswitch terminating side, it does not try to send this back to the
preceding switch. The local handling of call transfer is invoked.
(Applicable to SIP and QSIG terminating side.)
3 (Originating 2 (Backward This combination of dw1 and dw2 sets the originating side call transfer action to indicate
Call Transfer transit of call that backward transit of a call transfer request is supported on the originating side of the
treatment transfer to Cisco PGW 2200 Softswitch.
action) originating side
If Cisco PGW 2200 Softswitch call control receives a call transfer request from the
is supported
terminating side, it transits the request back to the originating side for sending out to the
unconditionally. preceding switch. The only limitation on this is if the Cisco PGW 2200 Softswitch
) originating side protocol cannot support this handling.
(Applicable to SIP and QSIG.)
3 (Originating 3 (Backward This combination of dw1 and dw2 is appropriate for a SIP originated B2BUA mode call
Call Transfer transit of call where REFER actions have been requested on the Cisco PGW 2200 Softswitch
treatment transfer to terminating side.
action) originating side
With this setting, the backward transit of a REFER request is conditionally supported on
is conditionally
the originating side of the Cisco PGW 2200 Softswitch. When the
supported on
Cisco PGW 2200 Softswitch terminating SIP side receives a REFER request and passes
matching
the request back to call control, Cisco PGW 2200 Softswitch call control transits this
domains.)
request back to the Cisco PGW 2200 Softswitch originating side provided that the
received Refer-To header domain in the REFER message (terminating side) matches the
domain in the From header received within the original INVITE on the OCC side.
The REFER back is transited if the required domain of the refer-to destination is the same
as the originator of this call.
(Applicable to SIP.)
Table 1-5 SIP and Non-SIP Call Processing Actions According to FACILITY Configuration (continued)
Dataword1 Dataword2
Value Value Call Processing Action on the Cisco PGW 2200 Softswitch
3 (Originating 4 (Backward This combination of dw1 and dw2 is appropriate for a SIP originated B2BUA mode call
Call Transfer transit of call where REFER actions have been requested on the Cisco PGW 2200 Softswitch
treatment transfer to terminating side.
action) originating side
With this setting, the backward transit of a REFER request is conditionally supported on
is conditionally
the originating side of the Cisco PGW 2200 Softswitch. When the
supported on
Cisco PGW 2200 Softswitch terminating SIP side receives a REFER request and passes
nonmatching
this request back to call control, Cisco PGW 2200 Softswitch call control transits this
domains.)
request back to the Cisco PGW 2200 Softswitch originating side provided that the
received refer-to header domain in the REFER message (terminating side) does not match
the Cisco PGW 2200 Softswitch domain.
The REFER back transits if the required domain of the refer-to destination is not the
Cisco PGW 2200 Softswitch domain. Otherwise, the Cisco PGW 2200 Softswitch can
deal with this locally.
(Applicable to SIP.)
4 (Terminating 1 This combination of dw1 and dw2 is specific to a SIP-terminated call and is designed to
Redirection (Unconditional invoke SIP recursive redirection handling.
treatment SIP recursion.)
However, with this direct combination there is an inherent risk of looping. To avoid
action)
looping, the actual behavior associated with this combination is the same as the
combination of dw1=4 and dw2=3.
(Applicable to SIP.)
4 (Terminating 2 This combination of dw1 and dw2 is appropriate for the receipt of a redirection request
Redirection (Unconditional
on the Cisco PGW 2200 Softswitch terminating side.
treatment passing of In this situation, the terminating side checks the FACILITY setting for the appropriate call
action) redirection processing action. The value 2 indicates that this request can be passed back to
request back to Cisco PGW 2200 Softswitch call control for further handling.
call control.)
Note T he actual transit of the request back out on the Cisco PGW 2200 Softswitch
originating side depends on the FACILITY setting for that side.
The redirection request transits back to call control if the required domain of the
redirected destination is the Cisco PGW 2200 Softswitch domain where the
Cisco PGW 2200 Softswitch can deal with this request locally. If this is not the case, then
SIP recursion is used.
Table 1-5 SIP and Non-SIP Call Processing Actions According to FACILITY Configuration (continued)
Dataword1 Dataword2
Value Value Call Processing Action on the Cisco PGW 2200 Softswitch
4 (Terminating 4 (Conditional This combination of dw1 and dw2 is appropriate for a SIP terminated call where the
Redirection passing of Cisco PGW 2200 Softswitch SIP terminating side, on receipt of a 3xx response provoking
treatment redirection a redirection, checks the FACILITY setting for the appropriate call processing action.
action) request back to
The value 4 indicates that the request can be passed back into call control if the domain
call control on
in the received Contact header within the 3xx message does not match the domain in the
nonmatching
To header sent in the outgoing INVITE (and received back in the 3xx message). If this is
domains.)
the case, then the Cisco PGW 2200 Softswitch terminating side passes this request back
to Cisco PGW 2200 Softswitch call control for further handling.
Note The actual transit of the request back out on the Cisco PGW 2200 Softswitch
originating side depends the FACILITY setting for that side.
The redirection request passes back to call control if the required domain of the redirected
destination is not the same domain as that previously attempted in the outgoing INVITE.
If the domains are the same, then SIP recursion can be used (sending the new request out
to the same domain it is already set up to use).
4 (Terminating 5 Unconditional rejection of Redirection Request (SIP 302).
Redirection (Unconditional
treatment rejection of
action) Terminating
Redirection
/Call transfer
Request)
4 (Terminating 6 (Conditional Rejection of Redirection Request (SIP 302) when the CONTACT header is non- E.164.
Redirection rejection (if
treatment Non-E164) of
action) Terminating
Redirection
Request/Call
Transfer
request)
5 (Originating 1 This combination of dw1 and dw2 is relevant only when the redirection request has been
Redirection transmitted to the originating side. This combination determines how a rejection for the
Rejection request should be handled.
treatment A value 1 for dw2 means that if Cisco PGW 2200 Softswitch call control receives a
action) REJECT from the originating side in response to a redirection request, it transits the
REJECT to the terminating (that is, requesting) side.
(Applicable only to QSIG-QSIG calls.)
5 (Originating 2 This combination of dw1 and dw2 is relevant only when the redirection request has been
Redirection transmitted to the originating side and determines how a rejection for the request should
Rejection be handled.
treatment A value 2 for dw2 means that if Cisco PGW 2200 Softswitch call control receives a
action) REJECT from the originating side in response to a redirection request, call control
attempts to handle the redirection request locally by invoking cause analysis.
Note This is the default behavior in the absence of a provisioned originating redirection
rejection treatment action.
Table 1-5 SIP and Non-SIP Call Processing Actions According to FACILITY Configuration (continued)
Dataword1 Dataword2
Value Value Call Processing Action on the Cisco PGW 2200 Softswitch
6 (Terminating 5 Unconditional rejection of Call Transfer/Refer requests.
Call Transfer (Unconditional
treatment rejection of
action) Terminating
Redirection
/Call transfer
Request)
6 (Terminating 6 (Conditional Rejection of Call Transfer/Refer Requests when the Refer-To header is non-E.164.
Call Transfer rejection (if
treatment Non-E164) of
action) Terminating
Redirection
Request/Call
Transfer
request)
none none Default behavior
On the Cisco PGW 2200 Softswitch terminating side, the redirection or call transfer
request behavior defaults to passing the request back to call control where it can be
handled locally or, if there is an originating FACILITY result, propagated backwards to
the previous network entity.
On Cisco PGW 2200 Softswitch Originating side, the behavior defaults to local handling
by call control and cause analysis or half-call handling rather than transiting the request
back out on the Originating side.
FSM_REQ
The FSM_REQ result type indicates that the facility service markings (FSM) have not been supplied and
are required for the outgoing side.
GATEWAYPOOL
The GATEWAYPOOL result type enables the Cisco PGW 2200 Softswitch to override the GatewayPool
and AnchorMedia properties provisioned on the ingress or the egress trunk group. The GATEWAYPOOL
result type can be set on A number analysis or B number analysis. The B number analysis has greater
priority than A number analysis when a result type such as GATEWAYPOOL is provisioned on both A
number analysis and B number analysis. Specifically, if AnchorMedia is set to Never on the ingress and
egress sides in the dialplan, no media anchoring operates on ingress and egress call legs.
HLCMOD
The HLCMOD result type allows you to modify the High Layer Compatibility of outgoing Initial
Address Messages (IAMs) based on the dialed Called Party Number. You can provision this result type
using A and B number analysis.
The HLCMOD result type has the following datawords:
• HLC name—The name of the High Layer Compatibility, such as “fax-hlc01.”
IN_SERVICE_KEY
The IN_SERVICE_KEY result type permits the assigning of a service key value according to the
B-number. This result type allows multiple service keys, with each service key assigned according to the
B-number. Dataword1(any 32-bit integer value, with 0 allowed) is used to provision the IN service key
used when IN triggering is initiated toward the SCP.
If multiple service keys are required, then the IN_SERVICE_KEY result type must be configured in the
B-digit tree, along with the IN_TRIGGER result type. This means the IN_SERVICE_KEY result type
must be provisioned into the same result-set as the IN_TRIGGER. If the single service key solution is
adequate, then configure only an IN_TRIGGER result type. The IN_SERVICE_KEY result does not
require configuring.
The IN_SERVICE_KEY result type has the following datawords:
• IN Service Key—Any Integer value including 0.
• Global Title Digits Type—A string representing the type of the global title digits. Valid values are:
– CALLED
– CALLING
– FIXED
• Digits name—Name of the digit modification entry. Provision this dataword as follows:
– If DW2 is set to FIXED, use the numan-add:digmodstring command to build a fixed-digit
modification table and set the value of DW3 as name of the modification table.
– If DW2 is set to CALLED or CALLING, do not provision DW3.
– If DW2 is set to FIXED, you must provision DW3.
IN_TRIGGER
The IN_TRIGGER result type delivers a result from B-number analysis, which indicates that further
analysis by an SCP is required due to an intelligent network (IN) call. The data provided identifies the
service required (such as LNP) and, if necessary, an SCP/STP name for use when the TCAP call is made.
• Service Type—This returned value is provisioned in an internal file used to configure the handling
of IN requests by the trigger module. The value returned is not processed within analysis, but is
retrieved and passed back to the call module for action. This value is an indication of the type of IN
service that needs to be invoked to advance this call (LNP, 800, 900, and so on). The valid Service
Type values are contained in inService.dat. Valid values are
– 0 = IN_NONE
– 1 = IN_LNP
– 2 = IN_800
– 3 = ROUTE
– 4 = IN_PLAYANN
– 5 = IN_RELEASE
– 6 = INPREPAID
– 30 = IN_CNAM
• SCP/STP Index—Value used in the trigger module for selection of the SCP for TCAP query.
• Minimum Digits Required—The minimum number of digits (0 through 32) required to be received
for further analysis.
• Timer—The timer value (1 through 30, in seconds) used to delay the triggering if required. This
timer can be started when the min digits required (dw3) are received.
INC_NUMBERING
The INC_NUMBERING result type returns information regarding the incoming trunk group side (OCC).
This information sets the numbering criteria (overlap or en bloc) and the minimum and maximum
numbers of digits permitted for the incoming trunk group side.
• Numbering Type—0 = Closed numbering (en bloc) or 1 = Open numbering (overlap).
• Minimum and Maximum digits—Refers to the minimum and maximum number lengths.
In the case of closed numbering (en bloc), these values should be equal.
The data returned in this result type are used to overwrite default values loaded into the OCC at startup.
IP_SOURCE_SCREEN
The IP_SOURCE_SCREEN result type provides screening capabilities for non-E.164 calls. This result
is supported for blacklist screening only.
For more information on provisioning procedures, see “Provisioning Domain Based Routing” section on
page 4-73.
IP_SOURCE_SCREEN has the following data words:
• screenType (dw1)—The type of blacklist screen to apply. Valid values are:
– 1= Blacklist screening of source (username + host domain)
– 2= Blacklist screening of source username only
– 3= Blacklist screening of source host domain only
• serviceName (dw2)—The name of the service.
• foundSetName (dw3)—An existing result set which the PGW executes if it finds a match in the IP
Source Screening table.
• notFoundSetName (dw4)—An existing result set which the PGW executes if it does not find a match
in the IP Source Screening table.
IP_DEST_TRANS
The IP_DEST_TRANS result type translates a destination into another format, such as an E.164
destination (domain) to a non-E.164 destination (phone number). You can also use IP_DEST_TRANS
to translate a non-E.164 destination to another non-E.164 destination (a domain name to another domain
name). It can do the following translations:
• A domain to a phone number: contactname@cisco.com translates to 1234567890@cisco.com.
• A phone number to a domain: 1234567890@cisco.com translates to contactname@cisco.com.
• A domain to another domain: contactname@cisco.com translates to contactname@example.com.
For more information on provisioning procedures, see “Provisioning Domain Based Routing” section on
page 4-73.
IP_DEST_TRANS has the following data words:
• inputAndAction (dw1)—Determines whether the Cisco PGW 2200 Softswitch translates the
destination of the user and host (1) or the destination host only (2).
IP_ROUTE_SEL
The IP_ROUTE_SEL result type allows the Cisco PGW 2200 Softswitch to select a route based on a
destination user or domain name, source user or domain name, or a combination of the two.
For more information on provisioning procedures, see “Provisioning Domain Based Routing” section on
page 4-73.
IP_ROUTE_SEL has the following data words:
• inputDataType (dw1)—Specifies the data that the Cisco PGW 2200 Softswitch uses to select the
route. Valid values are:
– 1 = Route selection against destination (user + host)
– 2 = Route selection against destination host only
– 3 = Route selection against source (user and host)
– 4 = Route selection against source host only
– 5 = Route selection against both destination (user and host) and source (user and host)
– 6 = Route selection against both destination (host only) and source (host only)
– 7 = Route selection against both destination (user and host) and source (host only)
– 8 = Route selection against both destination (host only). And source (user and host)
• serviceName (dw2)—Service name which must already exist in the service table (optional).
• foundSetName (dw3)— Result set name which must already exist in resultSet table, for execution
conditional on a match being found in the table.
• notFoundSetName (dw4)—Result set name which must already exist in resultSet table, for
execution conditional on no match being found in the table.
IP_SET_SOURCE_DMN
The IP_SET_SOURCE_DMN result type allows you to set the source domain name for domain-based
calls. This result is supported for preanalysis and A and B number analysis only.
For more information on provisioning procedures, see “Provisioning Domain Based Routing” section on
page 4-73.
IP_SET_SOURCE_DMN has the following data words:
• dmnString (dw1)—The name of the source domain.
• applicationStatus (dw2)—Specifies whether the command can override an existing domain name
entry. The following values are valid:
– 0 = The command can override an domain name entry.
– 1 = The command cannot override an existing domain name entry.
• applyTo (dw3)—Specifies which source headers to which the PGW applies the command. The
following values are valid:
– 0 = Sets the PGW to apply the command to all source headers that are present.
– 1 = Sets the PGW to apply the command to the current source header only.
LOC_LABEL
The LOC_LABEL result type is returned from A-number analysis (the calling number) or B-number
analysis (the called number) and indicates the location label.
Dataword1 is the location label name, and can be as many as 20 alphanumeric characters.
MGCPDIALPKG
The analysis performed on a call is determined by the route the call takes to the
Cisco PGW 2200 Softswitch. A call is considered either to be a TDM-switched call or an NAS call.
A call is considered to be a TDM-switched call if both call endpoints (that is, the originating and the
terminating endpoints) are on the same gateway. As a result, hairpinning is required and no special result
type from generic analysis is needed for this type of call.
However, for a NAS call, the MGCPDIALPKG result type is returned from generic analysis. As a result
of this, the NAS package is used to set up the MGCP connection on gateways.
MGCPDIALPKG calls are based on the dial plan provisioning of the MGCPDIALPKG result type,
which is provisioned against the B-number digit numbers. Thus MGCPDIALPKG calls take place on a
call-by-call basis, which can occur along with regular voice calls, according to the B-number result type.
The Cisco PGW 2200 Softswitch receives an inbound call from the PSTN and enters B-number analysis
(that is, the B-number). The MGCPDIALPKG result type is provisioned against the B-number. The
following result types are available from generic analysis, which are based on the MGCPDIALPKG
result type:
• Digital Data NAS Call
• Analog Data NAS Call
• Dynamic NAS Call
A dynamic call type is where the NAS advises the bearer type is digital only if transmission media
requirements indicate 64 kbps unrestricted data service for the call. If the bearer type is not 64 kbps
unrestricted data, the NAS is advised the call is analog and the NAS can determine, based on the bearer
stream, the call type. This checking is made in generic analysis.
The MGCPDIALPKG result has two datawords: dataword1 and dataword2. Dataword1 has three
different values (Digital, Analog, or Dynamic) that provide call type information.
If the result type from the B-number digit analysis is MGCPDIALPKG, and dataword1 is Digital or
Analog, then conditional route analysis and Route analysis are not performed.
However, if the result type from the B-number digit analysis is MGCPDIALPKG, and dataword1 is
Dynamic, then the bearer type is checked to see if it is 64 kbps unrestricted data. If the bearer type is
64 kbps unrestricted data, then the bearer type is set to DIGITAL. However, if the bearer type is not
64 kbps unrestricted data, then the bearer type is set to ANALOG.
No routing is performed if analysis receives an MGCPDIALPKG l result type, since this is a data call to
a one legged MGCP connection. The data call is connected to the 5350/5400/5800 gateway and therefore
no circuit selection is needed.
With regard to dial plan data, the MGCPDIALPKG result is configured only when MGCPDIALPKG
calls are required, and the result type is configured against the B-number in generic analysis only.
Dataword2 is a Boolean value (1 or 0) that indicates whether an ACM message is necessary in the call.
Dataword2 is used to indicate whether to send (1) or not send (0) the ACM message.
When the MGCPDIALPKG result type is provisioned, it is provisioned in the dial plan only against the
B-numbers and is read in generic analysis to determine if this call is an MGCP DIAL call.
For MML command configuration examples of intermediate MGCPDIALPKG results, see the “Adding
the MGCPDIALPKG Result Type” section on page 4-17.
NEW_DIALPLAN
The NEW_DIALPLAN result type can be returned from Pre-analysis, A-number analysis, B-number
analysis, or Cause analysis. It indicates the need to read the dial plan and check to see if a new dial plan
should be used. If a new dial plan identity (CustGrpID) is found, this result initiates its selection. Once
the new dial plan is selected, Pre-analysis can be restarted.
• CustGrpID—This dataword is relevant in all cases and supplies a customer group ID that is used
to read the dial plan. It must be a valid customer group ID.
• AnalysisType—This dataword indicates the next stage of analysis, once the new dial plan is
identified and invoked.
Valid values for dataword2 are dependent on the analysis stage from which the NEW_DIALPLAN
result is returned, as shown in the following table.
If the NEW_DIALPLAN result is returned from Pre-analysis, only the following value is valid:
– 1 = Returns to the Pre-analysis stage in the new dial plan
If the NEW_DIALPLAN result is returned from A-number analysis, only the following value is
valid:
– 0 = Default (dataword2 has no relevance from A-number analysis)
If the NEW_DIALPLAN result is returned from B-number analysis, the following values are valid:
– 1 = Returns to the Pre-analysis stage in the new dial plan
– 2 = Restart in B-number analysis in new dial plan
If the NEW_DIALPLAN result is returned from Cause analysis, only the following value is valid:
– 2 = Restart in B-number analysis in new dial plan
The provisioning code checks to ensure that the new dial plan to be selected by the NEW_DIALPLAN
result type is not the same as the current dial plan to avoid the possibility of a loop situation.
Domain-Based Routing modifies the NEW_DIALPLAN result type to allow the PGW to re-start at the
A Number stage of analysis. To use this setting, set dataword 2 to a value of 3.
NUM_TRANS
The NUM_TRANS result type is returned from A-number (the calling number) or B-number analysis
(the called number) indicating that one or more numbers encountered require full replacement.
This feature requires setting the *.FNTBehaviourOptions parameter in the XECfgParm.dat file on initial
configuration. The *.FNTBehaviourOptions parameter has two valid values, 0 and 1. When
*.FNTBehaviourOptions is enabled (set to value 1), if a successful number translation occurs,
A/B/Redirecting number modifications through AMODDIG/BMODDIG/RMODDIG configured in the
same result set with NUM_TRANS will get dropped.
If you are going to use this feature for the first time, you are recommended to set the value of
*.FNTBehaviourOptions to 1. The value 0 is used for consistency with the existing behavior of the full
number translations function.
See the “Provisioning Full Number Translations” section on page 4-69 for provisioning procedures of
full number translations.
The NUM_TRANS result type has the following datawords:
• ServiceKey—An integer representing the previously provisioned Service Name in the Service table.
This is a user-controlled key into the Times Ten query full number translation table. Digit strings
stored in the full number translation table are case insensitive. That is to say, if digit strings that you
provisioned contain alphabetic characters, the TimesTen database saves them as uppercase
characters in the full number translation table.
Note The service key must reference a previously provisioned service name.
• Number Type—An integer indicating the number type being translated. Valid values are:
– 1 (CdPn)—Called party number
– 2 (CgPn)—Calling party number
– 3 (Rdn)—Redirecting number
– 4 (Rdn and CgPn)—Calling party number and Redirecting number. Both numbers are replaced
if the calling party number is found in the TimesTen database.
– 5 (OCN)—Original called number.
• Nature of Address (NOA)—(Optional) An integer value that indicates the NOA value for the number
type being translated. Valid values are 0 through 55.
Note This field is updated only if a successful match is found in the full number translation table.
• Dial plan—(Optional) This is a 4-digit integer that represents the previously provisioned dial plan(s)
in the Cisco PGW 2200 Softswitch. Valid values for this dataword are existing dial plan indexes,
which are 0001 through 9999.
Note The dial plan changes only if a successful lookup occurs in the full number translation table.
Note The dial plan must reference a previously provisioned dial plan name.
When a successful NUM_TRANS lookup occurs, it takes precedence over all other results in the result
set. If the NUM_TRANS result is not successful, all remaining results in the result set are performed.
Thus it may be advisable to complete any dial plan changes before resuming number analysis. After a
successful number replacement, the flexibility of this result can cause confusion in cases where
A-number replacements are successful in B-number Analysis and B-number replacements are successful
in A-number Analysis. In the dial plan, you can place A-number replacements in A-number analysis and
B-number replacements in B-number analysis. Thus occurrences of replacements become more obvious
and logical.
The following items further describe the behavior of the NUM_TRANS result type:
• NUM_TRANS result types can be present in both A-number analysis or B-number analysis.
• Because the NUM_TRANS result type causes an entire number replacement to occur, the nature of
address may also be replaced.
• Both the NOA changes and dial plan changes provisioned against the NUM_TRANS result type are
only acted on when a successful database lookup occurs.
• When a successful number translation occurs, a return to Pre-analysis is required.
• When a dial plan change is encountered, analysis begins at the Pre-analysis stage in the new dial plan
• The NUM_TRANS result has priority in terms of the handling of all results and causes analysis to
resume when a successful result is found.
• When multiple NUM_TRANS result types are encountered, longest matching is performed. As a
result, the last successful database lookup against a specific number type is acted on, and any
previous NUM_TRANS results against the same number are overwritten. As a result, a previous
NUM_TRANS result may have successfully matched and a later NUM_TRANS result may fail; due
of longest matching, only the last NUM_TRANS result encountered for the number type is effective.
• If a full number translation database lookup is not successful at any digit length, then any other digit
modifications and result types are acted on.
• Although a NUM_TRANS result can be declared at any digit length, the number used for
comparison purposes is the entire dialed number.
• For overlap sending, any NUM_TRANS result encountered causes a wait until all digits are received
before a database comparison is performed.
• The number presented to the full number translation database is the full dialed number, without any
other digit modifications that may have been encountered in other result types.
• If multiple NUM_TRANS result types, with different number types, are contained in a result set;
but all NUM_TRANS result types indicate a dial plan change, then the longest match on the dial
plan change occurs. Thus the dial plan change indicated in the last successful database lookup of a
number type is used.
• A successful database lookup indicating a dial plan change overrides explicit dial plan change
results that may also be present in a result set.
ORIG_VPN_ID
The ORIG_VPN_ID result type is returned from A-number analysis (the called number) indicating the
originating VPN ID and if the originating index is on net or off net. Before you use this result type, you
need to add the VPN ID by using numan-add:customervpnid:custgrpid=<customer group ID>,
name=<VPN ID>. Then you can use an existing VPN ID for dataword1 of this result type.
This result type has the following datawords:
• VPN ID (dataword1)—Valid values are existing VPN IDs (8-digit alphanumeric character string).
• VPN onnet profile index (dataword2)—Valid values are a single integer from 1 to 8, with a default
value of 5.
• VPN offnet profile index (dataword3)—Valid values are a single integer from 1 to 8, with a default
value of 6.
OTG_NUMBERING
The OTG_NUMBERING result type returns information regarding the outgoing trunk group side
(Terminating Call Control). This information sets the numbering criteria (that is, overlap or en bloc), and
the minimum and maximum permitted digits for that side.
• Numbering type—0 = Closed numbering (en bloc), 1 = Open numbering (overlap).
• Minimum and maximum digits—This refers to the minimum number length and the maximum
number length. (In the case of closed numbering, these values should be equal.)
OVERRIDE_CALLIM
The OVERRIDE_CALLIM result type indicates that the location label call overrides the call limiting
value. Presence of the OVERRIDE_CALLIM result type indicates that for this call, any call limiting
actions are ignored allowing it to being set up as soon as possible.
The OVERRIDE_CALLIM result type is available to Pre-analysis, A-number analysis, and B-number
analysis. Since OVERRIDE_CALLIM is available to these analysis areas, the override indicator can be
set for the following:
• Calling Party Category (CPC)—Pre-analysis
• Calling party number Nature of Address (NOA)—Pre-analysis
• Called party number Nature of Address (NOA)—Pre-analysis
• Calling party number address digits—A-number analysis
• Called party number address digits—B-number analysis
The OVERRIDE_CALLIM result type can be used for an emergency call or other high-priority calls.
This result type allows those calls to be set up without any obstacles, such as call limiting. Even if
LOC_LABEL results are collected, the presence of the OVERRIDE_CALLIM result type means that no
call limiting actions are applied for this call.
PERC_ROUTE
The PERC_ROUTE result type provides an entry into the Percentage Routing lists. The Percentage
Route list name is used as the starting point in the Routing analysis process.
PNMODDIG
The PNMODDIG result type modifies the presentation number received in any incoming message. This
parameter populates or modifies a specified number of digits from any point in the GN-ACgPN, or
Presentation Number.
Dataword1 (Application point) indicates the point (the digit) in the digit string that the
Cisco PGW 2200 Softswitch begins applying the modification. The range is from 1 through the total
number of digits in the digit string (32 maximum). Entering a value of “98” causes the removal of digits
to begin at the end of the digit string and move backward to the beginning.
Dataword2 (Number of digits to remove) indicates the number of digits to remove. The range is from 0
through the number of digits remaining in the digit string from the application point (32 maximum). To
remove all digits, regardless of the number of the number, enter the value 99.
Dataword3 (Modification name) indicates the name of the modification string. If required, this is a name
that specifies the digit modification string that is to be inserted beginning at the application point.
PN_NPI_TYPE
The PN_NPI_TYPE result type is for NPI and PN. The call context is updated, including A-number
screening indication, A-number presentation indication, A-number NPI value, generic number NOA
value, generic number screening indication, generic number presentation indication, and CBI_IND for
BTNUP and UKISUP protocol variants, based on generic analysis results.
All results are collected and then are processed in a logical order. First the Cisco PGW 2200 Softswitch
checks for any call rejection cases (for example, Analysis failure, Cause, or Blacklist). Then, the
Cisco PGW 2200 Softswitch handles any results that are processed before others (for example,
screening (no point in additional processing if this does not pass)) or ported number handling where a
number must be prefixed and then passed back in to start analysis again. Then any results, (for example,
More information requests, and Test calls), and then finally all other results (ROUTE -Number
modifications, and so on) are processed.
Dataword1 is the internal NPI value. The value range is 0 (default) through 10.
PN_NUMBER_TYPE
The PN_NUMBER_TYPE result type is used to modify the number type of the presentation number. The
NOA modification field of the presentation number or the generic number is modified.
Dataword1 value is the internal NOA value. The value range is 0 (default) through 53.
PN_PRES_IND
The PN_PRES_IND result type is the presentation indicator of the presentation number, or the generic
number is modified with this result type.
Dataword1 is the presentation number indicator value. The value range is 1 through 3.
• 1 = Restricted
• 2 = Allowed
• 3 = Unavailable
PN_SCREEN_IND
The PN_SCREEN_IND result type is the screening indicator of the presentation number, or the generic
number is modified with this result type.
Dataword1 is the presentation number screening indicator value. The value range is 1 through 5.
• 1 = NP (Network Provided)
• 2 = UPVP (user provided verified and passed)
• 3 = UPNV (user provided not verified)
• 4 = UPVF (user provided verified and failed)
• 5 = spare1
PREFIX_CONVERT
The PREFIX_CONVERT result type allows the Cisco PGW 2200 Softswitch to support prefix
modification for connected number, redirection number, and transferred number. PREFIX_CONVERT
can work for SIP-to-ISUP, ISUP-to-SIP, and ISUP-to-ISUP connected numbers. It cannot work for
SIP-to-SIP connected number.
Note The prefix modifications are based on the original calling/called/generic number received on the
originating side.
REDIRECT
The REDIRECT result type allows a call to be redirected based on call properties such as the A number
or B number. REDIRECT can be provisioned for A or B Number analysis.
ServiceKey—Dataword1 (dw1) is an integer representation of the name of the provisioned service
(ServiceName).
Note The redirect server feature is enabled for DPNSS only. It does not work for SIP.
RETRY_ACTION
The RETRY_ACTION result type can be provisioned only in Cause analysis and provides the required
actions with regard to route advance, reattempt, or redirection. This result has one integer data word that
represents the required action. You can also configure the stage of analysis in which the
Cisco PGW 2200 Softswitch restarts when retrying a call. This capability provides consistent
redirection handling for E.164 and non-E.164 calls.
RETRY_ACTION 1 has the following datawords:
• RetryType (dw1)—Manner in which the Cisco PGW 2200 Softswitch retries the call. Valid values:
– 1 = Reattempt
– 2 = TGAdvance
– 3 = Redirect
Reattempt: The reattempt function is controlled by the “Reattempts” value that is provisioned in
Trunk Group Data. Reattempts only take place up to the limit of this provisioned value. If the
counter is exceeded, then instead of a Reattempt a trunk group advance takes place.
TGAdvance: A property “MaxNumTGAdvances” contains a value defined in the XECfgParm.dat
file. Should the value limit be met or exceeded, the call is released using the existing cause (Treated
Cause result).
Redirect: Redirection processing is only for the ISUP protocols and is limited to a maximum of 5
redirections by the system property “RedirMax”. The MGC checks within Generic Analysis before
processing the result, ensuring it is processed only if the value is less than 5 and less than the setting
of the RedirMax property. Should the received counter value already be at 5, or exceed the
configured threshold the result is ignored and the call released by use of the existing cause value.
The Generic Analysis module returns a “Treated Cause” result. Clear the call by normal release
mechanisms, then call a common routine that makes a new analysis request for A, B, and Routing
analysis (forwarding the Re-direction number as the B-number). The expected response is a new
trunk group upon which to attempt circuit selection.
• redirAnPhase (dw2)—Phase of analysis in which the Cisco PGW 2200 Softswitch restarts when
retrying a call. Valid values:
– 0 = Redirection next analysis phaseB-number analysis (default value)
– 1 = Redirection next analysis phase Pre-Analysis
RMODDIG
The RMODDIG result type is for digit modification on the redirecting number. The capability exists to
remove a specified number of digits from any point in the redirecting digit string and replace them with
whatever digits are required.
The RMODDIG result type has the following datawords:
• Application point—The point (digit) in the digit string to begin applying the modification.
The range is from 1 through the total number of digits in the digit string (32 maximum). Entering a
value of “98” causes the removal of digits to begin at the end of the digit string and move backward.
• Number of digits to remove—The range is from 0 through the number of digits remaining in the
digit string from the application point (32 maximum). To remove the entire number, regardless of
the number of digits it contains, enter the value “99” for this dataword.
• Modification name—If required, this is a name that specifies the digit modification string that is to
be inserted beginning at the application point.
• Remove Leading Digits—When dw4 is set to 0, the Cisco PGW 2200 Softswitch uses the
RMODDIG result type as normal. When dw4 is set to 1, the Cisco PGW 2200 Softswitch removes
leading digits from the Redirecting Number and the original called number. When dw4 is set to 2,
if the incoming redirecting number is NULL, the Cisco PGW 2200 Softswitch does not insert one
redirecting number. For other cases, the Cisco PGW 2200 Softswitch behaves as before.
Note If the leading digit of the original called number is 0, it can be removed as the Redirecting Number when
dw4 is set to 1.
Dataword rules:
• Dataword1 must be 1 through 32 or 98.
• Dataword2 must be 0 through 32 or 99.
• Dataword3 must be 0 or an existing digit modification name.
• Dataword4 must be 0 through 2.
For example, if the application point = 1, the number of digits to remove = 5, and the modification name
gives a result of 1321, then begin at the start of the digit string, remove 5 digits, and replace them with
the digit string 1321. This yields a redirecting number as follows:
• Redirecting number received pre-analysis = 01444 567891
• Redirecting number post analysis = 1321 567891
For example, if the application point = 98, the number of digits to remove = 4, and the modification name
gives a result of 1321, then begin at the end of the digit string, remove 4 digits, and replace them with
the digit string 1321. This yields a redirecting number as follows:
• Redirecting number received pre-analysis = 12345567891
• Redirecting number post analysis =12345561321
Depending on the analysis area that invokes it, the RMODDIG result type has different functions. The
following are examples of these different functions:
• In Pre-Analysis there are currently four serial stages that can produce the RMODDIG result type. In
Pre-analysis, the results are cumulative. For example, if the CPC stage generates an RMODDIG
result type, then the redirecting number is modified according to the result and this modified number
then is the new redirecting-number passed as input to the next Pre-analysis stage (TMR analysis). If
the TMR analysis provokes another RMODDIG result type, then it further modifies the number and
so on. Even though multiple modifications like this would seem excessive and unnecessary, the
capability exists to ensure the required flexibility is provided.
• In Number analysis (A-number or B-number), functionality is different. Here digit analysis is
applied (digit by digit) and it is possible to have the RMODDIG result type at multiple points if
required. However, it is only the last modification result type that is applied.
Note Digit modification is applied to the initial number input to this analysis stage. There is no
cumulative digit modification performed.
For example, if the received redirecting number is 1234 and at “1” an RMODDIG result type is
received making the number 441234, the digit string is modified and analysis continues according
to the digit analysis configuration. If another RMODDIG result type is received at 1234, making the
number 551234, the earlier RMODDIG result type (“1”) is discarded and the number now sent
forward is 551234.
R_NUMBER_TYPE
The R_NUMBER_TYPE result type lets you change the redirecting number type nature of address
(NOA) from that presented in the IAM or Setup message. This result type is available to Pre-analysis,
A-number analysis, B-number analysis, Cause analysis. R_NUMBER_TYPE uses the following data
words:
• Dataword1 (dw1) provides the Cisco PGW 2200 Softswitch internal call context value for the
(NOA) of the redirecting number.
• Dataword2 (dw2) determines whether the Cisco PGW 2200 Softswitch updates the nature of
address (NOA) of the original called number (OCN). Dataword2 has the following values:
– 0 — The NOA of the OCN is not modified. This is the default value.
– 1 — The NOA of the OCN is changed according to the redirecting number. For example, if dw1
is set to 5 and dw2 is set to 1, the NOA of the redirecting number and the NOA of the OCN are
changed to “international.”
Note The NOA value needs to be the MGC internal value and not the protocol-specific value. See Appendix A,
“NOA and NPI Codes, CPC and TMR Values” for specific protocol values.
ROUTE
The ROUTE result type supplies a Route List name, which is used as a starting point in the Routing
analysis process.
Note The ROUTE result type is not used in a Cisco PGW 2200 Softswitch (signaling) application.
ROUTE_PREFERENCE
The ROUTE_PREFERENCE result type is applicable only to A-number analysis. It provides an
indication of preferred egress trunk group type in relation to the received A-number. The value set in the
result (see the following list of possible values) is used within the Routing analysis stage and provides
a further bias to the trunk group selection algorithms.
The possible values for ROUTE_PREFERENCE are as follows:
• 0 = RTE_SEL_DONT_CARE
• 1 = RTE_SEL_ATM_ESSENTIAL
• 2 = RTE_SEL_ATM_PREFERRED
• 3 = RTE_SEL_ATM_EXCLUDED
• 4 = RTE_SEL_IP_ESSENTIAL
• 5 = RTE_SEL_IP_PREFERRED
• 6 = RTE_SEL_IP_EXCLUDED
• 7 = RTE_SEL_TDM_ESSENTIAL
• 8 = RTE_SEL_TDM_PREFERRED
• 9 = RTE_SEL_TDM_EXCLUDED
RTRN_START_ANAL
The RTRN_START_ANAL result type performs different actions depending on what stage of the analysis
generates it:
• In B-number analysis, this result type causes the carrier code prefix, if any, to be deleted and
B-number analysis is restarted with the modified B-number.
• In Cause analysis, this result type initiates a return to B-number analysis; however, the B-number to
be analyzed will include any modifications and any NOA call type modifications.
SCREENING
The SCREENING result type delivered from either A-number or B-number analysis indicates that the
A-number or redirecting number must be screened against the screening files configured for a specific
customer group ID. ScreenType values 3 and 4 are added in MGC software Release 9.4(1), allowing
screening to occur using the global customer group ID GLBL as the input key. Dataword1 (screen type)
identifies the type of screening that must be requested. Dataword2 (service name) is only used when
screening is requested from B-number analysis and identifies the database list of A-Numbers and
redirecting numbers that must be screened, which are appropriate to the B-number. Dataword3 is the
index to the dialPlan selection table if the screening passes. Dataword4 is the index to the dialPlan
selection table if the screening fails.
• ScreenType—Must be one of the following:
– 1 = Whitelist—If the presented A-number or redirecting number is not found in the screening
files, then the screening is considered to have failed and the call is released.
– 2 = Blacklist—If the presented A-number or redirecting number is found in the screening files,
then the screening is considered to have failed and the call is released.
– 3 = Global Whitelist—If the presented A-number or redirecting number is not found in the
screening files, then the screening is considered to have failed and the call is released. Added
in software Release 9.4(1).
– 4 = Global Blacklist—If the presented A-number or redirecting number is found in the
screening files, then the screening is considered to have failed and the call is released. Added
in software Release 9.4(1).
• Service Name—When screening is triggered by B-number analysis, a service name (such as “800,”
“900,” or “FreePhone”) is used to identify which list of calling numbers (A-numbers) is associated
with that service. The service name is passed, as read, when the screening request is made.
Note Service names are limited to 10 alphanumeric characters. Spaces are not allowed.
• Pass_DpIdx—(optional) Provides an index for dial plan selection if the screening type, which is
available only for A-number analysis, passes. Also includes B-number analysis in software Release
9.6(1). If the screening passes, the dial plan index from this dataword is used to cause a dial plan
change and then processing returns to pre-analysis. If no index value is present, number analysis
continues. Added in software Release 9.4(1).
• Fail_DpIdx—(optional) Provides an index for dial plan selection if the screening type, which is
available only for A-number analysis, fails. Also includes B-number analysis in software Release
9.6(1). If the screening fails, the dial plan index from this dataword is used to cause a dial plan
change, and then processing returns to pre-analysis. If no index value is present, number analysis
continues. Added in software Release 9.4(1).
SCRIPT
The SCRIPT result type can be provisioned for B-number analysis, and is an end-of-analysis result type.
• ScriptId—Dataword1 (dw1) is an integer and provides an index into the Script table in the database,
where the details (for example, Gateway type, script type, script location, and optional script
parameters) are stored.
• CallType—Dataword2 (dw2) is an integer and indicates the CallType associated with this result
type. A value of 1 hands over call control to the gateway, with script invocation. Currently, only this
result type is supported.
SIPI_CONTROL
The SIPI_CONTROL result type allows you to enable the SIP-I route preference and to overwrite the
outgoing SIP-I related configuration parameters on the outgoing trunk group. Currently this result type
is used to enable the SIP-I route preference only.
Dataword1 enables the route preference. A value of 1 enables the route preference.
SIPTNS
The Carrier Identification Code is a three- or four- digit code used in routing tables to identify the
network that serves a remote user when a call is routed over many different networks. The SIP CIC
parameter transmits the CIC value from the SIP network to the ISDN. The SIP CIC parameter is carried
in SIP INVITE requests and maps to the ISDN Transit Network Selection Information Element (TNS
IE).
The SIP TNS result type allows you to map the CIC from the SIP INVITE parameter to the TNS IE in
the outgoing IAM message for ANSI ISUP. The Cisco PGW 2200 Softswitch uses the called party
number (B number) and the SIP CIC to populate the TNS IE.
Table 1-6 shows the format of the TNS parameter with a 4-digit carrier identification code.
8 7 6 5 4 3 2 1
H G F E D C B A
Spare Type of network Network identification plan
identification
Digit 2 Digit 1
Digit 4 Digit 3
Circuit code Reserved
The Cisco PGW 2200 Softswitch uses the following values to populate the TNS:
• Type of network identification—010 (National Network Identification)
• Network identification plan— 0010
• Digits 1–4—The Cisco PGW 2200 Softswitch inserts the four-digit CIC value from the SIP URI.
• Circuit code—The Cisco PGW 2200 Softswitch uses a binary version of the first digit of the called
party number (B number).
Note You can also manually set the circuit code value using the circuit code data word.
TERM_INFO
The TERM_INFO result type is used to enable full called number analysis to make a call to the Number
Termination table (TERMTBL), which provides a route list name to start routing analysis. You can
reduce the size of a dial plan to achieve a full called number analysis. The TERM_INFO result type is
configured early in the B-number analysis. All actions are implicit by the presence of this result type;
consequently, there are no datawords accompanying this result.
TESTCALLDETECTED
The TESTCALLDETECTED result type is used to indicate that the called number (B-number) is
associated with a test call. The parameters associated with this result type are:
• Test Line Type—Can be one of the following values:
– 0 = Quiet termination (qt)—this is the default value
– 1 = Old milliwatt (1000 Hz)
– 2 = New milliwatt (1004 Hz)
– 3 = Really new milliwatt (1013.8 Hz)
– 4 = Tone off
• Test Line Duration—The duration of the test signal in milliseconds. The range of duration values
is 0 through 65,535 milliseconds. The default value is 0.
• Test Line Name—Can be up to 20 alphanumeric characters. The test line name is always converted
to lowercase in the provisioning object library.
VIDEO_ALLOWED
The VIDEO_ALLOWED result type enables the Cisco PGW 2200 Softswitch to allow or prohibit video
calls at the dial plan level.
There are two levels of video call admission control, the dial plan level and the trunk group level. If video
calls are allowed at the trunk group level but prohibited at the dial plan level, video calls are prohibited.
If video calls are prohibited at the trunk group level but allowed at the dial plan level, video calls are
prohibited.
This result type provides you the flexibility to include video call admission control in the number
analysis. For example, you can prohibit video calls whose B-numbers start with 909.
Dataword1 specifies whether the Cisco PGW 2200 Softswitch allows or prohibits video calls:
• 0 = Prohibits video calls at the dial plan level.
• 1 = Allows video calls at the dial plan level.
If you do not provision the VIDEO_ALLOWED result type, the Cisco PGW 2200 Softswitch allows
video calls at the dial plan level by default.
WHITELIST
The WHITELIST result type returned from B-number analysis indicates that the called number is valid
and that call processing can proceed. No datawords are used and any call processing action is implicit
by the presence of the result type. No call screening is associated with this result type.
Note When you are using a default result type on a Cisco PGW 2200 Softswitch, in signaling mode,
results of the WHITELIST result type for B-numbers should contain routing information to
prevent the analysis from dropping through to the default result type. This result takes the place
of the ROUTE result used with the Cisco PGW 2200 Softswitch in call control mode, and
ensures that the call completes. Absence of the WHITELIST result type invokes the default result
type on a Cisco PGW 2200 Softswitch in signaling mode.
Note All result matches for a digit string are added together and only duplicate result types are overwritten by
the longest match.
As a result, there are a number of transparent stages in result processing, which may not be apparent
when provisioning, at such time it may appear that the defined order has a bearing on the final result. It
is also important to note that where the same digit analysis root is used as a fork for several different
result set actions, some result types (even though defined within different result sets) may impact one
another.
This means that at certain points you can encounter results that stop processing at a point and must make
an immediate response for action, for example, whether to provoke call clear down or a more information
backward request (as shown in Figure 1-7).
Analysis
request
Direct response
results
Early processed
results
Remaining
direct response
results
All other
results
Analysis
response 80688
The tables in the following sections categorize the result types so you can understand at what point in
the logical hierarchy they are processed. The results are separately tabulated for A-number, B-number,
and Cause analysis stages.
Pre-analysis Stages
Table 1-7 lists the result types for Pre-analysis. Result types include direct response and all others.
Table 1-8 lists the result types for A-number analysis. Result types include direct response, early
processed, remaining direct responses, and all others.
Table 1-9 lists the result types for B-number analysis. Result types include direct response, early
processed, remaining direct responses, and all others.
Table 1-10 lists the result types for Cause analysis. Result types include direct response results and all
other results.
The following examples provide the call processing order for different combinations of results in a result
set:
Example 1
The result set includes ROUTE, BMODDIG, B_NUMBER_TYPE, SCREENING
The actual processing sequence is:
• SCREENING,
• BMODDIG,
• B_NUMBER_TYPE,
• ROUTE
Example 2
The result set includes E_PORTED_NUM, SCREENING, and ROUTE.
The actual processing sequence is:
• SCREENING,
• E_PORTED_NUM—prefix B-number with routing number and re-start B-analysis,
• ROUTE (from new B-number analysis)
Example 3
The result set includes MORE_INFO (BSM_REQ, CPC_REQ, CLI_REQ, DIGIT_REQ, and FSM_REQ),
ROUTE, and BMODDIG.
The actual processing sequence is:
• MORE_INFO—response to the call control module and provokes backward request for CLI from
OCC protocol. OCC protocol responds with CLI—new analysis request,
(MORE_INFO)—now ignored since CLI is present,
• ROUTE,
• BMODDIG
Example 4
The result set includes NEW_DIALPLAN, SCREENING, and BMODDIG.
The actual processing sequence is:
• SCREENING,
• BMODDIG,
• NEW_DIALPLAN
Multiple repeated result types occurring in Pre-analysis use the following rules:
Note The ROUTE result handling is separate to the functionality implemented for default handling.
When provisioned, the following result types can be augmented with a default routing result (that is,
multiple provisioned ROUTE results). For each result type, an explanation is provided outlining why this
is appropriate.
In Cause analysis, some results can return specific data to immediately provoke tear down of the call.
However, for others (for example, ROUTE or COND_ROUTE) it is necessary to return the result to
routing and allow it to first clear and delete the existing terminating side, then re-invoke analysis with
the stored results. This ultimately allows a new terminating side to be set up and the call re-routed
forward.
Note A maximum of three dial plan changes, after the initial dial plan, is permitted.
If more than one final result is retrieved the following sections describe how call processing is
performed.
This section explains the basic result analysis based on the previous call processing capabilty.
Result analysis enables you to group actions into result sets that can be attached at different points of
analysis. The main attachment points are pre-analysis, A-number analysis, B-number analysis, and cause
analysis.
When you are configuring results, certain result types require extra configuration to provide additional
data. The following are examples of two such result types.
• Number modification, in which the digits are inserted into a number. These new digits must be
configured first and stored before the actual result, which will make use of these digits, is defined.
For example, if the B-number is 4841234 and the intention with a B-number modification
(BMODDIG result) is to insert 703 at the front of the number, the "703" digit string must be created
first. Once the digit string is created, the actual B-number modification result can be defined through
use of the "703" digit string data.
• When A-number screening is required, if the screening is triggered from the B-number digit
analysis, it is necessary to identify the database area that contains the A-number screening data for
calls destined to this particular B-number. The database area is called the Service name. The service
name data must be defined separately before the actual A-number screening result is defined.
This new longest match feature results in a new call processing behavior which enhances the basic
analysis capability the following five situations:
• Longest Match in A-Number Analysis
• Longest Match in B-Number Analysis
• Dial Plan Changing
• Overlap Dial Plan Changing
• Ported Number Handling
For example, in the original capability, if there is a number 1234, and the results at digits 12 was
NEW_DIALPLAN, and at 123, the result was ROUTE, the dial plan was changed over. With the new
capability, the status of the NEW_DIALPLAN and A_NUM_DP_TABLE results are “reduced” so that
these can be longest matched against the other results. In this example, the call would be completed with
the ROUTE result at digits 123, and there would be no dial plan changeover.
The new feature applies to all of the results listed below:
• For A-number analysis:
– CAUSE
– BLACKLIST
– ANNOUNCEMENT
– NEW_DIALPLAN
– A_NUM_DP_TABLE
• For B-number analysis:
– CAUSE
– BLACKLIST
– ANNOUNCEMENT
– TERM_INFO
– ROUTE
– COND_ROUTE
– PERC_ROUTE
– MGCPDIALPKG
– E_PORTED_NUM
– E_ROUTE_NUM
– A_NUM_DP_TABLE
– NEW_DIALPLAN
Reverting to First Dial Plan When There Are Insufficient Digits in Overlap
The Dial Plan Longest Match feature enables you to revert to the original dial plan when there are
insufficient digits, and the existing dial plan changeover handling does not provide the flexibility you
need throughout your dial plan structure.
The following examples show how the feature works.
Main dial plan
49 – Move to new dial plan 0001.
49123 – Move to new dial plan 0002.
0001 dial plan
491 – Route1
0002 dial plan
49123 – Route2
Example 1 – In the case of B-number 4912345, given the way the dial plans are provisioned, it is
expected that the analysis in dial plan "Main" will result in a changeover to new dial plan 0002 from
where the call will be routed. If the signaling mode is "Enbloc," this obviously works without any
problem; however, in "Overlap" mode with certain call scenarios there can be a problem.
Example 2 – If the IAM delivers digits 49 and then the SAM delivers 12345, with the old functionality,
49 will result in a changeover to dial plan 0001 where the analysis would run out of digits. This would
result in a wait for more digits within dial plan 0001. When digits 12345 are received in a SAM message,
a new analysis attempt is made, and analysis continues from dial plan 0001, where the call is finally
routed after matching 491 using Route1. The problem is that the call was routed via dial plan 0001, but
the customer expected this to route via 0002 using the longest match.
To address this problem, the new overlap multiple dial plan functionality is altered so that if the analysis
runs out of digits and waits for new digits, it changes back to the first dial plan. When a new analysis
request is made (with further digits), it is treated as a new request and not as a continuation of the
previous analysis.
With such functionality in place, in Example 2 after the IAM delivers digits 49, the dial plan is changed
over to 0001 and runs out of digits. A wait for further digits is started, but this time the analysis changes
back to dial plan "Main" before waiting. When the SAM message delivers digits 12345, the complete
number 4912345 is sent to analysis, where it is treated as a ,new request. Starting in dial plan "Main,"
the longest match would be found against 49123, and it will change over to dial plan 0002 where the call
would finally be routed.
Result Set
A result set is a grouping of result types that can be associated with an A-number analysis, B-number
analysis, Pre-analysis, or Cause analysis. You can have only one result set for each digit string; however,
you can have one or more result types in a result set. Each result set requires a unique name, and each
result type within a result set also requires a unique result name. However, the result names do not need
to be unique across result sets—it is the combination of result set name and result name that must be
unique. The result set name and the result name can each be as many as 20 alphanumeric characters in
length. Table C-3 in Appendix C, “Dial Planning Worksheets,” can be used to plan your result set.
When determining the result types for a result set, intermediate results have to be created before
end-point results. For example, the intermediate result type SCREENING must be added before the end
point result type MGCPDIALPKG. You can have as many intermediate result types in a result set as you
want. However, once a result set has an endpoint analysis result type, that is the end of the result set.
Each result set supports only one occurrence of any of the result types. For example, the user cannot
configure the result type ROUTE followed by another ROUTE in the same result set.
See Provisioning the Result Set, page 4-58 for an example of MML commands used for provisioning the
result set.
Pre-analysis
In Pre-analysis there are several serial stages (described in the following sections). After data in each
stage is read, any accumulated results are put in a results “collection bin”. If duplicate results occur, the
following result simply overwrites the previous result; at all times there is only one version of a
particular result in the bin. The only exception to this is number modification in result types AMODDIG,
BMODDIG, and RMODDIG, which are cumulative from stage to stage in Pre-analysis. Thus each digit
modification string changes the number string and becomes the input to the next stage. At the end of all
Pre-analysis stages, the accumulated results collected are saved and processed.
If a dial plan change is returned from Pre-analysis because of the NEW_DIALPLAN result type, then
you change the dial plan to revert to Pre-analysis again using the new dial plan, starting analysis over
again. For the NEW_DIALPLAN result type, the only analysis option is to return to Pre-analysis.
From Pre-analysis, A-number analysis is entered, and then B-number analysis is entered. In the last two
stages, we traverse the digit analysis data and collect the results at various points, with the longest match
applied to a selection of results. From the A-number analysis stage, a dialplan change can only provoke
a return to Pre-analysis. However, from the B-number analysis stage a dialplan change can either revert
to Pre-analysis or simply re-start B-number analysis (within the new dialplan). In these two stages, there
is functionality, such as call screening or LNP, that requires early actions and sometimes early responses
to call control.
Result Set
CPC Value Name
1
2
3 set1
... ...
Note The CPC value is the MGC internal value and not the protocol-specific value. See the “CPC Values”
section on page A-9 for a list of CPC values.
Result Set
TMR Value Name
1
2
3 set1
... ...
Note The TMR value is the MGC internal value and not the protocol-specific value. See TMR Values,
page A-17 for a list of TMR values.
For any NOA value that is configured, either an NPI block or a result set must be specified. Table C-6
in Appendix C, “Dial Planning Worksheets,” can be used for provisioning your NOA.
Note The NOA value needs to be the MGC internal value and not the protocol-specific value. See Appendix A,
“NOA and NPI Codes, CPC and TMR Values” for a list of NOA values.
Table C-7 in Appendix C, “Dial Planning Worksheets,” can be used for provisioning your NPI.
Note The NPI value needs to be the MGC internal value and not the protocol-specific value. See Appendix A,
“NOA and NPI Codes, CPC and TMR Values” for a list of NPI values.
Result Set
TNS Value Name
123 set1
223 set2
334 set3
Note Due to the nature of the connection, calls arriving by EISUP (H.323) or SIP protocols are not supported.
Applying an announcement is provisioned on the MGC at three levels: as an incoming trunk group
property, as an A-number analysis result, or as a B-number analysis result. The trunk group property
(PlayAnnouncement) provides the initial announcement identity and can be optionally over-written
during A-number or B-number analysis.
Upon receiving a new call, the MGC analysis function carries out Pre-analysis, A-number analysis,
B-number analysis, and routing. Early in the analysis function, the incoming trunk group property
PlayAnnouncement is read and any provisioned announcement identity (integer value) is retrieved. If the
PlayAnnouncement trunk group property is not configured, the property has a null or zero value
indicating that no announcement action is required. If an announcement identity is retrieved, this
indicates that an early or welcome announcement is to be played and that this data is stored locally before
starting analysis, which is where the selection of announcement can be overridden.
If an ANNOUNCEMENT result is collected at Pre-analysis, A-number analysis, or B-number analysis,
it is in addition to any announcement identity collected from the trunk group property. If only the
PlayAnnouncement trunk group property is present, it is applied. However, if one of the analysis areas
also has provided an ANNOUNCEMENT result, then the result either overrides the trunk group property
or negates the trunk group property by not applying the announcement for the incoming number. The
basic rule is that the last analysis area determines the final result.
Note If in overlap numbering mode, all digits must be received and analyzed before any announcement is
played. This means that any overlap announcement call effectively goes from overlap to enbloc.
If the final ANNOUNCEMENT result has dataword4 set to indicate OFF, then no announcement is
played. In this case, generic analysis completely removes the ANNOUNCEMENT result and the call
status is determined by the other collected results.
Once generic analysis determines which announcement Id to use, this information is passed back to
number analysis to perform the necessary action. The announcement data accompanies any other results
being returned. The result from analysis varies according to the announcement type and according to
both the final result and the delivered announcement data.
When the RSLT_ANNOUNCEMENT analysis result arrives, the accompanying data is examined. The
first check is to determine if it is a remote or local (gateway) announcement. If the announcement is
remote, then the previous functionality and handling are invoked. If the indicator is set to local, then a
gateway announcement is required, the Times-Ten Announcement table is read, and the data is stored in
readiness.
A check is made to determine the course of action. That is, the check determines if the announcement is
the final action (play announcement and clear down) or an intermediate action (play announcement and
continue processing), as indicated by dataword4.
With the course of action determined, the required call processing is initiated. The MGC sends a
CRCX[M: recvonly] over MGCP to the originating side gateway to prepare the channel for
announcement playing. Then the MGC sends an ACM signal back to the preceding switch. This is
necessary to allow time for playing the announcement, without exceeding the ACM timers, and to
prepare the speech path on the previous switches.
At this point, the announcement playing is started and a Notification Request (RQNT) is sent to the
gateway. Upon receiving RQNT, the gateway plays the announcement and also positively responds to the
command. The MGC times the announcement playing activity and awaits a Notify (NTFY) message
from the gateway. Once announcement playing is complete, the gateway responds with the NTFY
message, and the completion indication is passed back to the MGC.
The action the MGC takes at this point depends on the indication given by analysis in dataword4. If the
indication is ANN_final, then the call is cleared down. However, if the indication is Ann_Interim, then
processing continues with the remaining results and the ANNOUNCEMENT result is discarded. If the
remaining results include a trunk group, then circuit selection takes place.
Note When dealing with these results, first determine if there is announcement data and take the appropriate
action.
play
AnnId gwType Duration Repeat Interval locationString
The Announcement table contains the following fields of data relevant to the Announcement package:
AnnId—Indicates the announcement identity (or tone identity), which matches the announcement
identity defined by the ANNOUNCEMENT result type. This is one of the two access keys for which the
Announcement table is searched for a match. (4-digit integer).
gwType—A string containing a value that is part of an enumerated set identifying the gateway type for
this side of the call. This is the second access key used to read the Announcement table. (10 characters
maximum).
playDuration—Indicates the intended duration, in seconds, for which the announcement or tone is
played. The default value is 60. Value range: 0 through 120.
repeat—Indicates the number of times the announcement or tone is repeated; or indicates if it must be
played continuously for the specified duration. A value of 0 indicates continuous playing. The default
value is 1. Value range: 0 through 5 (4-digit integer).
interval—Indicates the silence interval duration, in milliseconds, between replaying an announcement
or tone. Default value: 3000. Value range: 0 through 5000 (4-digit integer).
locationString—A string indicating to the gateway the audio file to load to enable announcement or tone
playing. The string format varies according to the gateway type and its configuration. The string
information is part of a URL string that the MGC sends by MGCP to the gateway. (Maximum length of
string: 128-characters).
Note The gateway is expected to support standard URL schemes for this notation (that is, file, http, or ftp), as
described in RFC 1738.
For file or ftp versions, the data provisioned in this field is the required filename, because the gateway
is expected to already know the directory location or ftp address.
For example:
Audiofile1.txt (file or ftp version, gateway knows where to find the file)
MyName@host.dom/etc/Audiofile1.txt (http version, gateway will retrieve the file from this
location).
Note Gateways do not support playDuration, repeat, and interval parameters at this time.
Number Analysis
A-Number Analysis
A-number analysis (see Figure 1-8) provides digit-by-digit analysis, and call screening that supports
both blacklist and whitelist screening capability.
From the point of view of the Cisco PGW 2200 Softswitch, each digit received is processed separately.
Each digit is processed through a tree-structured representation that is stored in the digit tree. Each digit
tree allows analysis of the decadic digits 0 through 9 and the over-decadic (hexadecimal) 0 through 9
and digits A through F to be configured.
84010
Cause Analysis
Cause
Cause lists the cause codes generated when a call is rejected or cleared by the system (see Figure 1-9).
The cause for release can be a result type (from either B-number analysis or Cause analysis) or a failure
(generated during call processing). The cause codes are used as the release message for internal causes.
The two cause fields are the Location Block and Result Set Name, as shown in Example 1-8.
• The location block identifies a block of data specific to the network that the call is originated.
If location block value is set to 0, no further analysis is performed based on the location.
• The result set name is used to associate a result set with a cause value.
If a result set name is not configured, then no action is taken.
The Location Block and the Result Set Name cannot be provisioned the same time. For more information
on provisioning causes, see Chapter 5, “NUMAN: Commands for Provisioning Dial Plan Components”
of the Cisco PGW 2200 Softswitch Release 9 MML Command Reference.
Each location block can holds up to 16 entries. Each entry identifies a result set. A location block entry
must be configured with a result set name other than null (0). For information on location blocks and
location block entries, see the “Location” section on page 1-79.
If both the location block and the result set name are set to null, no analysis is performed.
Note The RETRY_ACTION result type allows you to select the default cause or re-edit the cause during dial
plan creation. The default cause is used as before. However, if you desire to specify a retry action, you
must enter a retry value for dataword1.
84012
Example 1-8 Cause Example
Result Set
Cause Value Location Block Name
1 1
2 set1
3 3
See Appendix B, “Cause and Location Codes,” for a list of the cause codes for the protocol variants.
Table C-8 in Appendix C, “Dial Planning Worksheets,” can be used to plan the Cause values.
Note The cause and location values used here are the internal values, not those seen in a REL message. See
Appendix B, “Cause and Location Codes.”
Location
Location is used to identify an associated result set, as shown in Example 1-9. Location is accessed from
the cause value through the locationblock value. The locationblock value refers to a block of up to 16
entries (0 through 15).
There can be multiple location block entries in one location block. The blockvalue specifies an offset
into the specified location block. You can associate an action with the specific blockvalue by setting the
result set name (setname) at the specified offset in the location block.
On the Cisco PGW 2200 Softswitch, you always provision internal values for cause and location codes.
During cause analysis, for different protocols, the Cisco PGW 2200 Softswitch do two mappings,
mapping received cause and location codes to internal cause and location codes, and mapping internal
cause and location codes to protocol-specific cause and location codes. Then, the
Cisco PGW 2200 Softswitch uses internal cause and location codes to determine further actions.
Note For details on cause and location code mappings for different protocols, see Appendix B, “Cause and
Location Codes”.
If the cause code in the Release message has a location significance, the Release message has a value in
the location indicator. The Cisco PGW 2200 Softswitch maps the received cause code to an internal
cause code value for this specific protocol. The internal cause code value identifies the location block.
The Cisco PGW 2200 Softswitch maps the location indicator to an internal location value. Then it uses
the internal location value as an index into the location block to identify the location block entry. If that
entry exists, the Cisco PGW 2200 Softswitch uses the result set provisioned in that entry as result
actions.
Figure 1-10 gives an example for cause analysis on cause codes and locations. It assumes that the call is
using ANSI SS7 protocol.
In this example, a user associates the result set, set2, with the internal cause code 12. The location block
value for the cause code 12 entry is set to 0. The user sets the location block to 2 for the internal cause
code 34. In Location Block 2, the user associates the result set, set3, with the location block value 6.
Note The blockvalue in numan-add:location should be one less than the intended internal value. For
detailed provisioning procedures, see the “Location Mapping” section, in Chapter 5, Adding
System Components with MML, of Cisco PGW 2200 Softswitch Release 9 Provisioning Guide
(through Release 9.7).
If the received cause code in the release message was mapped to the internal cause code 12, the
Cisco PGW 2200 Softswitch uses set2 as result actions. If the mapped-to internal cause code is 34, the
Cisco PGW 2200 Softswitch identifies the location block 2. Then the Cisco PGW 2200 Softswitch maps
the location indicator 7 to the internal location value LOCATION_INTERNALTIONAL according to
Table B-33, Protocol-specific Release Cause Location Values. Because the internal location value minus
1 equals 6, the Cisco PGW 2200 Softswitch identifies set3 as result actions.
34 2 set3
Location indicator 7
mapped to internal Location Block Location Block Value Result Set Name
location code
LOCATION_ 2 1 set2
INTERNATIONAL
(7) 7-1=6 2 2 set1
277403
2 6 set3
See Appendix B, “Cause and Location Codes,” for a list of the location codes for the protocol variants.
Table C-9 in Appendix C, “Dial Planning Worksheets,” can be used to plan the Location values.
With the multiple dial plan capability, it is quite possible that some dial plans may be accessed only as
the result of call processing using a previous dial plan. This means that some dial plans might not be
associated with a trunk group or sigpath that requires another list, which provides a complete list of all
valid dial plans that are loaded at startup.
• Following a dial plan change, analysis resumes within the new dial plan at the Pre-analysis stage.
General Objectives:
• Maximum of ten dial plan changes per call. The number of dial plan changes is not provisionable.
If this limit is reached, call processing will complete within the current dial plan.
• A dial plan change result signals the end of analysis within the current dial plan.
Call Screening
Call screening is one type of analysis performed on the calling number (A-number) and the called
number (B-number) to determine if a call is to be accepted or rejected. The Cisco PGW 2200 Softswitch
supports whitelist call screening that allows listed numbers and blocks all others, and blacklist call
screening that blocks listed numbers and allows all others.
Either whitelist or blacklist call screening can be triggered from either A-number analysis or B-number
analysis; however, only the calling number is screened. If screening is triggered from A-number
analysis, the calling number is screened regardless of the number dialed. If screening is triggered from
B-number analysis, the calling numbers allowed or blocked are limited to those associated with a
specific service name. The screening is always performed on the calling number (A-number), regardless
of which type of number analysis triggers the SCREENING result type.
Call screening verifies that a call can be completed. You can provision whitelists that specify allowed
numbers and blacklists that specify blocked numbers, as shown in Table 1-12.
Whitelist or blacklist screening triggered by A-number analysis or B-number analysis results in four
different ways to trigger call screening:
• Whitelist Screening Triggered by A-Number Analysis
• Blacklist Screening Triggered by A-Number Analysis
• Whitelist Screening Triggered by B-Number Analysis
• Blacklist Screening Triggered by B-Number Analysis
In whitelist screening triggered by A-number analysis, the call is completed if the A-number digit string
in the dial plan is included in the AWhite (whitelist) screening file. The call is terminated if the
A-number digit string is not listed in the whitelist screening file. Figure 1-11 is an example of whitelist
screening triggered by A-number analysis.
A-number digit
string in dial plan
B - nu m b e r
7034830001
( c a l l fa i l e d )
3016484444 Whitelist
3016485555
A-number digit
string in dial plan B - nu m b e r
7034830001
(call completes)
33075
3016485555
In the dial plan, the calling number digit string “301” is linked to the SCREENING result type during
A-number analysis. When a call is placed, any calling number beginning with the digit string “301” is
screened to see if it is included in the AWhite (whitelist) screening file.
In this example, if the calling number is 3016484444, the call is not completed because that number is
not included in the AWhite screening file. However, if the calling number is 3016485555, the call is
completed because that number is included in the AWhite screening file.
For the detailed procedure for building or adding to the AWhite screening file, see the Adding Screening
Lists (SCREENING), page 4-23.
Note The called number (B-number) has no effect on the call. In fact, the B-number does not have to appear
in the dial plan at all when doing whitelist screening triggered by A-number analysis.
In blacklist screening triggered by A-number analysis, the call is terminated if the A-number digit string
in the dial plan is included in the ABlack (blacklist) screening file. The call is completed if the A-number
digit string is not listed in the blacklist screening file. Figure 1-12 is an example of blacklist screening
triggered by A-number analysis.
A-number digit
string in dial plan
B - nu m b e r
7034830001
( c a l l fa i l s )
3016484444 Blacklist
3016484444
A-number digit
string in dial plan B - nu m b e r
7034830001
(call completes)
33076
3016485555
In the dial plan, the calling number digit string “301” is linked to the SCREENING result type during
A-number analysis. When a call is placed, any calling number beginning with the digit string “301” is
screened to see if it is included in the ABlack (blacklist) screening file.
In this example, if the calling number digit string is 3016484444, the call is terminated because that
number is included in the ABlack (blacklist) screening file. However, if the calling number digit string
is 3016485555, the call is completed because that number is not included in the ABlack screening file.
For the detailed procedure for adding to the ABlack screening file, see the “Adding Screening Lists
(SCREENING)” section on page 4-23.
Note The called number (B-number) again has no effect on the call. The B-number does not have to appear in
the dial plan at all when doing blacklist screening triggered by A-number analysis.
Note Despite the fact that B-number analysis triggers the SCREENING result type in the following examples,
remember that screening is always performed on the calling number (A-number) digit string.
33077
(call completes) 3016485555
30164 8 5 5 5 5
In the dial plan, the called digit string “7034” is linked during B-number analysis to a result set that
includes the SCREENING result type, which is also associated with the Washington service. When a call
is placed to a number that begins with the digit string “7034,” the calling number is screened. If the
calling number is included in the BWhite (whitelist) screening file and it is associated with the
Washington service, the call is completed; otherwise, the call is terminated.
In this example, when a customer dials a number that begins with the digits “7034,” the calling number
(3016484444) is screened and the call is terminated because this calling number is either not included
in the BWhite screening file or it is included, but it is not associated with the Washington service.
However, if the calling number were 3016485555, the call would be connected because that number is
included in the BWhite screening file and it is associated with the Washington service.
To add numbers to a BWhite screening file, see the “Adding Screening Lists (SCREENING)” section on
page 4-23.
In the case of blacklist screening triggered by B-number analysis, if the called number (B-number) digit
string is associated with a service name and the calling number (A-number) is included in the BBlack
(blacklist) screening file and it is associated with the same service name, the call is terminated;
otherwise, the call is connected. Figure 1-14 is an example of blacklist screening triggered by B-number
analysis.
67000
(call completes)
30 1 6 4 8 5 5 5 5
(t o ll f re e )
In the dial plan, the called digit string “7034” was linked to the SCREENING result type during
B-number analysis. When the call is placed, the calling number 3016485555 is either not included in the
BBlack screening file or it is included, but not associated with the Washington service, so the call is
connected. However, if the calling number is 3016484444, the call is terminated because that number is
included in the BBlack (blacklist) screening file and is associated with the Washington service.
To add numbers to a BBlack screening file, see the “Adding Screening Lists (SCREENING)” section on
page 4-23.
Caution The redirecting number screening capability has no effect on the provisioning of the A-number screening
and analysis described previously; however, this screening capability is not backward compatible with
Cisco PGW 2200 Softswitch releases earlier than Release 9.2(2).
Redirecting number screening is designed to augment, not replace, screening of the original A-number
by introducing screening of the redirecting number. Redirecting number screening allows you to specify
whether redirected calls are screened by using the original A-number or the redirecting number, which
was the original B-number when the call was initiated, as shown in Figure 1-15.
For redirected calls, the calling number parameter contains the A-number of the station that originated
the call, the redirecting number parameter contains the number of the station that redirected the call, and
the called number parameter contains the number of the station to which the call is redirected.
If a succeeding switch should determine that a redirected call is to be subjected to A-number screening,
it uses the number contained in the redirecting number parameter in the A-number screening process.
A number
3016484444 Original B number
Calling number
Original call 3016485555
30164 84444
Redirecting
number Redirecting number
B number 3016485555
3016486666
Called number
Redirected call
57116
3016486666
A-number screening for redirected calls can vary from customer to customer, so an office-based or
switch-based parameter is required to specify the numbers that are used for A-number screening. The
XEConfigParm.dat file contains office-wide or switch-wide parameters in the
Cisco PGW 2200 Softswitch software, including the MDLANumberScreening and RedirectingATree
parameters.
The default value of the MDLANumberScreening parameter (0) invokes the standard A-number
screening on the number in the calling number parameter, regardless of whether the call is redirected or
not. No screening is done on the number in the called party parameter or the redirecting number
parameter.
Redirecting number screening is enabled by setting the MDLANumberScreening parameter to 1 in the
XEConfigParm.dat file.
• If the original A-number screening was invoked by an A-number analysis SCREENING result, only
the original A-number is screened.
• If the original A-number screening was invoked by a B-number analysis SCREENING result, either
the original A-number or the redirecting number is screened, dependent on the presence of the
redirecting number data in the received setup message.
When the redirecting number is screened, the setup message is returned to A-number screening
where it is re-screened to determine whether the call can be completed based on the redirecting
number instead of the original calling number. If the original B-number, now the redirecting number,
can make calls to the new B-number, the call is completed.
This feature requires setting the RedirectingATree parameter in the XECfgParm.dat file on initial
configuration. When the RedirectingATree property is set, only BLACKLIST (screening criteria CLI) or
SCREENING result types should be provisioned in the dial plan.
• If BLACKLIST is provisioned, the redirecting number is used for BLACKLIST functionality.
• If SCREENING is provisioned, the redirecting number is used for SCREENING functionality.
If result types other than BLACKLIST or SCREENING are encountered in the dial plan, an alarm
(RedirectingNbrFail) is generated and processing continues with the normal Adigittree decode of the
original A-number.
If the RedirectingATree property is not set, or there is no redirecting number present, then this stage is
skipped and processing continues with the normal Adigittree decode of the original A-number.
If the result types digit modification (AMODDIG or BMODDIG) or number type (A_NUMBER_TYPE
or B_NUMBER_TYPE) is encountered when a redirecting number is used during A-number analysis,
no modification is performed on the redirecting number. In addition, the A-number analysis does not set
the screening indicator field, because this field is not applicable for the redirecting number.
Within the EMEA region, the Cisco PGW 2200 Softswitch is able to handle ported calls in the capacity
of donor switch, transit switch, or recipient switch. The following paragraphs describe call scenarios
from each of these network perspectives. SS7 signaling is required for number portability services.
Donor Network
If the Cisco PGW 2200 Softswitch is in a donor switch capacity when the called number is ported, it will
have the result type E_PORTED_NUM provisioned in the dial plan which is retrieved during its digit
analysis decode. This result type would only be provisioned when the Cisco PGW 2200 Softswitch is in
a donor switch capacity.
Retrieval of the E_PORTED_NUM result type is an indication to read the ported number. This can be
carried out only if all digits have been received. With enbloc numbering, the processing can continue
directly; and with overlap numbering, the Cisco PGW 2200 Softswitch must await further digits until
sending is complete.
In this way the E_PORTED_NUM result type can be provisioned at the area code level, but the ported
number cannot be interrogated until the complete number is received.
Calls to a ported number are routed to the recipient network using a unique routing number (called a
Network Identification Code (NIC)), which is retrieved from the number portability (NP) database on
the donor switch. A concatenated address is used, in which the routing number is prefixed to the
B-number to transmit it to the next node. The length of the routing number is fixed within each country,
but can vary from country to country.
The E_PORTED_NUM result type has one dataword that is used to enable the removal of any
normalization prefix digits before prefixing with the routing number.
During B-number analysis the LNP call processing that takes place for a ported number in a donor
network is as follows:
1. The donor switch receives an SS7 IAM containing a B-number (that is, called party number or
CdPN).
2. After all the digits have been collected and the E_PORTED_NUM result type is encountered during
B-number analysis, the Ported Number table (PORTTBL) is accessed to determine if the B-number
has been ported to another network.
a. If the B-number is not found in the ported number list, the call is routed according to the
B-number.
b. If the B-number is found in the ported number list, the donor switch performs an NP query to
its local NP database to retrieve the recipient network routing number.
If no routing information is defined for the routing number in the local NP database, the internal
cause code is set to 51 (unallocated number) and the call is subjected to Cause analysis.
c. If the ported number list could not be accessed due to a database error, the call is handled based
on the database access error action set in the XEConfigParm.dat file:
• If set to continue, the call is treated as a non-ported call and is routed according to the
B-number.
• If set to block, the internal cause code is set to 50 (temporary failure) and the call is subjected
to Cause analysis.
3. The donor switch prefixes the routing number to the B-number and modifies the NOA parameter to
Network Routing Number concatenated with the called party number (RN+CdPN).
4. B-number analysis is re-entered from the beginning using the concatenated address (RN+CdPN) to
route the call onward towards the recipient network.
Transit Network
The LNP call processing that takes place for a ported number in a transit network is as follows:
1. The transit switch receives an SS7 IAM containing the new NOA with a B-umber (B-number) and
a routing number prefixed to it (RN+CdPN).
2. Early B-number analysis recognizes the new NOA. The Cisco PGW 2200 Softswitch performs
standard B-number analysis.
3. The transit switch determines the route leading to the recipient network based on the RN.
a. If a route is defined, Route Analysis is performed to route the call. The B-number with the
prefixed routing number is transmitted transparently
b. If a route is not defined for the Routing Number, the Cause code is set to 51 (unallocated
number) and the call is subjected to Cause Analysis.
4. The transit network passes the B-number as it was received in the incoming IAM.
Recipient Network
The LNP call processing that takes place for a ported number in a recipient network is as follows:
1. The recipient switch receives an SS7 IAM containing the new NOA with a B-number and a routing
number prefixed to it (RN+CdPN).
2. Early B-number analysis recognizes the new NOA and performs standard B-number analysis.
3. If the result type E_ROUTE_NUM is encountered, analysis waits until all the digits have been
collected, then strips the leading digits (the routing number) from the B-number as defined in
dataword1, modifies the NOA to national, and reads the Number Termination table (TERMTBL)
using the B-number to retrieve the route(s) to the recipient switch.
a. If no routing is defined in Number Termination, the internal cause code is set to 51 (unallocated
number) and the call is subjected to Cause analysis.
b. If Number Termination cannot be accessed due to a database error, the call is handled based on
the database access error action set in the XEConfigParm.dat file:
• If set to continue, the call is treated as a non-ported call and is routed according to the
B-number.
• If set to block, the internal cause code is set to 50 (temporary failure) and the call is sent to
Cause analysis.
Advice of Charge
The Advice of Charge (AOC) feature (currently supported protocol variants are ISUPV2_GERMAN,
Q761_INDIA, and ISUPV2_POLISH) is controlled by the ingress trunk group property AOC Enabled.
The flat rate charging capability provides a simple fixed rate tariff feature that co-exists with the AOC
variable rate charging capability.
Selecting the charging scheme used is determined by the content of the Charge Data Type field
(dataword4) obtained from the CHARGE result type in the dial plan.
Access to the Charge list is made using the charge origin, charge destination, and day-of-week values.
Charge origin and charge destination are obtained from A/B number analysis and passed to the CDR
Manager by the call context. The date and day-of-week are read using an internal function.
Upon retrieving the date and day-of-week values, the Holiday list is checked using another internal
function to determine if the day of the week value is to be overwritten by a holiday value.
Three input parameters (charge origin, charge destination, and day-of-week) are passed into the function
and a list of tariff IDs and change-over times is returned.
Access to the Charge list is made by retrieving the tariff descriptor, which is then used to access the Tariff
list to obtain the tariff rate and scale factor. If a split-day tariff descriptor is obtained, it is separated into
Tariff/Switchover-Time descriptor pairs before accessing the Tariff list using the current tariff descriptor
to obtain the tariff rate and scale factor.
For split-day tariffs, the tariff rate and scale factor corresponding to the next time period and the
switchover time to the next tariff rate are also retrieved from the Charge list and this information is also
sent in the initial CRGT message. The data is made available to the ingress protocol by placing it in call
context containers and this initial tariff data is also written to the CDR. The CDR Manager raises a minor
alarm for any data access failure.
Two timers are used to prompt the CDR Manager that the call is about to change to the next tariff rate.
Upon expiration of either timer, the charging lists are accessed again using the relevant tariff descriptor
to retrieve subsequent tariff information, which is placed in the call context.
The relevant tariff descriptors are:
• The CRGT message indicating this changeover is sent 12 minutes before the switchover is to occur.
• The tariff duration specifies the duration until the next sub-tariff takes effect. Currently, the duration
field in the CRGT message is hard coded to unlimited.
If the internal process receives subsequent charging information notifications from the CDR, the internal
process outputs a signal to the ingress protocol indicating tariff switchover has occurred and subsequent
tariff data is available to be sent.
Provisioning AOC
Note The only mandatory value is charge destination. Charge origin and day of the week, if absent, are set to
0 in the list row entry.
If the charge origin is absent, the entered row refers to all origins for that destination (unless explicitly
entered in another row). Similarly, if the day of the week is absent, it refers to all days of the week not
otherwise explicitly entered.
Activating AOC
This capability is controlled by the property AOCEnabled (1 = enabled, 0 = disabled). To reduce alarms
due to charging information pointing to unpopulated lists when provisioning AOC, it is advisable that
AOC be disabled (AOCEnabled parameter set to 0) on the relevant trunk groups until the Charge list has
been correctly updated.
PRI AOC supplementary services provisioning is accomplished in following stages:
Defining charge origins—Can be assigned to trunk groups or signaling paths, area codes (in the A-digit
trees), or in a CLI Charge Origin table.
Defining charge destinations in B-number tables.
Defining customer-specific holidays using the Charge Holiday table.
Creating the PRI Charge table and populating the required tariff IDs for the identified charge origin,
charge destination, and day of week combination.
Populating the tariff rates within the PRI Tariff table.
Configuring AOCInvokeType against the trunk groups.
Configuring AOCDefaultTariffId against the trunk groups.
Configuring AOCDMinPeriodicTimerDuration against the signaling paths.
Enabling AOC against the ingress trunk groups or signaling paths.
Additionally, AOC over PRI can be configured to charge rates for a specified duration of the call,
followed by a flat rate that is charged for the remaining call duration. This change to AOC allows for
tariff changes during the call that are based on the duration of the call. For example, support for one tariff
rate charge rate for the first 2 minutes of the call (that is, 40 units for the first 2 minutes or less), followed
by a standard tariff rate of 10 units per minute for the remaining call duration. The remaining call tariff
rate may or may not change based on the time of day or the day of the week.
Charge Table
The Metering Pulse Messages (MPM) Support Feature is described in the following sections.
The Metering Pulse Feature enables the handling of meter pulse message pass through, modification,
and generation. Billing information is derived from and provided to the billing mediator using Call
Detail Records (CDRs).
This feature enhances the following two main functional areas of the MGC:
• Additional charging requirements—The MGC uses one or more of the following criteria to calculate
charge tariff determination:
– Incoming trunk group
– Calling party number (also referred to as A-number)
– Called party number (also referred to as B-number)
– Calling Party Category (CPC)
– Transmission Medium Requirement (TMR)
Charging information in the form of meter pulse messages (MPMs) is sent to the PSTN at call
answer and/or periodically thereafter, depending on the tariff data provisioned in the
Cisco PGW 2200 Softswitch. The sent MPMs are also recorded in a CDR.
MPM can be received over outgoing ISUP trunks. Data contained in them must be analyzed and
stored in a CDR. These messages can also be transmitted back over the incoming ISUP trunk.
Charging tariff data can be received from an SCP during a call. This data overrides the data
provisioned in the MGC charge tables.
The Charge/No-Charge indicator in the ISUP BCI parameter of the ACM/CPG/ANM messages sent
to the network by the MGC must be set appropriately based on either provisioned data in the MGC
or data received from the SCP.
• Additional INAP requirements
The Cisco PGW 2200 Softswitch can be used to generate Metering Pulse Messages as a basis for
charging.
Note Metering information is checkpointed from the active to standby Cisco PGW 2200 Softswitch system
every 15 minutes.
The charge table, shown in Figure 1-16, can be accessed using three keys:
• charge origin
• charge destination
• day of the week
The charge table contains the tariff descriptors that are to be applied. The resultant tariff descriptor is in
string format and may contain a single tariff id to be applied for the entire day or a list of different tariffs
and the time at which they are applied (delimited by spaces).
If the resultant tariff descriptor is a list of different tariffs and the time at which they are applied, the
initial entry is a tariff rate to be applied from 0000 hours until the next specified time period, at which
point the tariff id following the switch time is applied. A maximum of 5 tariff changes is allowed for a
given day, for example, a day may contain 6 different tariff rates.
A tariff descriptor time period value of 0000 indicates the end of time dependent tariff data and the
previous (last) found tariff id continues until midnight.
The charge origin may be defaulted (0) when the charging tariff rates are not origin dependent. The day
of the week may be defaulted (0) by the craft when the same tariff rate is to be applied to more than one
day of the week.
The holiday table allows you to select specific days of the year to be charged differently from the actual
day of the week that a holiday occurs on.
Input parameters
Charge Table
Charge origin Charge Dest Day Tariff Descriptor
1 1 0 "1"
1 1 8 "2"
1 1 5 "1 0700 5 1000 1 1600 5 1800 1"
.... .... ...... "....."
116846
To Tariff table
In the sample Charge Table (shown in Figure 1-16), the origin/dest charge combination has three entries:
‘1,1,0’, ‘1,1,8’, and ‘1,1,5’. The entry 1,1,8 defines a holiday tariff and 1,1,5 defines a split day tariff for
day 5 (Friday). The default entry, ‘1,1,0’, defines the tariff to be applied for all other days (Monday
through Wednesday, Saturday, Sunday, and the remaining holiday days 9 and 10).
The split day tariff (see the Charge Table) is interpreted as follows:
Apply tariff 1 from 0000 - 0700 hours
Apply tariff 5 from 0700 - 1000 hours
Apply tariff 1 from 1000 - 1600 hours
Apply tariff 5 from 1600 - 1800 hours
Apply tariff 1 from 1800 - 2400 hours
The CLI charge origin table ia accessed during analysis. It is referenced after A number digit tree
analysis when AOC is enabled against the incoming trunk group/sigpath. Valid CLI charge origin table
values are 1–9999.
The Meter Pulse Tariff Table is indexed using the tariff identifier retrieved from the charge table. The
tariff table supports a minimum of 512 (values from 0 to 511) distinct tariffs with user-definable tariff
identifiers. Table 1-14 lists the Meter Pulse Tariff Table fields and descriptors. Table 1-15 is a sample
Tariff Table example.
Field Description
Tariff Identifier Independently definable integer.
Number of Pulses on Answer Valid values are 0 through 15; a value of 0 indicates that no pulses are
generated on receipt of the answer signal.
Timing Interval Between Valid values are 500 through 3 600 000 (milliseconds). The minimum
Periodic Pulses interval between consecutive MPMs is 0.5 seconds. A value of 0
indicates that no periodic charge is applied.
Number of Periodic Pulses Indicates how many pulses should be sent when the timing interval
period expires. Valid values are 0 through 255.
Periodic Charge Application At timer expiration, the associated pulses are sent and then the normal
periodic interval timer is initiated.
Valid values are 0 (synchronous) and 1 (asynchronous). The
synchronous method applies the timing interval provisioned
immediately upon answer and repeatedly thereafter. The associated
meter pulses are transmitted at the end of each timing interval. The
isochronous method (also referred to as Karlsson) starts at the first
timing interval at a random value r, where r is in the range of 0-t,
where t is the associated timing interval.
Field Description
AOC Indicator Indicates whether the charge data is used by the receiving switch for
charging purposes or for advice of charge. Used to populate the
backward MPM and is not acted upon by the
Cisco PGW 2200 Softswitch. Valid values are 0 (call charge data) and
1 (AOC only) data.
Note MPMs marked as AoC must not be counted by the Pulses Sent
counter.
Max Call Length Represents the number of call minutes that the call can last. A value
of 0 indicates no call limit. Valid values are 0 through 240.
Tariff Type Only tariff type 0000 (tariff type not indicated) is used.
Table 1-16 provides information on the data fields used for metering pulse AOC implementation.
Note A slight performance impact can be expected if using this function, but it should typically not exceed
5% impact on call processing if the properties described here are provisioned for use.
As stated, trunk group properties are already present to convert from both national and international
formats to the NOA Unknown format. However, it is also necessary to be able to change between the
national and international formats by selectively adding the country code, depending on what the country
code is, and changing the Nature of Address (NOA) code on a per trunk group (TG) basis.
612345678
Incoming
NOA=National dial plan RouteList #55
66960
0034612345678
NOA=Unknown
As shown in Figure 1-17, an incoming call for a mobile number arrives from the originating carrier in
national format, and the incoming dial plan points to the national dial plan. The national dial plan gives
a route result of RouteList #55.
The first route in RouteList #55 contains three trunk groups, each routed to a different carrier:
• TG1 - Carrier 1—Is the first choice for mobile calls because it is the least expensive of the three
carriers. Carrier 1 accepts national calls only in the national number format; however, it also accepts
calls to other countries in the international number format.
• TG2 - Carrier 2—Is the second choice because it is less expensive than Carrier 3, but it accepts
calls only in the international number format.
• TG3 - Carrier 3—Is the last choice because it is the most expensive of the three carriers, and it
accepts calls only to international numbers in the Unknown format.
From the previous example, it can be seen that the following items are needed to solve this problem:
• CC_DIG—Is the result type used in B-number analysis to record the destination country code for
the call. A digmodstring is created so it can be connected to the result in dataword1. See the “Result
Type Definitions” section on page 1-17 for additional information on this result.
For detailed information on provisioning the country code addition or removal capability, see the
“Provisioning the CC_DIG Result Type” section on page 4-58.
• BDigitCCPrefix—A trunk group-based property which, if enabled, prepends the destination
Country code for the call to the B-number (called number) and changes the incoming NOA code to
international.
• CCOrigin—An incoming trunk group property to record the originating country code for the call.
• ADigitCCPrefix—Another trunk group-based property which, if enabled and the NOA code is set
to national, prepends the country code from CCOrigin to the A-number (calling number) and
changes the incoming NOA code to international.
Note If there is no CCOrigin value present when required, then the A-number is left unchanged.
Figure 1-18 Operation of a National Switching Node with Country Code Addition Capability
612345678
Incoming
NOA=National dial plan RouteList #55
0034612345678 BinternationalPrefix=00
NOA=Unknown
As shown in Figure 1-18, in the national dialplan the result type CC_DIG is set for the national mobile
number (CC_DIG=34), so for the calls being routed to each carrier the following occurs:
• TG1 - Carrier 1—Is the first choice for national mobile calls because it is the least expensive of the
three carriers. Carrier 1 accepts national calls only in the national number format. In this instance
the number format is national and needs no modification.
• TG2 - Carrier 2—Is the second choice because it is less expensive than Carrier 3, but it accepts
calls only in the international number format. To use Carrier 2 the BdigitCCprefix property is
enabled, the result for CC_DIG is prepended to the B-number (called number), and the incoming
NOA code is changed to international format.
• TG3 - Carrier 3—Is the last choice because it is the most expensive carrier, and it accepts calls only
to international numbers in the Unknown format. To use Carrier 3 the BdigitCCprefix property is
enabled and performed first, changing the number to international format as was done with TG2.
The BinternationalPrefix property is also enabled and is performed next. It takes the resulting
number (+34612345678) and detects the international NOA code, so it prepends “00” to the number
and sets the NOA code to Unknown.
Note Calls routed to Carrier 2 (TG2) from the international dial plan do not have CC_DIG set, so no
modification occurs when international calls get routed to this carrier; they are already in
International format with the country code. Calls routed to Carrier 3 (TG3) from the
international dialplan are still modified to Unknown format.
Figure 1-19 is an example of these capabilities to handle A-number (calling number) formats.
A=912345678
B=612345678
Incoming
NOA=National dial plan RouteList #55
66962
A=0034912345678 AinternationalPrefix=enable
NOA=Unknown
As shown in Figure 1-19, the CCOrigin trunk group property is “34” as set in the properties.dat file for
the incoming Trunk Group. For calls being routed to each of the three carriers the following occurs:
• TG1 - Carrier 1—Is the first choice for national mobile calls because it is the least expensive of the
three carriers. Carrier 1 accepts national calls only in the national number format. In this instance
the number format is national and needs no modification.
• TG2 - Carrier 2—Is the second choice because it is less expensive than Carrier 3, but it only accepts
calls in the international number format. To use Carrier 2 the AdigitCCprefix property is enabled,
and so the value of CCOrigin for the call (34) is prepended to the A-number (calling number), and
the incoming NOA code is changed to international format.
• TG3 - Carrier 3—Is the last choice because it is the most expensive, and it accepts calls only to
international numbers in the Unknown format. To use Carrier 3 the AdigitCCprefix property is
enabled and performed first, changing the number to international format as was done with TG2.
The AinternationalPrefix property is also enabled and is performed next. It takes the resulting
number (+34612345678) and detects the international NOA code, so it prepends “00” to the number
and sets the NOA code to Unknown.
Note Calls exiting down trunk groups that already have their A-number in international format are unchanged,
regardless of the state of the AdigCCprefix trunk group property. This applies to international transit
calls where the A-number has already been normalized into international format.
The requirements for an international switching function are slightly different from those for national
switching. In an international switching node, all numbers are normalized into international format
(typically the A- and B-numbers) and numbers are switched primarily according to analysis of the
country code and area code, such as a country’s mobile code.
However, many carriers (such as PTTs) require numbers routed to destinations within their country to
be presented in their national format with the country code removed, and numbers routed to destinations
in another country to be presented in international format with the country code still intact.
To provide this capability, the trunk group property BDigitCCrm is required to selectively remove the
country code from the B-number (called number) on a per trunk group basis.
If the BDigitCCrm property is set to a non-null value (a country code) and the NOA code is set to
international, the initial digits are removed from the B-number if they match the value of BDigitCCrm
(that is, if the B-number contains the same country code as BDigitCCrm). The NOA code is also reset
to national.
Figure 1-20 illustrates the operation of the BDigitCCrm property in an international switching node.
International
dial plan RouteList #55
TG1 – Carrier 1
612345678 BDigitCCrm=34
44208001234
Incoming NOA=National
Trunk Group NOA=International
dial plan 3461 TG1 – Carrier 1
34612345678 BDigitCCrm=null
NOA=International
66963
In the incoming trunk group dial plans, the country code is prepended for incoming numbers that are
presented in national format to normalize them into international format. Other modifications can also
be made; for example, inserting the country code in the front of the A-number (calling number) for that
trunk group and changing its NOA code to international.
The generic international dial plan determines the destination route lists for calls. For calls to national
mobile numbers beginning with “61,” the routing priority is Carrier 1, Carrier 2, and Carrier 3. The
international dialplan selects RouteList #55 for numbers beginning with “3461,” a number range that is
owned by Carrier 1. For each trunk group in Routing List #55 the following treatment is given:
• TG1 - Carrier 1—Is the first choice for national number format calls for their mobile number range.
The trunk group property BDigitCCrm is set to 34; therefore, calls with NOA code set to
international and prefixed with “34” have the country code deleted and the NOA code set to national.
All other international numbers are unaffected.
• TG2 - Carrier 2—Is the second choice, but accepts calls only in the international number format.
Property BDigitCCrm is set to null and calls are routed without modification from international
format.
• TG3 - Carrier 3—Is the third choice and it accepts calls only to international numbers in the
Unknown format. So property BDigitCCrm is set to null and the BInternationalPrefix property is
also enabled and is performed next. It takes the resulting number (+34612345678) and detects the
international NOA code, so it prepends “00” to the number and sets the NOA code to Unknown.
For numbers sent to Route List #14, Carrier 4 is the first choice and Carrier 1 is the second choice:
• TG4 - Carrier 4—Is the first choice, but this carrier requires the B-number (called number) to be
presented in national format. The trunk group property BDigitCCrm is set to “44;” therefore, calls
with the NOA code set to international and prefixed with “44” have the country code deleted and the
NOA code reset to national. All other international numbers are unaffected.
• TG1 - Carrier 1—Is the second choice and only accepts calls for Country code “44” in international
format. With property BDigitCCrm equal to “34,” the only called numbers.that have their country
code prefix removed are those with prefix digits of “34.”
There are two ways of routing calls to country code “44”:
• On TG4 by sending national format (by deleting the country code “44”)
• On TG1 by sending international format (by leaving the country code “44” intact)
Note Setting property BDigitCCrm to 34 has no effect on calls to country code “44.”
Consider what actions you want the Cisco PGW 2200 Softswitch takes if an occurred error can
jeopardize call completion, for example, the call fails for any reason. In the unexpected event that a
country code is not present when it is required, one of the following events occurs.
• A-Number handling—If a country code prefix is directed to be applied by the ADigitCCPrefix
property, but the digits are not available from the CCOrigin trunk group property, then the A-number
and NOA code are not changed. No action is taken and the call is allowed to continue.
• B-Number handling—If the CC_DIG result is expected during processing, but it is not retrieved
due to an error (such as a configuration error), one of the following incorrect actions can result:
– If only the country code prefix is required, it is not applied and the egress IAM contains the
numbers in the received national format and the NOA code is national format.
– If both the international number and country code prefix are required, the international prefix is
applied without the country code and an incorrect number is sent forward to the next switch.
If the BDigitCCPrefix trunk group property is set to enable country code addition functionality, but the
processing fails due to absence of the required country code digits, the call is forced to fail by setting an
IC_TEMPORARY_FAILURE cause and proceeding to Cause analysis.
To ensure that this occurrence is noted, an internal alarm is raised and an associated log message is issued
indicating that a prefix addition has failed.
TNS Feature
Within the Pre-analysis area, a stage is supported called TNS analysis. This stage provides an analysis
capability against the transit network selection parameter information (or the Carrier Selection
parameter information) as received in the incoming message.
As with the other Pre-analysis stages, all of the Pre-analysis results are available to this stage; but
specifically the capability to switch the call according to a received carrier ID is supported. The carrier
ID is an over-decadic or decadic character string that must provoke specific routing. Examples of carrier
IDs are D001, B77, 88, and 23456. The carrier ID is received in the incoming message (in the parameters
previously described) and is then extracted to analyze in this Pre-analysis stage.
The following capability is provided if a CarrierID is received in an incoming message:
• Route the call according to the CarrierID string.
• Route the call according to the B-number and ignore the CarrierID.
• Block the call according to the presented CarrierID.
The extracted OrigCarrierID string is used as input to this Pre-analysis stage and the following possible
results returned provide the previously listed capabilities.
• ROUTE, COND_ROUTE, or PERC_ROUTE—If any of these result types are returned, then the call
is to be routed according to the OrigCarrierID. The resulting data has routing information that is
used to immediately start the Routing analysis stage.
• If the call is to be routed according to the B-number and not the CarrierID, then this is indicated by
no results being returned from this stage, or just returning a specific result type (for example,
AMODDIG) that has Routing or Blacklist results).
• BLACKLIST—If this result type is returned, then the call is to be blocked according to the
CarrierID, an internal result is set to reflect this, and provoke call rejection.
To avoid the possibility of a routing loop where the MGC passes the call back to the preceding switch
that originated the call, some trunk group property checks are performed at the protocol level.
The property is provisioned against the incoming trunk group where it is expected that TNS information
is received. The OrigCarrierID property contains a CarrierID string identifying the previous switch. The
incoming protocol reads this property when processing the TNS information and verifies that the
CarrierId in the TNS parameter matches the OrigCarrierID parameter provisioned in the trunk group
property. If they do match, then a routing loop exists and the MGC rejects the call and sets cause to
“Normal Unspecified”. However, if there is no match on OrigCarrierID, then the protocol completes
processing and sends the data to analysis where the Pre-analysis stages are the first to be performed.
Routing Analysis
In a call control environment, Routing analysis normally occurs after Number analysis and ultimately
provides the means to traverse the routing lists, route, and trunk group data. Additionally, Routing
analysis can be invoked by the Pre-analysis stage or the Cause analysis stage. The purpose of Route
analysis is to find a trunk group within a set of routes that can be selected to be used to route the call to
the desired destination.
Routing analysis is started when Pre-analysis, B-number analysis, Cause analysis, or Conditional
Routing analysis returns a Route List Name (see Figure 1-21). The output from the Route List Name is
used to access the Route List, from which the search for routes and trunk groups is started.
The purpose of Route analysis is to select a trunk group. Route preferences or bearer preferences present
in the incoming IAM or Setup message are read and applied during the route selection process.
Based on customer requirements and preferences, the transmission medium can be selected by the Route
analysis function choosing the appropriate medium from the selected trunk group list. Additionally,
trunk groups could be selected based on bearer preferences or requirements present in the incoming
message. If that is the case, the order of trunk group selection would be influenced (for example, ISUP
essential indication).
Note Although routing analysis and route selection are part of the call routing process, they are not used by
the Cisco PGW 2200 Softswitch in signaling control mode. In the signaling control mode, all routes are
static, or “nailed-up,” and the outgoing trunk is based on the trunk (or circuit) used by the incoming call.
Dial plan
Route Holiday
Route List
Route
Routing Trunk
Group
Routing Terminology
The following terms are used when describing Routing analysis.
Route list—A collection of routing alternatives that can be used to transport a call between its origin and
its destination. The individual routes comprising the route list provide routing to the same destination,
but use different physical paths.
Route—A collection of trunk groups with a common destination and may be listed in more that one route
list. For example:
Containing
Route Trunk Groups Trunk Group Signaling
Herndon_Sterling TKGrp 1 ANSI SS7
TKGrp 2 Q761 ISUP
TKGrp 3 PRI
TKGrp 4 IP
TKGrp 5 SIP
Note All trunk groups are connected between Herndon and Sterling.
Trunk group—A collection of like circuits or channels (for example, all SS7 circuits with echo cancellers
connected) that connect the same two end points. All circuits within a trunk group have the same
signaling route, (that is, a signaling route is an attribute of a trunk group). A trunk group may be listed
in more than one route.
During Route list analysis, when trunk group data is being read and the trunk group is being assessed for
suitability, route preferences or bearer preferences (some present in the received IAM, Setup. or INVITE
message and some previously collected from Number analysis) are used in the selection process.
Number Termination
A result type present in the dial plan, called TERM_INFO and configured early in the B-number analysis,
indicates whether a full B-number analysis might be required to determine the final destination. On
detection of the TERM_INFO result type, the called number is searched in the Number Termination table.
The search returns a route list name used to start routing analysis. This avoids the need for a large dial
plan and reduces memory consumption when it is loaded.
% based
route Italy
Time of
Day tea
Routing Overflow
Within the percentage based routing functionality, the overflow capability exists that allows you to
assign percentage values to the routes if congestion occurs. The overflow methods are:
• If congestion occurs on the selected route list, then overflow to the route list with the next highest
percentage value. Continue this until the call is completed or until all routes are exhausted and then
set an internal cause value and invoke Cause analysis with the goal of clearing the call.
• If congestion occurs on the selected route list, then overflow to the route list with the next highest
percentage value. If all routes are exhausted, then overflow occurs to a final overflow route list that
is used only when all other options have been attempted and were all unsuccessful.
% based
route Italy
Time of
Day tea
80961
Rome Venice Turin Florence
The example in Figure 1-23 shows that if from the percentage-based route called Italy the route list
“Rome”, time of day “Tea” or route list “Florence” can be chosen. If the random algorithm chooses route
list ‘Rome” and the trunks were not available it would be possible then to use either the time of day route
“Tea” or route list “Florence” if overflow were enabled at the route list level. In the case where the route
list required from a PERC_ROUTE result cannot be selected because of congestion then try the other
route lists, starting with the highest percent. Therefore time of day “Tea” would be chosen and if all
trunks were not available then it would be possible to use route list “Florence”. If all trunks were
unavailable in route list “Florence” as well the call will go to cause analysis. From cause analysis the
call can be terminated with a well know cause value or further analysis can be supported, if the call enters
this cause value twice the call will be released.
*Indicates software Release 9.3(2) functionality.
Figure 1-24 Example of Percentage Based Routing Level Route List Overflow
% based
route Italy
Time of
Day tea
Route list Route list Route list Route list Route list
80959
Rome Venice Turin Florence Milan
The example in Figure 1-24 is the same as in Figure 1-23, except that there is an overflow route list
called Milan that is only ever entered if all other trunks in the route lists are unavailable. This means that
this route list is not used when the random algorithm chooses the first route list to be used. It will be
optional as to whether the overflow route list is configured.
Route list
1
Route NY Route DC
80958
Route A
80960
1 2
When a user creates a percentage-based route, he or she connects the entries to route list names or time
of day route names. The first entry created is the primary entry. The primary entry is used as the default
routing condition for any load that the user does not explicitly set. The load cannot be modified on the
primary entry in the percentage based route table because it is automatically changed when the load is
modified for other entries in the table.
The sum of all load values added to the percentage based routing name cannot exceed 100. If the sum of
the load values, not including the primary, matches 100, the primary entry has a value of 0.
It is enforced that a conditional route name cannot be connected to the percentage based routing if there
is currently in the conditional route table any percentage based routing name connected to the same
conditional route name to prevent routing loops. The same route list name or conditional route name
cannot be added to the percentage based route name multiple times; this same functionality can be
obtained by changing the value of the load. The primary route can be deleted only if the whole
percentage based route is deleted, since a percentage based route has to be configured for every
percentage based route name.
The overflow set allows you to define if the percentage based route handles overflow. If the overflow set
is changed, it is configured for all entries in the percentage based routing name. An overflow can only
be associated with a percentage base route name if the overflow set is enabled. The overflow defines a
routing condition that is used only if all percentage based routes with a defined load have been
exhausted. There can be only one overflow route for each percentage based routing name.
A maximum of five route list names and conditional route names can be configured in a percentage based
routing name.
Note Some performance impact can be expected when the time conditional routing function is invoked;
however, normally it should not exceed 5% on call processing.
Conditional Route
Conditional routes are connected to conditional route description names based on the day of week. The
first entry created in the conditional route is always the default day of week. It is used to provide a default
routing condition for any day of week that the user does not explicitly set. The default day of week can
be deleted only if the whole conditional route is deleted. Each conditional route supports a default entry,
seven days, and three holiday entries.
Route Holiday
The route holiday allows dates to be specified with the three holiday days. When a call is received that
is destined for conditional routing, the holiday days are used instead of the default entry; or the days,
Monday through Sunday, are used if a holiday day is associated with the actual date.
Provisioning route holiday allows you to separately enter holidays for routing purposes. The route
holiday list contains all the valid holidays for a given user.
The route holiday consists of the date and the holiday day.
• Date—The date is entered in the format yyyy.mm.dd. The following ranges apply:
– yyyy = 2000-9999
– mm = 01-12
– dd = 01-31
• Holiday Day—This number is a positive integer that indicates the holiday day. The valid values are:
– Hol1
– Hol2
– Hol3
Route List
The route list consists of a sequentially selected list of routes with a distribution entry against each route.
If distribution is enabled, a random number is used to provide the offset into the route table, which is
effectively a trunk group list. If distribution is disabled, then the routes are chosen in sequential
selection.
A route list entry can be entered from:
• The percentage route.
• The time of day routing.
• The number termination.
• The dial plan from a ROUTE or ANNOUNCEMENT result type.
The system gives a warning if more that 20 routes are created in the route list since only the first 20
routes are used.
Routes
Routes represent the sequential selection used to choose the trunk groups in the route. When distribution
is enabled in the route list, you can enable the weighted trunk groups feature so the same trunk groups
can occur in the same route multiple times.
Queuing
You can provision a queuing capability (by provisioning a value in TDM Attributes against TDM trunk
groups). If circuit selection on a trunk group has failed (with the response of trunk group congestion),
the MGC waits for a circuit to become free for the duration of this value returned from the TDM
Attributes. Thus the call is queued.
A queue timer value is returned from analysis (read from the TDM Attributes), where queuing is
applicable (if so provisioned). If a value other than 0 is returned, this value is used if a circuit is
unavailable. The call is then placed in the FIFO queue associated with that trunk group, to wait for an
available circuit.
Once a congestion message is received, the queue timer (set to the value received from analysis) holds
the call while waiting to receive an indication that a circuit is available.
When a circuit is available, the first call queued is removed from the list, assigns the circuit to it, and
indicates normal call processing can continue. However, if no circuit is selected and the queue timer
expires, then the call is released with a congestion indication.
If a forward release is received during queuing, the call is removed from the list when the call is released.
It is possible to make a number of repeat attempts to select a circuit on the same trunk group. The
maximum number of attempts is provisioned in the TDM Attributes by the ReAttempts field and is
delivered from analysis. If a value other than 0 is provisioned, it indicates that under certain conditions
reattempts are made to select a circuit on the current trunk group.
If reattempts are not provisioned (default value is 0), then no reattempts are made. Thus, if a
circuit-selection request is made and the response message is TrunkGroupCongestion, analysis is
resumed for a new trunk group that is not congested. In this case reattempts are not made. If there are no
more trunk groups available, a cause is set and the call is released.
Circumstances in which a reattempt is made on the same trunk group are:
• If glare occurs when setting up the TCC side.
• If COT failure occurs when setting up the TCC side.
• If when the outgoing IAM is sent forward (on TCC side) it is immediately responded to with a
release message from the subsequent exchange containing a cause reflecting one of the following
internal cause values:
– IC_CH_UNACCEPTABLE
– IC_NO_CIRCUIT_AVAILABLE
– IC_NETWORK_OUT_OF_ORDER
– IC_ACCESS_INFO_DISCARDED
– IC_SWITCHING_EQUIP_CONGESTION
– IC_REQ_CIRCUIT_UNAVAIL
– IC_RESOURCES_UNAVAIL_UNSPEC
– IC_TEMPORARY_FAILURE
– IC_CHANNEL_OUT_OF_SERVICE
– IC_PRIORITY_FORCED_RELEASE
– IC_PRECEDENCE_BLOCKED
– IC_PREEMPTION
– IC_PROTOCOL_ERROR_UNSPEC
– IC_OPERATOR_PRIORITY_ACCESS
– IC_REPEAT_ATTEMPT
Where reattempt is enabled, actions depend on the reattempt value. If this value is greater than 0, the
TCC side is disconnected and destroyed, call context is restored to the pre-circuit selection status, the
Reattempts counter decrements by 1, and then circuit selection starts again on the same trunk group. If
the same response occurs again, this process repeats, each time decrementing the counter.
Once the reattempt counter is 0, at the next occurrence, the TCC is disconnected and destroyed, call
context is restored as before and goes back to generic analysis for a new trunk group upon which to
attempt circuit selection. If generic analysis finds that no circuits are available but there are further routes
it will handle this, select the available trunk groups and eventually return a new trunk group. If there are
no more routes or trunk groups it returns indication of No More Trunk Groups and a corresponding cause
value.
Routing Features
Carrier Translation
To support NANP, to determine route selection is made for a particular carrier. When a call is received
with the Transit Network Selection parameter containing a CarrierID. If the XECfgParm.dat property for
VSCNetworkPlacement indicates “Nanp_AT”, then selection is made when searching the Route List to
only choose route lists supporting that connection to that particular carrier. In the Route List, the Carrier
ID field allows this cross referencing during route selection.
This functionality is removed and replaced by TNS in software Release 9.3(2).
Codec Selection
The GWDefaultCodecString property is provisioned against a trunk group, referred as level 2 codec
configuration and against the MGCP sigpath, referred to as level 1 codec configuration. The level 2
property is read if there is no level 3 (dial plan) configuration or if the level 3 configuration for the codec
list or the codec is defined as preferred.
The level 1 property is read if the level 2 codec configuration is not present and the level 3 configuration
is defined as preferred or there is no level 3 configuration. A default value for the
GWDefaultCodecString property is used if neither level 2, nor level 1, nor level 3 codec configuration
is present. The resulting codec list from level 3, level 2, or level 1 is then sent to the incoming gateway
in the Local Connection Option parameter of the create connect (CRCX) message.
If none of the codec levels are configured default level 0, which is “NULL” is used. When this occurs,
the MGC does not participate in codec negotiation other than to deliver the message by the MGCP
gateway. The MGCP gateway supports codec negotiation by the transfer of preferred codecs in the SDP
messages exchanged between the ingress and egress gateways. The decision for the codec to be used is
made at the gateway. Currently the ingress gateway sends a list of codecs in the SDP response to the
egress gateway. If any codec configuration levels are configured, they override level 0.
The Cisco PGW 2200 Softswitch supports different codec level configurations to influence the codec
negotiation by providing the configured codec list in the local connection option (LCO), which limits
the list of codecs from which the gateway can select. The gateway always responds with one of the
codecs from the list.
Note On the ingress side, for level 3, if preference is mandatory, it overrides level 2 and level 2 overrides level
1 and level 1 overrides level 0. However, on the egress gateway if level 2 is configured level2 overrides
all other levels.
Level 3 codec configuration allows the CODEC result type to be set in A number or B number analysis.
If the result specifies the preference, in dataword2, as mandatory, then the codec list from previous levels
is ignored and the egress call supports the codec specified in dataword1. When dataword2 is configured
to be preferred, then the codec list from the previous applicable level is appended after the codec
specified in dataword1.
Note Level 3 codec configuration overrides previous codec levels if the preference is mandatory on the ingress
side.
Route Advance
Cisco PGW 2200 Softswitch retrieves a trunk group no knowing the route in which this particular trunk
group resides. During this process, if all the trunk groups on a particular route have been exhausted, then
the next route in the route list is selected and the search for a suitable trunk group continues until one is
found or the route list is exhausted and then the search begins again.
This chapter describes the prerequisite tasks you need to perform before you can begin provisioning a
dial plan. It also describes the tools you will use, and provides detailed information on the dial plan
parameters and syntax conventions that you will need to be familiar with as you create your dial plan.
This chapter includes the following sections:
• Provisioning Prerequisites, page 2-1
• Provisioning Tools, page 2-3
• Creating a Dial Plan, page 2-5
• Dial Plan Text File, page 2-6
Note The Cisco PGW 2200 Softswitch uses, an active system and a standby system, for maximum reliability.
The dial plans discussed in this chapter apply to both the active and standby
Cisco PGW 2200 Softswitchs. You need only create one dial plan and deploy that dial plan on both the
active and standby Cisco PGW 2200 Softswitchs.
Tip Appendix C, “Dial Planning Worksheets,” provides a set of blank worksheet forms you can use to create
your dial plan. When you start creating your dial plan, copy these forms and write on the copies. This
way you can make additional copies of the forms if you need them.
The following sections describe recommended practices to assist you in provisioning dial plans for the
Cisco PGW 2200 Softswitch.
Provisioning Prerequisites
This section describes the tasks that must be completed and the information that you need before you
start dial plan provisioning.
Prerequisite Tasks
The following steps describe the tasks you should perform prior to using this dial plan guide.
Prerequisite Information
This guide provides a set of blank worksheets in Appendix C, “Dial Planning Worksheets,” that you can
copy and fill in with the dial plan information specific to your system. Before you can complete the dial
plan provisioning worksheets, you must collect provisioning information about all the available trunks.
During the provisioning process, all the bearer trunks that connect remote switches to all the media
gateways attached to the Cisco PGW 2200 Softswitch were defined. Each remote switch is identified by
its destination point code (DPC), and each trunk is identified by its trunk ID or Circuit Identification
Code (CIC).
Table 2-1 provides space for you to enter the following information:
• Trunk ID—Designation assigned to a trunk.
• Source Signaling Service—MML name of the previously defined source signaling service.
Valid signaling services are ISDN PRI, DPNSS, or any SS7 signaling service.
• Source Span—Number of circuits assigned to the source span (range 0 through 65535).
• Source Span ID—Identification assigned to the source span (range 0 through 65535).
• Source Time Slot/CIC—Time slot or Circuit Identification Code (CIC) (range 0 through 31).
• Destination Signaling Service—MML name of a previously defined destination signaling service.
Valid signaling services are ISDN PRI, DPNSS, or any SS7 signaling service.
• Destination Span—Number of circuits assigned to the destination span (range 0 through 65535).
• Destination Span ID—Identification assigned to the destination span (range 0 through 65535).
• Destination Time Slot/CIC—Time slot or Circuit Identification Code (CIC) (range 0 through 31).
• Line Type—T1 or E1.
1. Refer to the Hardware Installation and Configuration Guide for the media gateway used in your solution.
• Multiple Trunk Field—Number of trunks per span (greater than 0, but less than or equal to 31).
The ingress and egress trunk IDs must match the corresponding trunk IDs used on the remote switches.
The circuit identification codes (CIC) are the SS7 values representing the trunks and must also match
the CIC values defined at the remote switches.
The destination span ID and destination time slot must match the trunk configuration values defined
during Cisco PGW 2200 Softswitch configuration. The destination span ID is defined when configuring
T1 and E1 controllers and must match the value of the nfas_int parameter. T1 spans use channels (time
slots) 1-24 and E1 spans use time slots (channels) 0-31.
To save space, you might want to specify ranges of trunk IDs for each T1 or E1 connection. For large
installations, you should make copies of this table or create your own worksheet with these columns.
For more information on media gateway configuration, see the appropriate Media Gateway Installation
and Configuration Guide for your solution. Keep in mind that some of the procedures performed might
vary depending on the configuration of your solution.
Provisioning Tools
The Cisco PGW 2200 Softswitch includes two tools that you can use to provision the dial plan:
• The Voice Services Provisioning Tool (VSPT), a graphical user interface (GUI) application.
• The Man-Machine Language (MML), a command-line interface (CLI) application.
You can use both the VSPT and MML to provision the dial plan for a Cisco PGW 2200 Softswitch;
however, only one provisioning session can be supported at one time by either the VSPT or MML.
Although MML requires more keystrokes, quick dial plan updates can sometimes be made faster using
MML commands, because you do not have to go through the process of launching the VSPT and
navigating to the proper screen. When you enter MML commands into a batch file, you can copy and
paste commands to speed entry. You can also copy and modify MML scripts, which are collections of
individual MML commands, to configure additional dial plans.
After you create a dial plan or add information to an existing dial plan, you must enter a prov-cpy
command.
For more information on provisioning a dial plan using MML commands, see Chapter 4, “Provisioning
Dial Plans with MML.”
You may see different dial plan component names used in the VSPT and MML tools. When you begin
provisioning, provision components using the name that applies to the provisioning tool you are using.
You can use VSPT and MML to provision the Cisco PGW 2200 Softswitch; however, only one
configuration session can be supported at one time by MML. Table 2-3 lists some of the features of
VSPT and MML and provides some guidelines for selecting between the two tools.
Note When provisioning dial plans, the *.SysConnectDataAccess property (in XECfgParm.dat) must be set to
true to allow database access for A-number screening, LNP, and other dial plan functions. Refer to the
Cisco PGW 2200 Softswitch Release 9 Installation and Configuration Guide for more information on
software configuration settings.
Note The MML commands in the sample file are for illustration purposes.
prov-add:rttrnkgrp:name=”1111”,type=0
prov-add:rttrnkgrp:name=”2222”,type=0,reattempts=5,queuing=2,cutthrough=3
prov-add:rttrnk:name=”route1”,trnkgrpnum=1111,weightedtg=”ON”
prov-ed:rttrnk:name=”route1”,trnkgrpnum=2222,weightedtg=”ON”
prov-ed:rttrnk:name=”route2”,trnkgrpnum=2222
prov-ed:rttrnk:name=”route3”,trnkgrpnum=2222
prov-add:rtlist:name=”routelist1”,rtname=”route2”,distrib=”OFF”
prov-add:rtlist:name=”routelist2”,rtname=”route1”,distrib=”ON”
prov-add:rtlist:name=”routelist3”,rtname=”route3”,distrib=”OFF”
numan-add:dialplan:custgrpid=”dpl1”
numan-add:resultset:custgrpid=“dpl1”,name=“set1”
numan-add:resulttable:custgrpid=“dpl1”,name=“route”,resulttype=“ROUTE”,dw1=“routelist1”,
setname=“set1”
numan-add:bdigtree:custgrpid=“dpl1”,callside=“originating”,digitstring=“0”,setname=“set1”
numan-add:bdigtree:custgrpid=“dpl1”,callside=“originating”,digitstring=“1”,setname=“set1”
This chapter shows you how to use the Cisco Voice Services Provisioning Tool (VSPT) to provision a
dial plan on the Cisco PGW 2200 Softswitch. This chapter contains the following sections:
• Provisioning Dial Plans, page 3-1
• Performing an Integrity Check, page 3-46
• Provisioning Examples, page 3-47
When provisioning dial plans, you must first ensure that all system components have been provisioned
as described in the Cisco PGW 2200 Softswitch Release 9.8 Provisioning Guide.
Tip Before you begin provisioning your dial plan, you should have a list of the trunks that are available,
including their names, properties, and other parameters. This list should already have been created in
Chapter 2, “Preparing for Dial Plan Provisioning.” You should review this list before you begin
provisioning your dial plan and keep it available to refer to for information.
Note After you have deployed the active dial plan, you cannot modify it. To change an active dial plan, you
must save it using a different name, start a new provisioning session to edit it, then redeploy it.
The following sections provide examples of the Cisco VSPT screens you use in creating a dial plan:
• Importing a Dial Plan File, page 3-2
• Adding a Dial Plan, page 3-4
• Adding Dial Plan Details, page 3-5
You don’t have to add all the components in your dial plan. Your dial plan configuration depends on your
needs in an actual network.
Caution Consider importing a dial plan text file for initial provisioning only. When you import a dial plan file,
all existing dial plan data is replaced by the dial plan data in the file you import.
Note Before migrating a dial plan created with Cisco PGW 2200 Softswitch software release 9.7(3) to release
9.8(1), first install the base version of release 9.8(1). Then, before starting the software, install release
9.8(1) patch S7P7 or later.
Step 2 Click From File, then on the File type pull-down menu choose Dialplan File.
Step 3 Enter the name of the dial plan file that you want to import in the File name data entry box.
If you do not know the name of the file, click Select to specify the file to import.
Step 4 Locate the file you want to import, select it, and click Open.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
You see a screen similar to the one in Figure 3-2.
Step 2 Enter a customer group ID, which is a unique four-character alphanumeric identifier for your dial plan.
Step 3 Click Add.
The customer group ID you added appears under Number Analysis on the left of the screen.
Results
• Adding Digit Modification String Data, page 3-6
• Adding Bearer Capability (BC) Data, page 3-8
• Adding High Layer Capability (HLC) Data, page 3-9
• Adding a Customer VPN ID, page 3-10
• Adding Domain Modification String Data, page 3-10
• Adding a Result Set, page 3-11
• Adding or Modifying a Default Result Set, page 3-13
• Adding Screening Data, page 3-15
• Adding Service Data, page 3-16
• Adding Source Black Data, page 3-17
• Adding a Domain Routing Policy (DRP) Table, page 3-18
• Adding Route Selection Data, page 3-18
• Adding Destination Translation Data, page 3-19
Triggers
• Adding A-number Charge Origin Data, page 3-20
• Adding A-Digit Tree Data, page 3-21
• Adding A-number Dial Plan Selection, page 3-22
• Adding B-Digit Tree Data, page 3-23
• Adding Cause Data, page 3-25
• Adding Calling Line Identification Prefix, page 3-27
• Adding CLI IP Address, page 3-28
• Adding Calling Party Category, page 3-29
• Adding Dial Plan Selection Data, page 3-30
• Adding H.323 ID, page 3-30
• Adding Location Data, page 3-31
• Adding Nature of Address (NOA) Data of A-number and B-number, page 3-32
• Adding Numbering Plan Indicator (NPI) Data of A-number and B-number, page 3-33
• Adding Route Holiday, page 3-34
Global Items
• Adding Announcements, page 3-37
• Adding Ported Number Table Data, page 3-39
• Adding Script, page 3-41
• Adding Full Number Translation Data, page 3-42
• Adding Term Table Data, page 3-43
• Adding Test Line Data, page 3-45
Step 1 From the main provisioning screen of the Cisco VSPT, choose the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID.
Step 3 Click Digmodstring in the Results hierarchical menu.
You see a screen similar to the one in Figure 3-3.
Step 5 Enter the digit modification name and the digit modification string. Then Click OK.
You return to the screen in Figure 3-3, which displays the digit modification string you added.
Step 6 Repeat Steps 1 to 3 until all of the necessary digit modification strings have been added.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Then click BC.
You see a screen similar to the one in Figure 3-5.
Step 4 Enter a name for this BC table entry in the Name field.
Step 5 Choose a BC coding option from the BC Name drop-down list.
The drop-down list gives all the available BC coding options which indicate the bearer channel
characteristics as being either fax or data and a baud rate.
Step 6 Click OK.
Step 1 From the main provisioning screen of the Cisco VSPT, choose the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID, then click HLC.
Step 3 Click the Add button at the bottom of the screen.
You see a screen similar to the one in Figure 3-7.
Step 4 Enter a name for this HLC table entry in the Name field.
Step 5 Choose an HLC coding option from the HLC Name drop-down list.
The drop-down list gives all the available HLC coding options which indicate the high layer
compatibility characteristics as being either fax or data and a baud rate.
Step 6 Click OK.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Then click Customervpnid.
Step 3 Click the Add button at the bottom of the screen.
You see a screen similar to the one in Figure 3-8.
Step 1 From the main provisioning screen of the Cisco VSPT, choose the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Then click Dmnmodstring.
Step 4 Enter the source modification name in the Domain Name field.
Step 5 Enter the domain name to be modified (for example, cisco.com) in the Domain String field.
Step 6 Click OK.
Step 7 Repeat Steps 2 through 5 until all of the necessary domain modification strings have been added.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Then click Resultset.
You see a screen similar to the one in Figure 3-10.
Step 3 Click the Add button near the center of the screen.
You see a screen similar to the one in Figure 3-11.
Step 7 From the Result Type drop-down list, choose the desired result type.
A result type indicates a certain action you want the Cisco PGW 2200 Softswitch to perform. For
example, the result type BMODDIG indicates the B-number modification. You need to provide
additional information for the chosen result type as described in Step 8.
Step 8 Enter the required information.
In this example, enter the result name. Then choose the route list from the Route list name drop-down
list.
Figure 3-12 shows the definition of a ROUTE result for the result set testResultset.
For more information on result tables, see Chapter 1, “Dial Plan and Routing.”
Step 9 Click OK.
You see the screen in Figure 3-10, which displays the result type you just defined.
Step 10 Repeat Steps 5 through 8 to add another result type to the result set.
Repeat Steps 1 through 8 to provision another result set.
Note If you define more than one result for a result set, you can select a result then use the arrow buttons on
the right to rearrange the order of the results. See Figure 3-10.
Only one default result set is allowed for each customer group ID. Creating a new default result type
overwrites the previous default result type. Only one of the following result types is allowed for the
default result set at any time:
• BLACKLIST—Analysis of the B-number reveals that it is on the black list and the call is released.
• ROUTE—Analysis of the B-number reveals that the call is to be routed elsewhere.
• CAUSE—Analysis of the B-number reveals that the call is to be released with a specified cause.
To add or modify a default result set, complete the following steps:
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Then click DefResultSet.
You see a screen similar to the one in Figure 3-13.
Step 3 Choose the default result set from the Result Type drop-down list.
Step 4 Complete the settings under the Result Type drop-down list. Then click Modify.
These settings vary depending on your choice in Step 2.
Note The Screening component is moved to Tools > Advanced Number Editor on the menu bar in
Cisco VSPT Release 2.8(1).
Step 1 Choose Tools > Advanced Number Editor from the menu bar.
You see a screen similar to the one in Figure 3-14.
Step 2 Click the tab of the desired file type (AWhite, ABlack, BWhite, or BBlack).
Step 3 If you are editing an exiting screening file, choose File > Open to select an existing file from a pop-up
menu and click Open.
Step 4 Choose Edit > Add new item to add new screening data.
Step 5 Enter the customer group ID of the dial plan that you want to add new numbers to in the Dialplan field.
Step 6 Enter the screening numbers in Screening numbers field.
Step 7 Choose the action you want to perform on this entry.
• Add—Add this entry to the list
• DLT—Remove this entry from the list
Note You can add, modify, and remove a selected screening entry using options in the Edit menu.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Then click Service.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-16.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Then click SourceBlack.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-17.
Step 4 Enter the domain name to be screened (such as example.com) in the Domain String field.
Step 5 From the Service Name drop-down list, choose a service.
Step 6 Click OK.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Then click DRPTable.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-18.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Then click RouteSel.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-19.
Step 4 Enter the destination username (such as bob@cisco.com) or domain name (such as cisco.com) in the
Destination Domain String field.
Step 5 Enter the source username (such as bob@example.com) or domain name (such as example.com) in the
Source Domain String field.
Step 6 From the Service Name drop-down list, choose a service.
Step 7 From the Route List Name drop-down list, choose a route list.
Step 8 Click OK.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Then click DestTrans.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-20.
Step 4 Enter the username or domain name to be translated in the Destination Domain String field.
Step 5 From the Service Name drop-down list, choose a service.
Step 6 Enter the display name for the user in the Display Name field.
Step 7 Enter the new user name in the User Name field.
Step 8 Enter the new domain name in the Domain Name field.
Step 9 Enter the URI parameters that the Cisco PGW 2200 Softswitch adds to the header in the URI Parameters
field.
Note The URI parameters value must start with a semicolon, such as ;USER=phone.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click Achgorigin.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-21.
Step 4 Enter the calling line identity (CLI) in the CLI String field.
The valid value for this field is a digit string (from 1 to 20 digits), A to F allowed if the dial plan supports
overdecadic.
Note The CLI String value is a per call configuration. If there is no match between the provisioned
CLI value and the incoming CLI value, the Cisco PGW 2200 Softswitch cannot activate the
requested AOC supplementary service.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click Adigtree.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-22.
Step 4 Enter all the digits or part of the digits in a calling number in the Digit String field.
The valid value for this field is a digit string (from 1 to 32 digits), A to F allowed if the dial plan supports
overdecadic.
Note If the calling number of an incoming call begins with this digit string, the
Cisco PGW 2200 Softswitch performs the actions defined in the result set you chose in Step 4.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click A Num DpSelection.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-23.
Step 4 Enter the calling line identification value (the full A-number) in the CLI String field.
The valid value for the this field is a digit string (from 1 to 20 digits), A to F allowed if the dial plan
supports overdecadic.
Step 5 Choose one dial plan name from the DialPlan Name drop-down list.
This value specifies the new dial plan that you want to divert to.
Step 6 Click OK to add the new value.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers and then click Bdigtree.
You see a screen similar to the one in Figure 3-24.
Step 4 Enter all the digits in a calling number in the Digit String field.
The valid value for this field is a digit string (from 1 to 32 digits), A to F allowed if the dial plan supports
overdecadic.
Note The digit string you enter can be either a part of the B-number or the full B-number. If the called
number (B-number) of an incoming call begins with this digit string, the
Cisco PGW 2200 Softswitch performs the actions defined in the result set you chose in Step 6.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click Cause.
You see a screen similar to the one in Figure 3-26.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click Cliprefix.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-28.
Note This CLI set name is used when you are adding advanced screening and modification for H.323
messages coming from different call managers or for source IP address of the call manager. See
the “Adding CLI IP Address” section on page 3-28 and the “Adding H.323 ID” section on
page 3-30 for more information on the advanced screening and modification provisioning.
Step 5 Enter CLI prefix value in the Cli Prefix String field.
The valid value for this field is a digit string (from 1 to 20 digits), A to F allowed if the dial plan supports
overdecadic.
Note A DEFAULT CLI prefix entry must be configured for each CLI set name. If an incoming call
matches the CLI prefix parameter you provisioned in Cli Prefix String field, the
Cisco PGW 2200 Softswitch selects this dial plan customer group ID for this call.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click CliIpAddr.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-29.
Note If the source IP of the incoming call message matches the address you provisioned in Step 3 and
4, the Cisco PGW 2200 Softswitch selects an CLI set. If the incoming call matches an CLI prefix
defined in that CLI set, the Cisco PGW 2200 Softswitch selects the customer group ID of that
CLI prefix entry to continue the number analysis.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click CPC.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-30.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click DpSelection.
Step 3 Click Add.
You see a screen similar to Figure 3-31.
Step 4 Choose another dial plan in the Dialplan Name drop-down list.
This value indicates the diverted-to dial plan.
Step 5 Click OK to add the new value.
Adding H.323 ID
The h323iddivfrom parameter allows you to associate an H.323 ID with a specific customer group. If an
incoming call matches the H.323 ID parameter, you can apply certain dial plan functions to it.
To add an H.323 ID to a customer group, perform the following steps:
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID, then click h323iddivfrom.
Step 3 Click Add.
You see a window similar to the one in Figure 3-32.
Note If the incoming call matches the H.323 ID parameter you provisioned in Step 3, the
Cisco PGW 2200 Softswitch selects an CLI set. If the incoming call matches an CLI prefix
defined in that CLI set, the Cisco PGW 2200 Softswitch selects the customer group ID of that
CLI prefix entry to continue the number analysis.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click Location.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-33.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click Anoa.
Step 4 Enter the NOA value for A-number in the ANOA Value field.
The valid value for the location block is an integer.
Note If you are adding NOA value for B-number, enter the value in the BNOA Value field.
Note If you are adding NOA value for B-number, choose the NPI block for B-number from the BNPI
drop-down list.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click Anpi.
Step 4 Enter the NPI block for A-number in the ANPI block field.
The value in this field is the value specified in the NPI Block column of the NOA. The valid value for
this field is an integer in the range of 1 to 1000.
Note If you are adding the NPI data for B-number, enter the value in the BNPI block field.
Step 5 Enter the block offset value in the Block value field.
The value defines NPI block offset of a certain NPI block which is specified in Step 3.
Step 6 In the Result set drop-down list, choose the result set. Click OK.
The result set you chose is associated with the NPI value of the NPI block.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click RTE Holiday.
Step 3 Click Add.
Step 4 Enter a holiday date by choosing the month (January through December) from the drop-down list.
Step 5 Enter the year or click the arrows on the right to increase or decrease the value.
Step 6 Choose the day from those displayed.
Step 7 Choose the holiday type from the Holiday Type drop-down list.
Step 8 Click OK to add the new holiday.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click TMR.
Step 3 Click Add.
You see a screen similar to the one shown in Figure 3-37.
Note The TMR value you enter here is an internal TMR value. The Cisco PGW 2200 Softswitch maps
the external TMR values to the internal TMR values differently for the Q.761, Q.767, and ANSI
protocol variants. See Appendix A, “NOA and NPI Codes, CPC and TMR Values” for more
information.
Step 5 Choose an result set from the Result set drop-down list.
Step 6 Click OK to add the TMR.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 To expand the Number Analysis hierarchical menu, click the icon to the left of the appropriate customer
group ID. Click Triggers. Then click TNS.
Step 3 Click Add.
You see a screen similar to the one shown in Figure 3-38.
Note The result set is associated with the TNS value. If there is a match between this TNS value and
the TNS value in the incoming message, the Cisco PGW 2200 Softswitch performs the actions
defined in the result set you chose.
Adding Announcements
The ToneAndAnnouncement database table contains all the announcement details. An announcement ID
identifies the announcement.
To add an announcement, perform the following steps:
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis button on the left
side of the screen.
Step 2 Expand the Number Analysis menu by click the icon before it. Click Global Items. Then click
Announcement.
You see a screen similar to the one in Figure 3-39.
Step 5 Choose the gateway type from the Gateway type drop-down list.
This parameter identifies the gateway type for this side of the call.
Step 6 Enter the intended duration (measured in seconds) in the Play Duration field.
This parameter indicates the intended duration for which the announcement or tone is played. The valid
value for this field is an integer in the range of 0 to 120. The default value is 60.
Step 7 Enter the intended number of times to play the announcement in the Repeat field.
This parameter indicates the number of times the announcement or tone is repeated; or indicates if it
must be played continuously for the specified duration. A value of 0 indicates continuous playing. The
valid value for this field is an integer in the range of 0 to 5. The default value is 1.
Step 8 Enter the intended silence interval (measured in milliseconds) in the Interval field.
This parameter indicates the silence interval duration between re-playing an announcement or tone. The
valid value for this field is an integer in the range of 0 to 5000. The default value is 3000.
Step 9 Enter the location string in the Location String field.
Step 10 This location string indicates to the gateway the audio file to be loaded for announcement playing. The
string format varies according to the gateway type and its configuration. The string information is part
of a URL string that the Cisco PGW 2200 Softswitch sends by MGCP to the gateway. The maximum
length of string is 128-characters.
Note The ported number table component is moved to Tools > Advanced Number Editor on the menu bar in
Cisco VSPT Release 2.8(1).
To add data in the ported number table, complete the following steps:
Step 1 Choose Tools > Advanced Number Editor from the menu bar.
Step 2 Click the Porttbl tab.
You see a screen similar to the one in Figure 3-41.
Note When the Cisco VSPT imports a configuration from the Cisco PGW 2200 Softswitch, it does not
automatically load the ported database. Sometimes the ported database could be very large, and the
Cisco VSPT might run out of memory when loading the whole database. You can choose Command >
Rtrv all from VSC from the menu bar to import all these tables to the Cisco VSPT.
The valid value for this field is a digit string (from 1 to 20), A to F allowed if the dial plan supports
overdecadic. This digit string is the B-number digits (can be post normalization or modification).
Step 5 Enter a routing number in the Routing number field.
The valid value for this field is a digit string (from 1 to 20), A to F allowed if the dial plan supports
overdecadic. This digit string is the Routing number prefix for ported numbers.
Step 6 Enter the minimum and maximum length for call origination from this traffic path.
The valid value for these two fields is an integer in the range of 0 to 20.
Note The minimum length and maximum length values being created here relate to the B-Number post
database reading. They do not relate to the incoming digits received from line.
Adding Script
To support the MGCP scripting feature on Cisco PGW 2200 Softswitch, you need to provision a script
table.
To add the script data in the script table, complete the following steps:
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 Expand the Number Analysis menu by click the icon before it. Click Global Items, then Script.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-43.
Step 5 From the GW Type drop-down list, choose the gateway type.
Note The Script ID and the GW Type fields are the keys to the script table.
Step 6 From the Script Type drop-down list, choose the script type to be invoked and is used as the language
type in the signal request parameter S: for the script invocation. (For example, S:script/tcl or
S:script/java, is based on this definition.)
Step 7 Enter the location of the script in the Script Location field.
The valid value for this field is a string no longer than 128 alphanumeric characters.
Step 8 (Optional) Enter the script parameters in the Script Parameters field.
The information provided in this string is used as is in the script invocation command to the gateway.
The string format and the information provided here conform to the specific gateway script
requirements. This field is limited to 128 alphanumeric characters.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis radio button on the
left side of the screen.
Step 2 Expand the Number Analysis menu by click the icon before it. Click Global Items. Then click
FullNumberTrans.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-44.
Note The term table component is moved to Tools > Advanced Number Editor on the menu bar in
Cisco VSPT Release 2.8(1).
Step 1 Choose Tools > Advanced Number Editor from the menu bar.
Step 2 Click the Termtbl tab.
You see a screen similar to the one in Figure 3-45.
Note When the Cisco VSPT imports a configuration from the Cisco PGW 2200 Softswitch, it does not
automatically load the term table database. Sometimes the database could be very large, and the
Cisco VSPT might run out of memory when loading the whole database. You can choose Command >
Rtrv all from VSC from the menu bar to import all these tables to the Cisco VSPT.
Step 3 Choose Edit > Add new item from the menu bar.
You see a screen similar to the one in Figure 3-46.
Step 4 Enter a called number value, then choose a route list name.
The RouteID is associated with the called number you entered.
Step 5 Choose Add or DLT from the ADD/Remove drop-down list.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Number Analysis button on the left
side of the screen.
Step 2 Expand the Number Analysis menu by click the icon before it. Click Global Items, then click Testline.
Step 3 Click Add.
You see a screen similar to the one in Figure 3-47.
Step 4 Enter the name in the Test Line Name field for the test call.
This string can be up to 20 alphanumeric characters.
Step 5 Enter the delay value (measured in milliseconds) for the test call.
Step 6 Choose Yes in the loopreqField if you want loop required on. Otherwise, choose No.
Step 7 Enter the first tone type and its duration.
Step 8 Enter the second tone type and its duration.
Note In this example, the test line Test2 is added. First the Cisco PGW 2200 Softswitch delays 300
milliseconds and plays the first tone, old milliwatt (1000Hz), for a duration of 1000
milliseconds. Then it plays the second tone, really new milliwatt (1013.8Hz), for a duration of
2000 milliseconds. The Cisco PGW 2200 Softswitch repeats the whole process until the call is
released or it releases the call when the TestLineDuration times out.
Step 1 From the Tools menu, choose Integrity Check. You see a screen similar to the one in Figure 3-48.
Step 2 Click the Run individual tests radio button and check the Check dialplan results check box.
Step 3 Click Start.
The tests run. When they finish, you see a screen similar to the one in Figure 3-49.
Provisioning Examples
This section presents an example showing the typical provision of a dial plan with Cisco VSPT (see
Figure 3-50). This dial plan example is for illustration purpose only. The provisioning might vary in an
actual network.
Provisioning Outline
Perform the following steps to provision the sample configuration with Cisco VSPT 2.8(1).
Step 2 Enter the configuration name and click OK. You see a screen similar to the one in Figure 3-1.
Step 3 Click the Perform manual configuration radio button at the bottom of the screen. Then click OK.
Step 1 Expand the dial plan 1111 and click Dp Selection in the Trigger menu.
Step 2 Click Add in the bottom of the screen.
Step 3 Choose 2222 in the Dialplan Name drop-down list and click OK.
Step 4 Repeat Step 1 to Step 3 to add a dial plan selection for 3333.
Step 5 Click the ResultSet under Results menu of the dial plan 1111.
Step 6 Click Add in the middle of the screen and enter the result set name. Then click OK.
In this example, enter DpSelResultSet1 for the result set name.
Step 7 Highlight the newly added DpSelResultSet1 and click Add in the bottom of the screen.
Step 8 Enter the DpSelResult1 as the result name. Then click OK.
Step 9 Repeat Step 5 to Step 8 to add a new result set DpSelResultSet2 and a new result DpSelResult2.
Step 10 Click Bdigtree under the Triggers menu and click Add in the bottom of the screen.
Step 11 Enter the required information as shown in Figure 3-58. Then click OK.
Step 12 Repeat Step 10 and Step 11 to associate 202 digit string with DpSelResultSet2.
numan-add:resulttable:custgrpid="1111",setname="DpSelResultSet1",resulttype="NEW_DIALPLAN"
,name="DpSelResult1",dw1="2222",dw2="2"
numan-add:bdigtree:custgrpid="1111",callside="originating",setname="DpSelResultSet1",digit
string="101"
numan-add:dpsel:custgrpid="1111",newdp="3333"
numan-add:resultset:custgrpid="1111",name="DpSelResultSet2"
numan-add:resulttable:custgrpid="1111",setname="DpSelResultSet2",resulttype="NEW_DIALPLAN"
,name="DpSelResult2",dw1="3333",dw2="2"
numan-add:bdigtree:custgrpid="1111",callside="originating",setname="DpSelResultSet2",digit
string="202"
Step 1 Click the Resultset under the Results menu for the dial plan 2222.
Step 2 Add a result set and add a result in that result set.
In this example, add the result set Resultset2222 and add the result WhitelistResult as shown in
Figure 3-59.
Step 3 Click Adigtree under the Triggers menu of the dial plan 2222.
Step 4 Add the Adigtree with the desired A-number trigger.
In this example, add 301648 as the A-number trigger as shown in Figure 3-60. If the calling number
starts with 301648, the Cisco PGW 2200 Softswitch performs the actions defined in the result set
Resultset2222.
Step 5 Choose Tools > Advanced Number Editor from the menu bar.
You see a screen similar to the one shown in Figure 3-61.
Step 8 Choose Save this panel in the File menu and specify the name and the folder.
The working configuration is saved in /var/opt/CSCOvsp27/data/mgc/mistral/"Configuration
Name"/WORKING.
Step 9 Choose a deployment option in the Command menu to deploy the screening file.
Step 1 Click the Service under the Results menu for the dial plan 3333.
Step 2 Add a service entry.
In this example, add a service entry Washington.
Note The service provides additional call screening capabilities. See Chapter 1, “Dial Plan and Routing.” for
details.
Step 5 Click Bdigtree under the Triggers menu of the dial plan 3333.
Step 6 Add the Bdigtree with the desired B-number trigger.
In this example, add 703483 as the B-number trigger as shown in Figure 3-63. If the called number starts
with 703483, the Cisco PGW 2200 Softswitch performs the actions defined in the result set
Resultset3333.
Step 7 Choose Tools > Advanced Number Editor from the menu bar.
Step 8 Click the BBlack tab.
Step 9 Choose Add new item in the Edit menu.
Step 10 Add a new number entry as shown in Figure 3-65. Then click OK.
Step 11 Choose Save this panel in the File menu and specify the name and the folder.
The working configuration is saved in /var/opt/CSCOvsp27/data/mgc/mistral/"Configuration
Name"/WORKING.
Step 12 Choose a deployment option in the Command menu to deploy the screening file.
The corresponding MML commands for these two procedures are as follows:
numan-add:resultset:custgrpid="2222",name="Resultset2222"
numan-add:resulttable:custgrpid="2222",name="WhitelistResult",resulttype="SCREENING",setna
me="Resultset2222",dw1="1",dw3="1111",dw4="1111"
numan-add:adigtree:custgrpid="2222",callside="originating",setname="Resultset2222",digitst
ring="301648"
numan-add:awhite:custgrpid="2222",cli="3016484444"
numan-add:service:custgrpid="3333",name="Washington"
numan-add:resultset:custgrpid="3333",name="Resultset3333"
numan-add:resulttable:custgrpid="3333",name="BlacklistResult",resulttype="SCREENING",setna
me="Resultset3333",dw1="1",dw2="Washington",dw3="1111",dw4="1111"
numan-add:bdigtree:custgrpid="3333",callside="originating",setname="Resultset3333",digitst
ring="703483"
numan-add:bblack:custgrpid="3333",svnname="Washington",cli="3016484444"
Step 1 Expand the dial plan 2222 and expand the Results menu under it.
Step 2 Click the component Digmodstring.
Step 3 Click the Add button at the bottom of the screen.
Step 4 Then enter the required information as shown in Figure 3-66. Click OK.
Step 5 Expand the dial plan 3333 and expand the Results menu under it.
Step 6 Repeat Steps 2 through 4 for dial plan 3333 to add the DigitMod1 with the digit modification string 70.
Step 7 Add a result AddDigitResult with the result type BMODDIG for dial plan 2222 to insert 86 before the
incoming called number.
Enter the required information as shown in the Figure 3-67.
Step 8 Add a result RemoveDigitResult with the result type BMODDIG for dial plan 3333 to remove 70 at the
beginning of the incoming called number.
Enter the required information as shown in the Figure 3-68.
Note In result sets that are associated with A-number analysis triggers, like Adigtree, you cannot add routing
information. The A-number analysis results are saved and used in the following analyses, like B-number
analysis. In result sets that are associated with B-number analysis triggers, like Bdigtree, you can add
routing information. In this example, you add a Bdigtree to contain routing information for dial plan
2222.
Figure 3-69 Adding a Route Result in a Result Set for Dial Plan 2222
Step 11 For dial plan 2222, add a Bdigtree trigger with the associated result set to RouteResultSet as shown in
Figure 3-70.
Step 12 Add a result with result type ROUTE in the Resultset3333 result set in dial plan 3333.
Note As mentioned previously, the result sets that are associated with B-number analysis triggers can contain
routing information. In this example, Resultset 3333 is associated with Bdigtree which is one of the
B-number analysis triggers. So you can add a result with the result type ROUTE in Resultset3333.
Step 1 From the main provisioning screen of the Cisco VSPT, click the Traffic button on the left side of the
screen. Expand the Traffic hierarchical menu by clicking the icon to the left of Traffic. Expand the
Routing menu and click Description.
You see a screen similar to the one in Figure 3-71.
Step 3 Enter the name for the conditional route description in the Name field.
Step 4 Enter the T1 time and choose the desired route in the Route drop-down list between the T0 and T1 fields.
You are defining that between the time 00:00 and 09:00 of the day (in 1200 format for 12:00), the
Cisco PGW 2200 Softswitch uses PBXrtelst as shown in the Figure 3-73. Continue the route definition
of the remaining time periods for the whole day.
Step 5 Repeat the Step 2 through 4 to add another conditional route description Cond2.
prov-ed:condRte:name="ConRte1",dow="Tuesday",condRteDesc="Cond1"
prov-ed:condRte:name="ConRte1",dow="Wednesday",condRteDesc="Cond2"
prov-ed:condRte:name="ConRte1",dow="Thursday",condRteDesc="Cond1"
prov-ed:condRte:name="ConRte1",dow="Friday",condRteDesc="Cond2"
prov-ed:condRte:name="ConRte1",dow="Saturday",condRteDesc="Cond1"
prov-ed:condRte:name="ConRte1",dow="Hol2",condRteDesc="Cond1"
Step 1 Click Routing > Percentage Routing in the left pane of the main Cisco VSPT window.
Step 2 Click Add in the bottom of the right pane.
Step 3 Enter required information as shown in Figure 3-76.
The TCAPIP or APC drop-down menu is used to specify the point code to be used to access the STP/SCP
pair. Choose the stp-1 in this example.
In this example, enter 123 for the Local SSN which identifies the subsystem to use for the TCAP
message. Enter 1 for the STP/SCP index which provides the unique index for SCP.
Adding an IN Trigger
To use the IN_Trigger result set to initiate a TCAP message to the Intelligent Network, complete the
following steps:
Step 1 Click the Number Analysis radio button to return to number analysis provisioning.
Step 2 Click the Resultset component under dial plan 1111 and add a result set Resultset1111.
Step 3 Add the result LNPdip with the result type IN_TRIGGER in the Resultset1111 result set as shown in the
Figure 3-78.
Note Reattempt—Reattempts take place up to the limit provisioned in trunk group data. If the counter is
exceeded, a trunk group advance takes place.
Redirect—Redirect to a new trunk group to attempt circuit selection.
TGAdvance—Reroute the call on an alternate route.
Step 4 Choose the Reattempt in the Retry type drop-down list. Then click OK.
Step 5 Click Cause under the Triggers menu of dial plan 1111.
Step 6 Click Add at the bottom of the screen.
Step 7 Enter the required information as shown in Figure 3-81.
Adding Announcement
To generate an announcement in the event that a cause value is received indicated that all circuits are
busy, complete the following steps:
Step 1 Click Resultset under the Results menu of dial plan 1111.
Step 2 Highlight the result set CallRetry you just added.
Step 3 Add a result with ANNOUCEMENT as the result type as shown in Figure 3-82.
Note Announcement ID—Four digit number identifying the announcement on the announcement server.
Announce. type—Identifies whether the server is locally connected to the Cisco PGW 2200 Softswitch
via ethernet or connected remotely via a PRI through the Cisco PGW 2200 Softswitch.
Route List ID—Route group name used to route to the announcement server.
Announcement data—Enables the switching off of a trunk group property Announcement for certain
A-numbers or B-numbers. Not applicable when the announcement type is remote.
The corresponding MML commands for these two procedures are as follows:
nuam-add:resultset:custgrpid="1111",name="CallRetry"
numan-add:resulttable:custgrpid="1111",name="CallRetryResult",resulttype="RETRY_ACTION",se
tname="CallRetry",dw1="1"
numan-add:cause:custgrpid="1111",causevalue="34",setname="CallRetry"
numan-add:resulttable:custgrpid="1111",name="Announcement",resulttype="ANNOUNCEMENT",setna
me="CallRetry",dw1="1234",dw2="1",dw3="rtlist111stim",dw4="2"
Step 1 Click the MGC Config radio button and expand the Signaling menu.
Step 2 Click Location Label and enter the required information as shown in Figure 3-83.
Step 1 Click the Number Analysis radio button and expand the dial plan 1111.
Step 2 Add a new result set CallLimitingSet.
Step 3 Add a new result CallLimitingRes as shown in Figure 3-84.
The corresponding MML commands for these two procedures are as follows:
prov-add:Loclabel:name="LOCLABEL-1",desc="Call Limiting",calllimit=3000
numan-add:resultset:custgrpid="1111",name="CallLimitingSet"
numan-add:resulttable:custgrpid="1111",name="CallLimitingRes",resulttype="loc_label",
dw1="LOCLABEL",setname="CallLimitingSet"
numan-add:adigtree:custgrpid="1111",callside="originating",digitstring="303",setname="Call
LimitingSet"
Step 2 Enter the destination configuration name on the Cisco PGW 2200 Softswitch.
Step 3 Click the radio button before the desired deployment action.
________________________________________
; Start the Provisioning Session
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-sta::srcver="new",dstver="test",confirm
________________________________________
; Add Dial Plans
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
numan-add:dialplan:custgrpid="1111",overdec="NO"
numan-add:dialplan:custgrpid="2222",overdec="NO"
numan-add:dialplan:custgrpid="3333",overdec="NO"
________________________________________
; Provision Dial Plan Selection
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
numan-add:dpsel:custgrpid="1111",newdp="2222"
numan-add:resultset:custgrpid="1111",name="DpSelResultSet1"
numan-add:resulttable:custgrpid="1111",setname="DpSelResultSet1",resulttype="NEW_DIALPLAN"
,name="DpSelResult1",dw1="2222",dw2="2"
numan-add:bdigtree:custgrpid="1111",callside="originating",setname="DpSelResultSet1",digit
string="101"
numan-add:dpsel:custgrpid="1111",newdp="3333"
numan-add:resultset:custgrpid="1111",name="DpSelResultSet2"
numan-add:resulttable:custgrpid="1111",setname="DpSelResultSet2",resulttype="NEW_DIALPLAN"
,name="DpSelResult2",dw1="3333",dw2="2"
numan-add:bdigtree:custgrpid="1111",callside="originating",setname="DpSelResultSet2",digit
string="202”
________________________________________
; Provision an A-number Whitelist Call Screening
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
numan-add:resultset:custgrpid="2222",name="Resultset2222"
numan-add:resulttable:custgrpid="2222",name="WhitelistResult",resulttype="SCREENING",setna
me="Resultset2222",dw1="1",dw3="1111",dw4="1111"
numan-add:adigtree:custgrpid="2222",callside="originating",setname="Resultset2222",digitst
ring="301648"
numan-add:awhite:custgrpid="2222",cli="3016484444"
________________________________________
; Provision a B-number Blacklist Call Screening
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
numan-add:service:custgrpid="3333",name="Washington"
numan-add:resultset:custgrpid="3333",name="Resultset3333"
numan-add:resulttable:custgrpid="3333",name="BlacklistResult",resulttype="SCREENING",setna
me="Resultset3333",dw1="1",dw2="Washington",dw3="1111",dw4="1111"
numan-add:bdigtree:custgrpid="3333",callside="originating",setname="Resultset3333",digitst
ring="703483"
numan-add:bblack:custgrpid="3333",svnname="Washington",cli="3016484444"
________________________________________
; Provision Digit Modification
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
numan-add:digmodstring:custgrpid="2222",name="DigitMod1",digstring="86"
numan-add:resulttable:custgrpid="2222",name="AddDigitResult",resulttype="BMODDIG",setname=
"Resultset2222",dw1="1",dw2="0",dw3="DigitMod1"
numan-add:digmodstring:custgrpid="3333",name="DigitMod1",digstring="70"
numan-add:resulttable:custgrpid="3333",name="RemoveDigitResult",resulttype="BMODDIG",setna
me="Resultset3333",dw1="1",dw2="2",dw3="DigitMod1"
numan-add:resultset:custgrpid="2222",name="RouteResultSet"
numan-add:resulttable:custgrpid="2222",name="RouteResult",resulttype="ROUTE",setname="Rout
eResultSet",dw1="rtlist111stim"
numan-add:resulttable:custgrpid="3333",name="RouteResult",resulttype="ROUTE",setname="Resu
ltset3333",dw1="rtlist222stim"
________________________________________
; Provision Time of Day Routing
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-add:condRteDesc:name="Cond1",rtlistname="ISPrtelst",ovrFlwSet="on"
prov-ed:condRteDesc:name="Cond1",rtlistname="PBXrtelst",startTime="0900",endTime="1400"
prov-ed:condRteDesc:name="Cond1",rtlistname="PGW2rtelst",startTime="1400",endTime="2200"
prov-ed:condRteDesc:name="Cond1",rtlistname="SIPrtelst",startTime="2200",endTime="0000"
prov-add:condRteDesc:name="Cond2",rtlistname="PGW3rtelst",ovrFlwSet="on"
prov-ed:condRteDesc:name="Cond2",rtlistname="PBXrtelst",startTime="0500",endTime="1200"
prov-ed:condRteDesc:name="Cond2",rtlistname="SIPrtelst",startTime="1200",endTime="1900"
prov-ed:condRteDesc:name="Cond2",rtlistname="PGW2rtelst",startTime="1900",endTime="0000"
prov-add:condRte:name="ConRte1",dow="Default",condRteDesc="Cond1"
prov-ed:condRte:name="ConRte1",dow="Monday",condRteDesc="Cond2"
prov-ed:condRte:name="ConRte1",dow="Tuesday",condRteDesc="Cond1"
prov-ed:condRte:name="ConRte1",dow="Wednesday",condRteDesc="Cond2"
prov-ed:condRte:name="ConRte1",dow="Thursday",condRteDesc="Cond1"
prov-ed:condRte:name="ConRte1",dow="Friday",condRteDesc="Cond2"
prov-ed:condRte:name="ConRte1",dow="Saturday",condRteDesc="Cond1"
prov-ed:condRte:name="ConRte1",dow="Hol2",condRteDesc="Cond1"
________________________________________
; Provision Percentage Routing
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-add:percRte:name="one",rtlistname="ISPrtelst",ovrFlwSet="on"
prov-ed:percRte:name="one",rtlistname="PBXrtelst",load=25
prov-ed:percRte:name="one",rtlistname="PSTNrtelst",load=50
prov-add:percRte:name="two",rtlistname="HSI1rtelst",ovrFlwSet="on"
prov-ed:percRte:name="two",rtlistname="PSTNrtelst",load=25
prov-ed:percRte:name="two",rtlistname="PBXrtelst",load=25
prov-ed:percRte:name="two",rtlistname="PGW3rtelst",load=25
prov-ed:percRte:name="two",rtlistname="SIPrtelst",overflow="on"
________________________________________
; Provision Local Number Portability (LNP)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-add:ss7subsys:name="Ss7ss-lnp",desc="SS7 Subsystem for LNP",svc="stp-1",
proto="SS7-ANSI",pri=1,localssn=123,stpscpind=1,transproto="SCCP",opc="opc-pgw",remotessn=
123
nuam-add:resultset:custgrpid=”1111”,name="Resultset1111"
numan-add:resulttable:custgrpid="1111",name="LNPdip",resulttype="IN_TRIGGER",setname="Resu
ltset1111",dw1="2",dw2="1"
numan-add:bdigtree:custgrpid="1111",callside="originating",setname="Resultset1111",digitst
ring="5551234"
________________________________________
; Provision Call Retry
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
nuam-add:resultset:custgrpid="1111",name="CallRetry"
numan-add:resulttable:custgrpid="1111",name="CallRetryResult",resulttype="RETRY_ACTION",se
tname="CallRetry",dw1="1"
numan-add:cause:custgrpid="1111",causevalue="34",setname="CallRetry"
________________________________________
; Provision an Announcement
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
numan-add:resulttable:custgrpid="1111",name="Announcement",resulttype="ANNOUNCEMENT",setna
me="CallRetry",dw1="1234",dw2="1",dw3="rtlist111stim",dw4="2"
________________________________________
; Provision Call Limiting
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-add:loclabel:name="LOCLABEL-1",desc="Call Limiting",calllimit=3000
numan-add:resultset:custgrpid="1111",name="CallLimitingSet"
numan-add:resulttable:custgrpid="1111",name="CallLimitingRes",resulttype="loc_label",
dw1="LOCLABEL",setname="CallLimitingSet"
numan-add:adigtree:custgrpid="1111",callside="originating",digitstring="303",setname="Call
LimitingSet"
________________________________________
; Choose the Deployment Action (Send Configuration to MGC Only)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-stp
This chapter describes how to provision dial plans using Man-Machine Language (MML) commands.
The procedures described in this chapter allow you to create, add, modify, and delete dial plan
components. It also describes how to verify the actions taken with dial plan components and gives tips
that can help you solve dial plan provisioning problems.
The Cisco PGW 2200 Softswitch uses information from the dial plans to perform number analysis and
call processing.
This chapter includes the following sections:
• Adding a Dial Plan, page 4-7
• Migrating Dial Plans Dealing with SCREENING Entries, page 4-12
• Adding Dial Plan Components, page 4-13
• Provisioning Overdecadic Status, page 4-31
• Provisioning Advice of Charge, page 4-31
• Combined Charge and Meter Pulse Messaging Provisioning, page 4-46
• Provisioning Percentage Based Routing, page 4-47
• Provisioning Conditional Routing, page 4-49
• Provisioning Calling Party Category, page 4-51
• Provisioning Bearer Capability Based Routing, page 4-53
• Provisioning the Announcement, page 4-53
• Provisioning an ATM Profile, page 4-54
• Provisioning Tech Prefix Capabilities, page 4-55
• Provisioning Advanced Screening Capabilities, page 4-55
• Provisioning Results of Various Result Types, page 4-58
• Provisioning Examples for Various Result Types, page 4-61
• Importing Dial Plan Information, page 4-62
• Provisioning Call Limiting, page 4-65
• Scaling Dial Plan Elements, page 4-67
• Provisioning Call Reporting, page 4-68
• Provisioning Calling Name Delivery, page 4-68
Note The order in which you provision dial plan tables is important. Many tables refer to other tables
that must be defined first.
MML MML
Component Name Parameter Names Description
DIALPLAN Selects the customer-created dial plan.
OVERDEC Indicates the overdecadic status only when adding a dial
plan.
MML MML
Component Name Parameter Names Description
ADIGTREE Selects the A-digit tree table.
SETNAME MML name of the result set.
DIGITTOPRESENT Indicates the number of digits to skip (forward
or backward) during analysis, if not set to 0.
CALLSIDE Indicates if the call side is originating or terminating.
DIGITSTRING All the digits in a calling number or called number.
Cannot use with NEXTNODE, DIGIT, or INDEX.
BDIGTREE Selects the B-digit tree table.
SETNAME MML name of the result set.
DIGITTOPRESENT Indicates the number of digits to skip (forward
or backward) during analysis, if not set to 0.
CALLSIDE Indicates if the call side is originating or terminating.
DIGITSTRING All the digits in a calling number or called number.
Cannot use with NEXTNODE, DIGIT, or INDEX.
RESULTTABLE Selects the Result table.
NAME MML name of the result.
RESULTTYPE Indicates the type of result.
DW1 First data word.
DW2 Second data word.
DW3 Third data word.
DW4 Fourth data word.
NEXTRESULT Next result name.
SETNAME MML name of the result set.
DIGMODSTRING Selects Digit String Modification table.
NAME MML name of the digit modification string.
DIGSTRING The digit string.
ANOA Selects calling number Nature of Address (NOA) table.
NOAVALUE The NOA value.
NPIBLOCK The NPI block value.
SETNAME MML name of the result set.
ANPI Selects calling number Numbering Plan Indicator (NPI)
table.
NPIBLOCK The NPI block.
BLOCKVALUE The NPI block value.
SETNAME MML name of the result set.
MML MML
Component Name Parameter Names Description
BNOA Selects called number NOA table.
NOAVALUE The NOA value.
NPIBLOCK The NPI block value.
SETNAME MML name of the result set.
BNPI Selects called number NPI table.
NPIBLOCK The NPI block.
BLOCKVALUE The NPI block value.
SETNAME MML name of the result set.
CAUSE Selects the Cause table.
CAUSEVALUE The cause value.
LOCATIONBLOCK The cause location block.
SETNAME MML name of the result set.
LOCATION Selects the Location table.
LOCATIONBLOCK The location block.
SETNAME MML name of the result set.
BLOCKVALUE The location block value.
SERVICE Selects the Service table.
NAME MML name of the service.
RESULTSET Selects the result set in the Result Set table.
NAME MML name of the result set.
AWHITE Selects the A-digit tree white list.
CLI Sets calling line identity (CLI) for A-digit tree white list.
ABLACK Selects the A-digit tree black list.
CLI Sets the CLI for the A-digit tree black list.
BWHITE Selects the B-digit tree white list.
CLI Sets the CLI for the B-digit tree white list.
SVCNAME MML name of the previously defined service.
BBLACK Selects the B-digit tree black list.
CLI Sets the CLI for B-digit tree black list.
SVCNAME MML name of the previously defined service.
PORTTBL Selects the Ported Number table.
DIGITSTRING The called number.
ROUTENUMBER The routing number.
MML MML
Component Name Parameter Names Description
TERMTBL Selects the Number Termination table.
DIGITSTRING The called number.
ROUTELISTNAME The route list name.
ACHORIGIN Selects the A-number charge origin.
CUSTGRPID The customer group ID.
CLI Sets calling line identity (CLI) for A-digit tree white list.
CORIGIN The call origin.
DEFRESULTSET Selects the default result set.
RESULTTYPE Indicates the type of result.
DW1 First data word.
DW2 Second data word.
DW3 Third data word.
DW4 Fourth data word.
DPSEL Selects the dial plan.
NEWDP The new dial plan ID.
ANUMDPSEL Selects the A-number dial plan.
CLI The calling party number.
RTEHOLIDAY Selects the route holiday.
DATE The holiday date.
HDAY The holiday day.
CPC Selects the calling party category.
CPCVALUE The CPC value.
SETNAME MML name of the result set.
TMR Selects the transmission medium requirement.
TMRVALUE The TMR value.
SETNAME MML name of the result set.
TNS Selects the transit network selection.
TNSVALUE The TNS value.
SETNAME MML name of the result set.
CLIPREFIX Selects the CLI prefix.
CLISETNAME The CLI prefix set name.
CLIPREFIX The CLI prefix.
CUSTGRPID The Customer group ID.
MML MML
Component Name Parameter Names Description
CLIIPADDRESS Selects the CLIP address.
CUSTGRPID The Customer group ID.
IPADDR The IP Address.
SUBNETMASK The Subnet mask.
CLISETNAME The CLI prefix set name.
H323IDDIVFROM Selects the H323 ID, Division header, or From field.
CUSTGRPID The Customer group ID.
H323IDDIVFROM H323 ID, Division header, or From field.
CLISETNAME The CLI prefix set name.
• To add, modify, or delete the contents of a dial plan table, an active provisioning session is required.
• An open provisioning session is not needed to access the AWHITE, ABLACK, BWHITE, BBLACK,
PORTBL, TERMTBL, ANUMDPSEL, ACHGORIGIN, CLIPREFIX, CLIIPADDRESS,
H323IDDIVFROM, ANNOUNCEMENT, and SCRIPT tables.
• When performing a deploy or copy, dial plan files from the provisioning directory are copied to the
active directory. The active directory for dial plan files is /opt/CiscoMGC/dialPlan.
• All TIDs, with the exception of DIALPLAN, require a customer group ID and a name. The
DIALPLAN requires only a customer group ID.
• The DIALPLAN cannot be edited.
• The DIALPLAN can be retrieved to determine all of the dial plans currently configured.
• Provision the routes and the digit modification string table before result and digit tree tables.
• When an index is added to a table, the missing indexes are also added with default values. For
example, if index 10 is added to the A-digit tree table, and indexes 4 through 9 are missing, they are
added with default values.
• When an index is deleted from a result or digit tree table, all the elements in the index are zeroed.
When an index is deleted from routes or the digit modification string table, all the elements in the
index are made 'x'. When an index is deleted from any table and if there are no indexes with
non-default values following this index, all the indexes following this index are deleted.
• The modify command is not supported for result sets, since modifications are performed at the result
table level.
• The modify command is not supported for the service table.
• When an entry is added to the result table, the corresponding entry is added to the result set table.
• When an entry is deleted from the result set table, the corresponding entries are deleted from the
result table.
• Index is no longer required to perform any operations on the result table, service table, or digit
modification table.
• The result set cannot be modified for a result table.
• The TIDs adigtree and bdigtree allow retrieving all entries in the table by either not specifying a
digitstring or by specifying an empty digitstring. For example:
numan-rtrv:adigtree:custgrpid="T001",digitstring=""
• Configuring a result set as the default result set replaces the previous result set.
• The default result set can have only one of the following result types: BLACKLIST, ROUTE, or
CAUSE.
Caution Consider using dial plan text files for initial provisioning only. When you pass a dial plan text file to
MML, all existing dial plan data is replaced by the data in the text file. When provisioning a large dial
plan, break the dial plan into smaller pieces rather than loading the entire dial plan as a single batch file.
Validation of the dial plan requires a fairly large amount of swap space.
This command adds the dial plan component and the required custgrpid parameter.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
To add any component to a dial plan, you also use the NUMAN-ADD command. For example, to add a
route component to the dial plan results, you would complete the following steps:
This command adds a ROUTE result type with the name “resultone” to the dial plan results.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the route component you added to the dial plan is present.
Step 3 Repeat steps 1 and 2 for each route component you want to add to the dial plan.
This command deletes the resultset component “setone” from the dial plan.
Caution As a convenience, for the adigtree and the bdigtree components, the “NUMAN-DLT” command allows
you to delete all of the numbers starting with a digit string. Here is an example command:
numan-dlt:bdigtree:custgrpid="t001",callside="originating",digitstring="starting digits"
Here are two options for the numan-dlt:bdigtree commands. The numan-dlt:adigtree command has
similar usage.
• Delete all of the numbers starting with a specified digit string from the B digit tree.
numan-dlt:bdigtree:custgrpid="t001",callside="originating",digitstring="404"
or
numan-dlt:bdigtree:custgrpid="t001",callside="originating",digitstring="404",
partial="NO"
These two MML command examples delete all of the numbers starting with a "404" digit string from
the B digit tree within the dial plan t001, including the number 404.
• Delete only the specified number from the B digit tree
numan-dlt:bdigtree:custgrpid="t001",callside="originating",digitstring="404",
partial="YES"
This MML command example deletes only the number 404 from the B digit tree within the dial plan
t001.
Note For the numan-dlt:adigtree and the numan-dlt:bdigtree commands, use the partial parameter
carefully. Setting the partial parameter value to “YES” deletes only the specified number from
the digit tree. Setting the partial parameter value to “NO” deletes all of the numbers starting with
a specified digit string from a digit tree. The default value for the partial parameter is “NO”.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Deleting the B-digit Tree with 4 and Not Deleting 444 and 445
You can use the following MML command, with the partial parameter enabled, to delete only the
specified B-digit tree entry.
mml>
numan-dlt:bdigtree:custgrpid="dp1",callside="originating",digitstring="4",partial="yes"
MGC-02 - Media Gateway Controller 2005-01-26 09:34:27.832 EST
M COMPLD
"bdigtree"
;
Deleting the 444 and 445 B-digit Trees and Not Deleting 4
You can use either of the following MML commands, with or without the partial parameter enabled, to
delete all the B-digit tree entries that contain 44.
mml> numan-dlt:bdigtree:custgrpid="dp1",callside="originating",digitstring="44"
MGC-02 - Media Gateway Controller 2005-01-26 09:49:06.330 EST
M COMPLD
"bdigtree:WARNING: All partial matching digit tree are removed"
;
or
mml>
numan-dlt:bdigtree:custgrpid="dp1",callside="originating",digitstring="44",partial="no"
MGC-02 - Media Gateway Controller 2005-01-26 09:49:06.330 EST
M COMPLD
"bdigtree:WARNING: All partial matching digit tree are removed"
;
Step 2 Verify the dial plan has been deleted by entering the command:
mml> numan-rtrv:dialplan:custgrpid="T001"
This command changes the setname to “settwo” in the NPI value in the dial plan.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the setname component you changed now reads “settwo” as changed.
Step 3 Repeat steps 1 and 2 for each setname component you want to change in the dial plan.
Note If contentonly is set to “false” (the default), all dependencies must be eliminated before the dial
plan can be deleted.
This command retrieves an element from the Bdigtree in the dial plan.
To verify the command was executed successfully, observe that information for the component(s)
changed in the command is returned in the response. Repeat the command as necessary.
Note If you have dial plans T001 and T002 using T001.bwhite and T002.bwhite screening, after prov-export
you will have 2 files, T001.Bwhite and T002.Bwhite.
Step 5 Modify the screening type dw1 to “dw3” for one resulttable in T001 dial plan.
Step 6 Make a test call from a test phone with the CLI listed in GLBL.bwhite.
Step 7 Modify the screening type dw1 to “dw3” for one resulttable in T002 dial plan.
Step 8 Make a test call from a test phone with the CLI listed in GLBL.bwhite.
Step 9 Modify all screening type dw1 to “3” for both T001 and T002 dial plan as follows:
Edit both T001.bwhite and T002.bwhite:
vi T001.bwhite or vi T002.bwhite
:1,$s/1 /2 /g to replace all 1s in the first column to 2s
Step 11 Import both T001.bwhite and T002.bwhite back and verify they are empty afterward by using the
following MML commands:
prov-add:files:name=”bwhitefile”,file=”T001.bwhite”,action=”import”
prov-add:files:name=”bwhitefile”,file=”T002.bwhite”,action=”import”
numan-rtrv:bwhite:custgrpid="T001",cli="x"
numan-rtrv:bwhite:custgrpid="T002",cli="x"
Step 12 Make a test call from a test phone with the CLI listed in GLBL.bwhite.
Caution Configuration of the Cisco PGW 2200 Softswitch software requires that the system software be shut
down. In a simplex system, calls cannot be processed during system shut down. In a continuous service
system, your system loses the ability to maintain calls during a critical event while the system software
on one of the Cisco PGW 2200 Softswitch hosts is shut down.
To create the carrier selection list and add Carrier IDs, complete the following steps:
where,
• CARRIERID is a unique 2-digit through 5-digit number (enclosed in straight quotes) to identify the
selected carrier. Leading zeros are significant. For example, 022 is not the same as 22.
• RTOPTION identifies the selected route option:
1 = Route on called number (default)
2 = Blocked
3 = Route on Carrier ID
• RTLISTNAME is a unique route list name for this routing trunk group number. You can enter as
many as 20 alphanumeric characters enclosed in straight quotes. Hyphens (-) can be used; however,
a specific value is not allowed unless the RTOPTION parameter is set to “CARRIER” (as shown).
This command adds a single row and a single Carrier ID to the Carrier Selection list.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify a new row has been added to the Carrier Selection list.
Step 3 Repeat steps 1 and 2, as necessary, to add new rows and new Carrier IDs to the Carrier Selection list.
This command adds the digit string “1045” to the DIGMODSTRING list in the dial plan.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the DIGMODSTRING list and the digit string you entered are now present.
Step 3 Repeat steps 1 and 2 for each digit string you want to add to the DIGMODSTRING list.
Tip An implied index, which contains a single string of digits to be applied to the calling number or called
number, is used to access the DIGMODSTRING list.
This command adds a service with the service name “TollLine” to the dial plan.
Note Service names are limited to 10 alphanumeric characters. Spaces are not allowed in service
names.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the service with the service name that you entered is present.
Step 3 Repeat steps 1 and 2 for each service name you want to add to the service list.
Tip The service list acts with the results to provide service names.
This command adds a RESULTTABLE and a result set with a result type of “SCREENING,” dataword1
value of “1,” dataword2 value of “Herndon,” a name of “resultone,” and a result set name of “setone.”
Step 2 At the MML prompt, enter the command:
mml> numan-add:resulttable:custgrpid="t001",resulttype="ANNOUNCEMENT",dw1="100",dw2="1",
dw3="rtlist1",name="resulttwo",setname="settwo"
This command adds another result set to the RESULTTABLE with a result type of
“ANNOUNCEMENT,” dataword1 value of “100,” dataword2 value of “1,” dataword3 value of “rtlist1,”
a name of “resulttwo,” and a result set name of “settwo.”
This command adds a third result set to the RESULTTABLE with a result type of “IN_TRIGGER,”
dataword1 value of “1,” dataword2 value of “1,” dataword3 value of “rtlist1,” a name of “resultthree,”
and a result set name of “setthree.”
Step 4 At the MML prompt, enter the command:
mml> numan-add:resulttable:custgrpid="t001",resulttype="CPCMOD",dw1="payphone",
name="resultfour",setname="setfour"
This command adds a fourth result set to the RESULTTABLE with a result type of “CPCMOD,”
dataword1 value of “payphone,” a name of “resultfour,” and a setname of “setfour.”
Step 5 To verify these four commands were executed successfully, enter the command:
mml> numan-rtrv
Verify the RESULTTABLE you created is present with all four result sets described above.
Step 6 Repeat step 1 and step 5 for each result set you want to add to the RESULTTABLE.
Verify the RETRY_ACTION and the parameters you specified are now present in the Results.
Step 3 Repeat steps 1 and 2 for each RETRY_ACTION entry you add to the results.
Note For multiple RETRY_ACTION results, only the last retry action specified is applied.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the MGCPDIALPKG and the parameters you specified are now present in the result table.
Step 3 Repeat steps 1 and 2 for each MGCPDIALPKG entry you add to the result table.
Step 1 Log in to the active Cisco MGC, start an MML session, and enter the following command to add a dial
plan:
mml> numan-add:dialplan:custgrpid="dpl1",overdec="yes"
Step 4 Now add the BCMOD result type to a result set and define the result set in the result table:
mml> numan-add:resulttable:custgrpid="dp11",resulttype="BCMOD",dw1="bc-04",setname="set1",
name="bc1"
Step 5 Repeat Step 4, as necessary, to add new rows to the bearer capability table.
Step 1 Log in to the active Cisco MGC, start an MML session, and enter the following command to add a dial
plan:
mml> numan-add:dialplan:custgrpid="dpl2",overdec="yes"
Step 3 Enter the following command to add the HLC table entry:
mml> numan-add:HLC:cusgrpid="dpl1",name="hlc-04",ocval="9184"
Step 4 Now add the HLCMOD result type to a result set and define the result set in the result table:
mml> numan-add:resulttable:custgrpid="dp12",resulttype="HLCMOD",dw1="hlc-04",
setname="set3",name="result03"
Step 5 Repeat Step 4, as necessary, to add HLCMOD result types to the result table.
This command adds an ADIGITTREE and the required parameters to the dial plan.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the ADIGITTREE and the parameters you added are now present in the dial plan.
Step 3 Repeat steps 1 and 2 for each entry you add to the ADIGITTREE.
This command adds a BDIGITTREE and the required parameters to the dial plan.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the BDIGITTREE and the parameters you added are now present in the dial plan.
Step 3 Repeat steps 1 and 2 for each entry you add to the ADIGITTREE.
Note In MGC software Release 9.4(1), another NPI table (NPIcg) was added to allow analysis of A-numbers.
As a result, the MML command changed from npi to anpi and bnpi.
A separate NPI block is required for every non-zero entry in the NPI Block column of the NOA
(Example 4-1) that you want to associate with a result set. To add an NPI value to the dial plan, complete
the following steps:
This command adds an NPI with a CustGrpID of “t001,” an NPI block of 1, a received NPI block value
of 108, and a result set name of “set1.” to the dial plan.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify that the NPI value and the parameters you added are now present as shown in Example 4-1.
Step 3 Repeat steps 1 and 2 for each npiblock value and setname you want to add to the NPI.
Note In MGC software Release 9.4(1), another NOA table (NOAcg) was added to allow analysis of
A-numbers. As a result, the MML command changed from noa to anoa and bnoa.
To add a NOA value to the dial plan, complete the following steps:
This command adds a NOA value and the required parameters to the dial plan. For any NOA value that
is configured, either an NPI block or a result set must be specified. This MML command example
specifies that for an incoming NOA value of 3, pre-analysis enters NPI block 1 using the incoming NPI
value.
Step 2 At the MML prompt, enter the command:
mml> numan-add:anoa:custgrpid="t001",noavalue=4,setname="set3"
This MML command specifies that for an incoming NOA value of 4, result set “set3” is used.
Step 3 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the NOA value and the parameters you added are now present.
Step 4 Repeat steps 1 through 3 for each noavalue you want to add to the dial plan.
Adding a LINEXLATE Table to the Dial Plan for Configurable NOA Mapping
To support the Configurable NOA Mapping feature (introduced in Release 9.4.1), you must provision a
line translation (LINEXLATE) table in your dial plan.
See the Cisco PGW 2200 Softswitch Release 9.8 Provisioning Guide for the procedures to provision the
Configurable NOA Mapping feature on the Cisco PGW 2200 Softswitch. See the Cisco PGW 2200
Softswitch Release 9 MML Command Reference for a detailed description of the command for creating
a LINEXLATE table.
Step 2 Provision the Cisco MGC for a line NOA value to the dial plan of incoming calls trunk group, using the
following MML command:
mml>numan-add:noa:custgrpid=”1111”,noavalue=4,setname=”rset1”
Step 3 Provision the Cisco MGC for a line NOA value to the dial plan of outgoing calls trunk group, using the
following MML command:
mml>numan-add:noa:custgrpid=”1111”,noavalue=14,setname=”rset2”
Verify that the line NOA value translation has occurred correctly. For example, line value 4, added at the
incoming trunk group, is converted to an internal NOA value 14 at the outgoing trunk group and is
received at the PSTN side.
Verify a line NOA value translation for Calling, Called Party, and Redirection Number parameters for
Type B calls.
This command adds the LOCATION and sets up the Location with a CustGrpID of t001, a locationblock
of 1, a block value of 8, and a result set name of “set8”.
Note The blockvalue in numan-add:location should be one less than the intended internal value.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the LOCATION and the parameters you added are now present.
Step 3 Repeat steps 1 and 2 for each LOCATION entry you want to add to the dial plan.
This command sets up the Cause with a CustGrpId of t001, a cause value of 3, and a result set name of
“set3”.
or
mml> numan-add:cause:custgrpid="t001",causevalue=4,locationblock=1
This command sets up the Cause with a CustGrpId of t001, a cause value of 4, and a location block of
1. The location block cannot be empty when you use this command. See the “Adding a Location
(LOCATION)” section on page 4-22 for information on adding locations.
Note A cause value must be added to the dial plan before it can be edited. Table B-2, Internal Cause
Code Values, Listed Numerically, lists the internal cause code values.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the CAUSE and the parameters you added are now present.
Step 3 Repeat steps 1 and 2 for each CAUSE entry you want to add to the dial plan.
Note When provisioning CAUSE in the dial plan, you can use either locationblock or setname, but not both.
If you use setname, set the locationblock=0. If you use locationblock, set the setname=“”. However,
setting the unused property (locationblock or setname) means it is unused.
Tip If you want to change the CAUSE property from locationblock to setname, or from setname to
locationblock, use the numan-ed command to set the property not desired to its unused condition, then
use the numan-ed command to set the value for the desired property.
• B White—call screening stimulated by either partial or full called number and full calling number
must be present in the list to complete the call.
• B Black—call screening stimulated by either partial or full called number and full calling number
must not be present in the list to complete the call.
The following sections describe the file format for AWhite and ABlack screening files.
Note The service name entered here associates the calling party number with a specific service.
A calling party number can be associated with as many different services as necessary.
Service names are limited to 10 alphanumeric characters. Spaces are not allowed.
A provisioning session is not needed for individual MML commands; nor does a provisioning session
need to be opened when you are using the screening file import procedure described above.
The format of the MML command to add individual entries to the A-number whitelist or blacklist
screening files without opening a provisioning session is as follows:
mml> numan-add:<custgrpid.awhite|custgrpid.ablack>:cli=<cli>
The format of the MML command to add individual entries to the B-number whitelist or blacklist
screening files without opening a provisioning session is as follows:
mml> numan-add:<custgrpid.bwhite|custgrpid.bblack>:cli=”<cli>”,service=”<svcname>”
The following file types do not require a provisioning session be open if using the prov-add command
to load the following tables: AWHITE, ABLACK, BWHITE, BBLACK, PORTBL, TERMTBL,
ANUMDPSEL, ACHGORIGIN, CLIPREFIX, CLIIPADDRESS, H323IDDIVFROM,
ANNOUNCEMENT, and SCRIPT.
This command adds an AWHITE list and the required parameters to the dial plan.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the AWHITE list and the parameters you added are now present.
Step 3 Repeat steps 1 and 2 for each AWHITE list entry you want to add to the dial plan.
This command adds an ABLACK list entry and the required parameters to the dial plan.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the ABLACK list entry and the parameters you added are now present.
Step 3 Repeat steps 1 and 2 for each ABLACK list entry you want to add to the dial plan.
This command adds a BWHITE list entry and the required parameters to the dial plan.
Note Service names are limited to 10 alphanumeric characters. Spaces are not allowed in service
names.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the BWHITE list entry and the parameters you added are now present.
Step 3 Repeat steps 1 and 2 for each BWHITE list entry you want to add to the dial plan.
This command adds a BBLACK list entry and the required parameters to the dial plan.
Note Service names are limited to 10 alphanumeric characters. Spaces are not allowed in service
names.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the BBLACK list entry and the parameters you added are now present.
Step 3 Repeat steps 1 and 2 for each BBLACK list entry you want to add to the dial plan.
This command adds an entry to the PORTTBL list and the required parameters to your dial plan.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the parameters you added are now present in the PORTTBL list.
Step 3 Repeat steps 1 and 2 for each PORTTBL list entry you want to add to your dial plan.
This command adds an entry to the TERMTBL list and the required parameters to your dial plan.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the parameters you added are present in the TERMTBL list.
Step 3 Repeat steps 1 and 2 for each TERMTBL list entry you want to add to your dial plan.
This command inserts the dial plan ID “dp07” into a new dial plan selection list.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the dial plan selection list and the new dial plan ID you added are now present.
Step 3 Repeat steps 1 and 2 for each dial plan ID you want to insert in the dial plan selection list.
This MML command inserts the A-number dial plan dp07 into the dial plan selection list.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the A-number dial plan selection list and the new dial plan ID you changed are now present.
Step 3 Repeat steps 1 and 2 for each A-number you want to insert in the A-number dial plan selection list.
mml> prov-add:trnkgrpprop:name="3333",custgrpid="1111",GWDefaultCodecString="G.711a;PCMA"
mml> prov-add:sigsvcprop:name="mgcp1",GWDefaultCodecString="G.711a;PCMA"
Edit a day entry in the Holiday list in an already existing entry in the list:
NUMAN-ED:RTEHOLIDAY:CUSTGRPID="T002",DATE="2001.08.12",HDAY=HOL1
Conditional Routing Processing actions derived from the above MML commands:
The conditional routing will use the hol1 day of the week for Christmas day and New Years day. For
Independence Day the conditional routing will use the hol2 day of the week. And for Labor Day the
conditional routing will use the hol3 day of the week.
Add a conditional route:
PROV-ADD:CONDRTE:NAME="condName20",DOW="DEFAULT",RTEDESC="set22"
PROV-ED:CONDRTE:NAME="condName20",DOW="MONDAY",RTEDESC="set21 0800 set22 1800 set 24"
PROV-ED:CONDRTE:NAME="condName20",DOW="TUESDAY",RTEDESC="set21 0800 set22 1800 set 24"
PROV-ED:CONDRTE:NAME="condName20",DOW="WEDNESDAY",RTEDESC="set21 0800 set22 1800 set24"
PROV-ED:CONDRTE:NAME="condName20",DOW="HOL1",RTEDESC="set23"
PROV-ED:CONDRTE:NAME="condName20",DOW="HOL2",RTEDESC="set22"
PROV-ED:CONDRTE:NAME="condName20",DOW="HOL3",RTEDESC="set22 1200 set55 1800 set22"
The following MML command shows how to configure the COND_ROUTE results making the
association with the data in the Conditional Routing list previously defined.
NUMAN-ADD:RESULTTABLE:CUSTGRPID="T002",NAME="result39",RESULTTYPE="COND_ROUTE",DW1="
condName20",SETNAME="condsetName"
Conditional Routing Processing actions derived from the preceding MML commands:
On Monday, Tuesday, and Wednesday:
From 0000-0800, the Routing option is result set “set21” which provides RouteList21 as the entry point
into Routing analysis.
From 0801-1800, the Routing option is result set “set22” which provides Routelist22 as the entry point
for Routing analysis.
From 1801-2359, the Routing option is result set “set24” which provides RouteList24 as the entry point
into Routing analysis.
On a Holiday of type “HOL1”
From 0000-2359, the Routing option is “set23” which provides RouteList23 as the entry point into
Routing analysis.
On a Holiday of type “HOL2”
From 0000-2359, the Routing option is “set22” which provides RouteList22 as the entry point into
Routing analysis.
On a Holiday of type “HOL3”
From 0000-1200, the Routing option is result set “set22” which provides RouteList22 as the entry point
into Routing analysis.
From 1201-1800, the Routing option is result set “set55” which provides Routelist55 as the entry point
for Routing analysis.
From 1801-235, 9 the Routing option is result set “set22” which provides RouteList22 as the entry point
into Routing analysis.
On a Default case
This means the Routing for any undefined Days in this case Thursday, Friday, Saturday, and Sunday.
From 0000 - 0800, the Routing option is result set “set22” which provides Routelist22 as the entry point
for Routing analysis.
From 0801-2359, the Routing option is result set “set55” which provides Routelist55 as the entry point
for Routing analysis.
This command inserts the dpbase into a dial plan containing a value of either YES or NO.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the dpbase and the overdecadic selection you added are now present.
Step 3 Repeat steps 1 and 2 for each dial plan you want to insert a dpbase to specify the overdecadic status of
the dial plan.
Note To avoid alarms being generated because of inconsistent data for calls in progress while charging
data is being added or modified:
provision the Charge and Holiday tables before making changes to the dial plan that references
them.
disable meter pulse messaging and AOC (by setting AOCEnabled to 0, disables AOC for the call)
for all the trunk groups or sigpaths that use the dial plan that references the data to be changed
until all updates have been completed.
This MML command inserts a holiday date into the Charge Holiday list and designates it as a “hol1,”
“hol2,” or “hol3.”.
Step 2 To verify the command was executed successfully, enter the command:
mml> prov-rtrv
Verify the Charge Holiday list and the new holiday date you changed are now present.
Step 3 Repeat steps 1 and 2 for each holiday you want to insert in the Charge Holiday list.
This command changes the holiday date (2001.12.25) from “hol1” to a “hol2.”
Step 2 To verify the command was executed successfully, enter the command:
mml> prov-rtrv
Step 3 Repeat steps 1 and 2 for any holiday you want to change in the Charge Holiday list.
This command deletes the existing holiday date (2001.12.31) from the Charge Holiday list.
Step 2 To verify the command was executed successfully, enter the command:
mml> prov-rtrv
Step 1 To retrieve a single entry from the Charge Holiday list, enter this command at the MML prompt:
mml> prov-rtrv:holiday:date="2001.12.31"
This command retrieves the existing holiday date (2001.12.31) from the Charge Holiday list.
To retrieve all the entries in the Charge Holiday list, enter this command at the MML prompt:
mml> prov-rtrv:holiday:"all"
This command retrieves all existing holiday dates from the Charge Holiday list.
Verify the holiday entry or entries you changed are displayed.
Step 2 Repeat step 1 for any holiday entry you want to retrieve from the Charge Holiday list.
Note When provisioning charge, ensure the charge origin (achorigin) property value matches the charge value
provisioned for charge origin (chorig). Also ensure AOCEnabled is set to “1” (enabled) and AOCNodeId
is provisioned.
Verify the Charge list and the new entry you changed are now present.
Step 3 Repeat steps 1 and 2 for each entry you want to insert in the Charge list.
This command changes the previous entry, “tariff1 timechange1,” to “tariff2 timechange2.”
Step 2 To verify the command was executed successfully, enter the command:
mml> prov-rtrv
This command deletes the existing entry from the Charge list.
Step 2 To verify the command was executed successfully, enter the command:
mml> prov-rtrv
Step 1 To retrieve a single entry from the Charge list, enter this command at the MML prompt:
mml> prov-rtrv:charge:chorig=1000,chdest=1000,dow="monday"
This command retrieves the changed entry from the Charge list.
To retrieve all the entries in the Charge list, enter this command at the MML prompt:
mml> prov-rtrv:charge:"all"
This command retrieves all existing entries from the Charge list.
Verify the entry or entries you changed are displayed.
Step 2 Repeat step 1 for any entry you want to retrieve from the Charge list.
Note When provisioning charge, ensure the charge origin (achorigin) property value matches the charge value
provisioned for charge origin (chorig). Also ensure AOCEnabled is set to “1” (enabled) and AOCNodeId
is provisioned.
The following command specifies all calls from any Charge Origin to Charge Destination 2 will use tariff
id 3 from 0000-0700, tariff id 4 from 0700-1800, tariff 3 from 1800 to 2100, and tariff id 5 from
2100-2400 for HOL1.
mml> prov-add:charge:chdest=3,dow="hol1",tariffdesc="3 0700 4 1800 3 2100 5 2400"
The following MML command specifies all calls from Charge Origin 2 to Charge Destination 2 will use
tariff id 3 all day every day.
mml> prov-add:charge:chorig=2,chdest=2,tariffdesc="3"
Note When provisioning the Charge table, a value must be entered to be used as the default for the next tariff
id. A default value must be provisioned in Charge table so that a next tariff id is always present.
The scale factor range is: 0, 1, 2, 3, 249, 250, 251, 252, 253, 254, or 255
This MML command inserts an entry in the Tariff list.
Step 2 To verify the command was executed successfully, enter the command:
mml> prov-rtrv
Verify the Tariff list and the new entry you changed are now present.
Step 3 Repeat steps 1 and 2 for each entry you want to insert in the Tariff list.
Step 2 To verify the command was executed successfully, enter the command:
mml> prov-rtrv
This command deletes the existing entry from the Tariff list.
Step 2 To verify the command was executed successfully, enter the command:
mml> prov-rtrv
Step 1 To retrieve a single entry from the Tariff list, enter this command at the MML prompt:
mml> prov-rtrv:tariff:tariffid=1010
This command retrieves the specified entry from the Tariff list.
To retrieve all the entries in the Tariff list, enter this command at the MML prompt:
mml> prov-rtrv:tariff:"all"
This command retrieves all existing entries from the Tariff list.
Verify the entry or entries you changed are displayed.
Step 2 Repeat step 1 for any entry you want to retrieve from the Tariff list.
Verify the Charge list and the new entry you changed are now present.
Step 3 Repeat steps 1 and 2 for each entry you want to insert in the Charge Origin list.
This command deletes the existing entry from the Charge Origin list.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Step 1 To retrieve a single entry from the Charge Origin list, enter this command at the MML prompt:
mml> numan-rtrv:achgorigin:custgrpid="t001",cli="02087568000"
This command retrieves the specified entry from the Charge Origin list.
To retrieve all the entries in the Charge Origin list, enter this command at the MML prompt:
mml> numan-rtrv:achgorigin:"all"
This command retrieves all existing entries from the Charge Origin list.
Verify the entry or entries you changed are displayed.
Step 2 Repeat step 1 for any entry you want to retrieve from the Charge Origin list.
Step 1 To import a Charge Origin list, enter this command at the MML prompt:
mml> prov-add:files:name="achgoriginfile",file="achgorigin.dat",action="import"
This command imports the specified file as the Charge Origin list.
Step 2 To verify the command was executed successfully, enter the command:
mml> prov-rtrv
Verify the file you specified in step 1 is displayed as the Charge Origin list.
A-Number Result
The ChargeOrigin result type has been created for AOC. Only the first data word is significant (carries
the charge origin value). This result type is assignable against the ADIGTREE component only and is
treated as an intermediate result (digit analysis can continue past this result type). For example,
mml> numan-add:resultset:custgrpid="t002",name="settwo"
mml> numan-add:resulttable:custgrpid="t002",name=result2",resulttype="chargeorigin",
dw1="1",setname="settwo"
The following MML commands provide an example of provisioning the ACHORIGIN result type:
mml> numan-add:achgorigin:custgrpid="t001",cli="02087568000",corigin=1
Charge Destinations
CHARGE Result Type
The CHARGE result type can return a charging destination for the Metering Pulse Tariff table. This
operation is achieved by setting dataword3 to a value of 5 for the ChargeDataDiscriminator field. The
CHARGE result type is assigned against the BDIGTREE component only and is treated as an
intermediate result. The values of the accompanying data are listed in Table 4.
The following MML commands show how to provision the CHARGE result type:
mml> numan-add:resultset:custgrpid="t001",name="setone"
mml> numan-add:resulttable:custgrpid="t001",name=result1",resulttype="charge",dw1="1",
dw3="2",setname="setone"
Note Charge destination is the only mandatory key. Charge origin and day of the week are set to 0 in the table
row entry if they are not used.
Note If the charge origin is not used, the entered rows refer to all origins for that destination (unless explicitly
entered in another row). Similarly, if the day of the week is not used, day of the week refers to all days
of the week, which are not otherwise explicitly entered.
Note If configured as “ALL CALL” and the Cisco PGW 2200 Softswitch receives the invoke component in
the setup message then the call is treated as “PER CALL.”
Note If configured as “ALL CALL” and for the Charge Destination there is no configuration, the default tariff
is used to set up the charge. If no default exists, then an appropriate result message is sent to the
subscriber.
AOCInvokeType example:
mml> prov-add:trnkgrpprop:name=”3333”,custgrpid=”1111”,AOCInvokeType=1
Note If the time for accumulating one charging unit is less than the configured
AOCMinPeriodicTimerDuration value, then the timer is set to a value greater than the configured value,
and the charging unit that is accumulated is an integer value. For example, if 1 charging unit is
accumulated every 0.692 second and the AOCMinPeriodicTimerDuration is 5 seconds, the value for this
timer is set to 173 seconds, and the number of charging units that are accumulated is 25 on expiry of this
timer, which is then sent to the subscriber or user. Similarly, if 1 charging unit is accumulated every 0.6
second and the AOCMinPeriodicTimerDuration is 5 seconds, the value for this timer is set to 6 seconds,
and the number of charging units that are accumulated is 10 on expiry of this timer, which is then sent
to the subscriber or user.
Note To reduce the number of alarms that are received when you are provisioning AOC (due to charging
information pointing to unpopulated tables), disable AOC on the relevant trunk groups until the charge
table has been correctly updated.
AOCEnabled example:
mml> prov-add:trnkgrpprop:name="2000",aocenabled="1"
When to Provision
Charging data should be defined during installation (after the creation of each customer dial plan). More
charging data can be added at any time.
Use the following suggestions to avoid alarms being generated because of inconsistent data for calls in
progress while charging data is being added or modified:
• Provision the charge and holiday tables before making changes to the dial plan that references them.
Disable PRI AOC supplementary services for all the trunk groups or sigPaths that use the dial plan that
references the data to be changed until all updates have been completed.
In this example:
• calls from charge origin 1 to charge destination 1 use a tariff id of 3 from 000-0700, 4 from
0700-1800 and 3 from 1800 to 2400 from Monday to Friday
• Saturday and Sunday are charged at a fixed rate using tariff id 3
• The 4th July and 1st of May receive a fixed charge with a tariff id of 1 and the 25th of December is
charged using tariff id 2
• All other calls to this charge destination (i.e. charge origin <> 0) are charged at a flat rate using tariff
id 4
Step 4 (Mandatory)—Define Meter Tariff Table Data
mml> PROV-ADD:METERTARIFF:TARIFFID=1,PULSEONANS=5,INTERVAL=10,NUMPULSES=5,
CHARGEAPP=0,AOCIND=0,MAXCALLLEN=100,TARIFFTYPE=0
mml> PROV-ADD:METERTARIFF:TARIFFID=2,PULSEONANS=0,INTERVAL=60,NUMPULSES=1,
CHARGEAPP=0,AOCIND=0,MAXCALLLEN=100,TARIFFTYPE=0
mml> PROV-ADD:METERTARIFF:TARIFFID=3,PULSEONANS=5,INTERVAL=120,NUMPULSES=1,
CHARGEAPP=0,AOCIND=0,MAXCALLLEN=100,TARIFFTYPE=0
To delete just the hol1 entry in the conditional route description descone:
prov-dlt:condrte:name="descone",dow="hol1"
To delete the route list from the conditional route description desctwo:
prov-dlt:condrtedesc:name="desctwo",rtlistname="three"
For example:
prov-add:percrte:name=“one”,rtlistname=“one”,ovrflwset=“ON”,primary=“ON”
This results in 50% traffic to route list name one, 25% traffic to route list name three, and 25% traffic to
time of day name todtwo.
If overflow is supported, it allows reentry to the percentage based routing name to choose another
rtlistname or todname if all of the trunks in the previously selected rtlistname or todname were
unavailable.
To delete the route list three from percentage based route two:
prov-dlt:percrte:name=“two”,rtlistname=“three”
This MML command inserts a holiday date (2001.12.25) into the Route Holiday list and designates it as
a “hol1.”
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Verify the Route Holiday list and the new holiday date you changed are now present.
Step 3 Repeat steps 1 and 2 for each holiday you want to insert in the Route Holiday list.
This command changes the holiday date (2001.12.25) from “hol1” to a “hol2.”
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
This command deletes the existing holiday date (2001.12.31) from the Route Holiday list.
Step 2 To verify the command was executed successfully, enter the command:
mml> numan-rtrv
Step 1 To retrieve a single entry from the Route Holiday list, enter this command at the MML prompt:
mml> numan-rtrv:rteholiday:date="2001.12.31"
This command retrieves the existing holiday date (2001.12.31) from the Route Holiday list.
To retrieve all the entries in the Route Holiday list, enter this command at the MML prompt:
mml> numan-rtrv:rteholiday:"all"
This command retrieves all existing holiday dates from the Route Holiday list.
Verify the holiday entry or entries you changed are displayed.
Step 2 Repeat step 1 for any holiday entry you want to retrieve from the Route Holiday list.
Note The setname property must be configured before adding a TNS value to the TNS list.
You would use the following MML command to provision the preceding ANSI TNS example.
numan-add:tns:custgrpid="test",tnsvalue="123",setname="actiontns"
As can be seen, by the bold text in the following example, the number of the carrier is embedded. The
following TNS example for Q.761; the TNS number is 3333.
'00100011'B -- Octet 39 Transit Network Selection H'23
'00000011'B -- Octet 40 len H'03
'00100011'B -- Octet 41 National, X.121, even H'23
'00110011'B -- Octet 42 Digits 33 H'33
'00110011'B -- Octet 43 Digits 33 H'33
'00000000'B -- Octet 24 End of Optional parameters H'00
You would use the following MML command to provision the preceding Q.761 TNS example.
numan-add:tns:custgrpid="test",tnsvalue="3333",setname="actiontns"
Use the following MML command to generate a data file called announcement.dat along with the file
import command in numan.MML by the following MML command:
mml> prov-exp:numan:dirname="exp1"
After editing, use the following MML command to import this file back into the database:
mml> prov-add:files:name="announcementfile",file="exp1/announcement.dat",action="import"
To add a local announcement result: announceId=123, local, Final_on for playing announcement, use the
following MML command:
mml> numan-add:resulttable:custgrpId="T002",name="result60",resulttype="ANNOUNCEMENT",
dw1="123",dw2="0",dw4="1",setname="set1"
To associate a B-digit number to the result set, use the following MML command:
mml> numan-add:bdigtree:custgrpid="T002",digitstring="7034843375",callside="originating",
setname="set1"
The following example represents the result of the previous MML command in routeAnalysis.dat:
$ATMProfiles
# CiscoMGC: 01
#name ATMProfiles
atmprof1 ITU1;cust100
Before you begin provisioning the advanced screening capabilities, you must have the following
information about your installation:
• H.323 messages coming from different call managers
• Dial plan information (depending on the source IP address of the call manager)
Note The *.SysConnectDataAccess parameter, in XECfgParm.dat, must be set to true (enabling connection to
the MMDB or call screening database) in calling scenarios where European Local Number Portability,
A-number screening, or other features that require real time database access.
Note The calling party number (CgPn) cannot be empty for screening based on the IP address or calling line
identity (CLI).
Step 1 Add a customer group to the Dial Plan table if one has not already been created:
mml> numan-add:dialplan:custgrpid=“Cus1”
Step 3 Define the IP address and the subnet for the customer group:
mml> numan-add:cliipaddress:custgrpid=“Cus1”,ipaddr=“172.22.99.247”,
subnetmask=“255.255.0.0,clisetname=“x”
Note A DEFAULT CLI prefix entry must be configured for each CLI set name
Step 1 Use the following MML commands to add customer groups to the Dial Plan table if they have not already
been created:
mml> numan-add:dialplan:custgrpid=“Cus1”
mml> numan-add:dialplan:custgrpid=“csco”
mml> numan-add:dialplan:custgrpid=“Cus2”
mml> numan-add:dialplan:custgrpid=“Cus3”
Step 2 Use the following MML commands to add CLI prefixes to the customer groups.
mml> numan-add:cliprefix:clisetname=“x”,cliprefix=“408”,custgrpid=“Cus1”
mml> numan-add:cliprefix:clisetname="x",cliprefix="1408260",custgrpid="csco"
mml> numan-add:cliprefix:clisetname="x",cliprefix="140826033",custgrpid="Cus2"
mml> numan-add:cliprefix:clisetname="x",cliprefix="DEFAULT",custgrpid="Cus3"
Provisioning H.323 ID
The h323iddivfrom parameter allows you to associate an H.323 ID with a specific customer group. If an
incoming call matches the H.323 ID parameter, you can apply certain dial plan functions to it.
Step 1 Use the following MML command to add a customer group to Dial Plan table if one has not already been
created:
mml> numan-add:dialplan:custgrpid=“Cus1”
Step 2 Use the following MML command to add an H.323 ID to a customer group.
mml> numan-add:h323iddivfrom:custgrpid=“Cus1”,h323iddivfrom=“4eaf005”,clisetname=“x”
Editing H.323 ID
Use the following MML command to edit an H.323 ID in a customer group:
mml> numan-ed:h323iddivfrom:custgrpid=“Cus1”,h323iddivfrom=“AFA1974”,clisetname=“x”
The result name for result set 6 is the B_NUMBER_TYPE result type. The value for dataword1 is 3,
indicating the B-number type NOA is 3 (NOA_SUBSCRIBER).
Note that two result types (A_NUMBER_TYPE and BLACKLIST) have been connected in Example 4-2
by using the same result set name (set4). When the MML session is run, the last result in a result set has
to be created first. If the last result in a result set is not created first, an error is generated because a next
result cannot be connected, because that result does not yet exist.
Result Set Result Name Result Type Dataword1 Dataword2 Dataword3 Dataword4 Next Result
set1 result1 SCREENING 1 1
set2 result1 ANNOUNCEMENT 100 Washington relist1
set3 result1 IN_TRIGGER 1 1
set4 result1 A_NUMBER_TYPE 5 result2
set4 result2 BLACKLIST 1
set5 result1 BMODDIG 0 1 digmod1 result2
set5 result2 CC_DIG ccspain
set6 result1 B_NUMBER_TYPE 3
set7 result1 INC_NUMBERING 0 4 4
set8 result1 E_PORTED_NUM
set9 result1 E_PORTED_NUM 1
set9 result2 E_ROUTE_NUM 4
set10 result1 COND_ROUTE condname1
MML Commands
numan-add:resulttable:custgrpid=”t001”,name=”result1”,resulttype=”SCREENING”,dw1=”1”,dw2=”
Washington”,setname=”set1”
numan-add:resulttable:custgrpid=”t001”,name=”result1”,resulttype=”ANNOUNCEMENT”,dw1=”100”,
dw2=”1”,dw3=”rtlist1”,setname=”set2”
numan-add:resulttable:custgrpid=”t001”,name=”result1”,resulttype=”IN_TRIGGER”,dw1=”1”,
dw2=”1”,setname=”set3”
numan-add:resulttable:custgrpid=”t001”,name=”result1”,resulttype=”A_NUMBER_TYPE”,dw1=”5”,
setname=”set4”
numan-add:resulttable:custgrpid=”t001”,name=”result1”,resulttype=”BLACKLIST”,dw1=”1”,
setname=”set4”
numan-add:resulttable:custgrpid=”t001”,name=”result1”,resulttype=”BMODDIG”,dw1=”1”,dw2=”1”
,dw3=”digmod1”,setname=”set5”
numan-add:resulttable:custgrpid="t001",name="result2",resulttype="CC_DIG",dw1=ccspain,
setname="set5"
numan-add:resulttable:custgrpid=”t001”,name=”result1”,resulttype=”B_NUMBER_TYPE”,dw1=”3”,
setname=”set6”
numan-add:resulttable:custgrpid=”t001”,name=”result1”,resulttype=”INC_NUMBERING”,dw1=”0”,d
w2=”4”,dw3=”4”,setname=”set7”
numan-add:resulttable:custgrpid="t001",name="result1",resulttype="E_PORTED_NUM",
setname="set8"
numan-add:resulttable:custgrpid="t001",name="result1",resulttype="E_PORTED_NUM",dw1=”1”,
setname="set9"
numan-add:resulttable:custgrpid="t001",name="result2",resulttype=”E_ROUTE_NUM”,dw1=”4”,
setname="set9"
numan-add:resulttable:custgrpid="t001",name="result1",resulttype=”COND_ROUTE”,
dw1=”condname1”,setname="set10"
mml> numan-add:resulttable:custgrpid="t002",name="result34",resulttype="CC_DIG",
dw1=ccspain,setname="setname1"
mml> numan-add:resulttable:custgrpid="t002",name="result33",resulttype="CC_DIG",
dw1=ccfrance,setname="setname2"
mml> numan-add:resulttable:custgrpid="t002",name="result39",resulttype="CC_DIG",
dw1=ccitaly,setname="setname3"
This completes the linkage from the called number (B-number) to the result set, the result setname to the
CC_DIG result name, and finally the result name to the Country code digits in DIGMODSTRING. The
end result is to link the called number to the applicable Country code.
where:
• CustGrpID value
This dataword is relevant in all cases and supplies a CustGrpID that is used to read the dial plan
selection list. The default value is 0.
• AnalysisType value
Dataword2 for this result type is relevant when the digit analysis is defined for Pre-analysis (1 only),
A-number analysis (1 only), B-number analysis (1 or 2), or Cause analysis ((2 only).
Dataword2 provides an enumerated indication of what the next stage of analysis is to be, once the
new dial plan is identified and invoked. The valid values for dataword2 are as follows:
• 1—Revert to the Pre-analysis stage in the new dial plan
• 2—Restart in B-number analysis in the new dial plan
When provisioning, the provisioning code checks to ensure that the new dial plan, selected by the
result type NEW_DIALPLAN, is not the same as the current dial plan to avoid a loop situation.
Note Result names are limited to 20 alphanumeric characters. Spaces are not allowed.
Tip The values set for INC_NUMBERING dataword 2 (minimum digits) and dataword 3 (maximum digits
overrides the OMinDigits and OMaxDigits properties. For example, if OMinDigits is set to 3 and
INC_NUMBERING dataword 2 is set to 5, the incoming call will be routed after 5 digits have been
received.
Step 1 Use the following MML command to start and name an MML provisioning session:
mml> prov-sta::srcver=“SIP_EISUP_1001”,dstver=“sip_0801”
Step 2 Use the following MML command to dynamically set the enableipscreening property to “1” for the SIP
trunk group:
mml> prov-add:trnkgrpprop:name=“550”,enableipscreening=“1”
Step 1 Use the following MML command to start and name an MML provisioning session:
mml> prov-sta::srcver=“SIP_EISUP_1001”,dstver=“eisup_0801”
Step 2 Dynamically set the enableipscreening property to “1” for the EISUP trunk group:
mml> prov-add:trnkgrpprop:name=“2000”,enableipscreening=“1”
Configuring the MGC to Use IP Packet Source Address for Dial Plan Selection
Perform the following steps to configure and verify the sipipsource property to use IP packet source
address for dial plan selection:
Step 1 Start and name an MML provisioning session by using the following MML command.
mml> prov-sta::srcver=“SIP_EISUP_1001”, dstver=“sip_0801”
Step 2 Dynamically set the sipipsource property to “0” for the SIP trunk group by using the following MML
command.
mml> prov-add:trnkgrpprop:name=“550”,sipipsource=“0”
Configuring Cisco PGW 2200 Softswitch to use IP from SDP INVITE for Dial Plan Selection
Perform the following steps to configure and verify the sipipsource property to use the IP address from
SDP in INVITE for dial plan selection.
Step 2 Dynamically set the sipipsource property to “1” for the SIP trunk group:
mml> prov-add:trnkgrpprop:name=“550”,sipipsource=“1”
Step 2 Set the defaultpn property for the TDM_ISUP trunk group:
mml> prov-add:trnkgrpprop:name=“1000”,defaultpn=“4EAF005”
Step 1 Start and name an MML provisioning session by using the following MML command.
mml> prov-sta::srcver=“SIP_EISUP_1001”,dstver=“ss7_0801”
Step 2 Set the defaultpnnoa property for the TDM_ISUP trunk group by using the following MML command.
mml> prov-add:trnkgrpprop:name=“1000”, defaultpnnoa=“5”
Step 1 Start and name an MML provisioning session by using the following MML command.
mml> prov-sta::srcver=“SIP_EISUP_1001”,dstver=“ss7_0801”
Step 2 Set the defaultpnnpi property for the TDM_ISUP trunk group:
mml> prov-add:trnkgrpprop:name=“1000”,defaultpnnpi=“6”
Step 1 Start and name MML provisioning session by using the following MML command.
mml> prov-sta::srcver=“SIP_EISUP_1001”,dstver=“ss7_0801”
Step 2 Set the defaultpnpres property for the TDM_ISUP trunk group by using the following MML command.
mml> prov-add:trnkgrpprop:name=“1000",defaultpnpres=“6”
Step 3 Enter the following MML command to add an A-number digit tree:
numan-add:adigtree:custgrpid="5555",callside="originating",digitstring="301",setname="s
etloc1"
Step 3 Enter the following MML command to add a B-number digit tree:
numan-add:bdigtree:custgrpid="5555",callside="originating",digitstring="306",setname="s
etloc2"
Step 2 Enter the following MML command to add the OVERRIDE_CALLIM result type to the result set.
numan-add:resulttable:custgrpid="5555",name="resultoverride",resulttype="override_calli
m",setname="setloc3"
Step 3 Use one of the following MML commands to associate the OVERRIDE_CALLIM result type with:
CPC
numan-add:cpc:custgrpid="5555",cpcvalue=9,setname="setloc3"
A-number NOA
numan-add:anoa:custgrpid="5555",noavalue=4,setname="setloc3"
B-number NOA
numan-add:bnoa:custgrpid="5555",noavalue=4,setname="setloc3"
A Digit Tree
numan-add:adigtree:custgrpid="5555",callside="originating",digitstring="302",setname="s
etloc3"
B Digit Tree
numan-add:bdigtree:custgrpid="5555",callside="originating",digitstring="307",setname="s
etloc3"
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; add resulttype="loc_label" and assign these labels to the A digit tree
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> numan-add:resultset:custgrpid="5555",name="setloc"
mml> numan-add:resulttable:custgrpid="5555",name="resultloc",
resulttype="loc_label",dw1="location1",setname="setloc"
mml> numan-add:adigtree:custgrpid="5555",callside="originating",
digitstring="301",setname="setloc"
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; assign the location labels to dpnss sigPath
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-ed:dpnsspath:name="dpnss-3745-2-0",origlabel="location1",termlabel="location2"
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; assign the location labels to dpnss trunk group
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-ed:trnkgrp:name="3702",origlabel="location1",termlabel="location2"
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; add resulttype="override_callim" and associate it with a set
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> numan-add:resulttable:custgrpid="5555",name="resultloc",resulttype="override_callim",
setname="setloc"
Step 1 Customize reporting messages included in a call detail record by using the following MML command.
mml> numan-add:crptmesg:index=1, msgstr="Emergency Call"
Step 4 Add a result of the CALL_REPORT result type in the result set.
mml> numan-add:resulttable:custgrpid="1111", setname="pre-ana-callreport",
name="callreport", resulttype="CALL_REPORT", dw1="1", dw2="Emergency"
TheCisco PGW 2200 Softswitch supports transaction capabilities application part (TCAP) query to a
CNAM database, and only if, it is allowed based on calling name delivery blocking (CNAB) and calling
identity delivery and suppression (CIDS) information. The calling party name resides in the line
information database (LIDB) which is accessed using TCAP query.
To enable CNAM, use the following provisioning procedure:
Step 1 Add the CNAM service, route by SSN, by using the following MML command:
mml> prov-add:inservice:name="ansi-pre-ain-cnam",skortcv=0,
gtorssn="ROUTEBYSSN",gtformat="NOGT", msname="ansi-pre-ain-cnam"
Step 2 Add the CNAM service, route by GT, by using the following MML command:
mml> prov-ed:inservice:name="ansi-pre-ain-cnam",skortcv=0,gtorssn="ROUTEBYGT",
gtformat="GTTT",msname="ansi-pre-ain-cnam"
Step 6 Enable calling name display in EISUP path and trunk group.
mml> prov-add:sigsvcprop:name="EISUP", InhibitOutgoingCallingNameDisplay ="0"
mml> prov-add:trnkgrpprop:name="7777", InhibitOutgoingCallingNameDisplay ="0"
In the following provisioning example, you can find two result examples of the NUM_TRANS result
type. This procedure is for illustration purposes.
Step 1 Add a service to the dial plan, DP00, by using the following MML command:
mml> numan-add:service:custgrpid="DP00",name="freephone"
Step 2 Add an entry in the full number translation table in the TimesTen database.
mml> numan-add:fullnumbertrans:svcname="freephone",digstring="C2088880000",
translatednum="123456",numtype="2"
Step 5 Add a B-digit tree and associate it with the result set
mml> numan-add:bdigtree:custgrpid="DP00",digitstring="999810",callside="originating",
setname="setname3"
Step 7 Add an entry in the full number translation table in the TimesTen database.
mml> numan-add:fullnumbertrans:svcname="freephone1",digstring="456",
translatednum="222123123",numtype="2"
mml> numan-add:resulttable:custgrpid="DP01",name="results",resulttype="NUM_TRANS",
dw1="freephone1",dw2="2",dw3="3",setname="setname31"
Step 10 Add a B-digit tree and associate it with the result set
mml> numan-add:bdigtree:custgrpid="DP01",digitstring="999810",callside="originating",
setname="setname31"
Figure 4-1 shows the behavior on Cisco PGW 2200 Softswitch in this example.
Figure 4-1 Cisco PGW 2200 Softswitch Behavior in the Full Number Translations Provisioning
Example
Incomming call
DP00
B number analysis
setname3
NUM_TRANS for A number is successful.
NUM_TRANS 1 A number: C2088880000-->123456
Dial plan: DP00-->DP01
A_NUMBER_TYPE
B NUMBER_TYPE
A_NUMBER_TYPE,
B_NUMBER_TYPE, and
R_NUMBER_TYPE R_NUMBER_TYPE
results are dropped.
DP01
B number analysis
setname31
ROUTE Trunkgroup
206614
2. NUM_TRANS for A number is failed. BMODDIG, AMODDIG, and RMODDIG results will take
effect.
Step 1 Add a result set for setting the calling number (A-number) as the global title by using the following
MML command:
mml> numan-add:resultset:custgrpid="1111",name="LNPtrigger_Calling"
Step 3 Add the result of the result type IN_TRIGGER for the calling number:
mml> numan-add:resulttable:custgrpid="1111",name="LNPtrigger1",resulttype="IN_TRIGGER",
Dw1="24",dw2="4",dw3="0",dw4="6",setname="LNPtrigger_Calling"
Step 5 Add the result set for setting the called number (B-number) as the global title:
mml> numan-add:resultset:custgrpid="1111",name="LNPtrigger_Called"
Step 7 Add the result of the result type IN_TRIGGER for the called number:
mml> numan-add:resulttable:custgrpid="1111",name="LNPtrigger2",resulttype="IN_TRIGGER",
Dw1="24",dw2="4",dw3="0",dw4="6",setname="LNPtrigger_Called"
Step 10 Add the result set for setting the fixed digits as the global title:
mml> numan-add:resultset:custgrpid="1111",name="LNPtrigger_Fixed"
Step 12 Add the result of the result type IN_TRIGGER for the fixed digits:
mml> numan-add:resulttable:custgrpid="1111",name="LNPtrigger3",resulttype="IN_TRIGGER",
Dw1="24",dw2="4",dw3="0",dw4="6",setname="LNPtrigger_Fixed"
Step 1 Start a new MML session by using the following MML command:
mml> prov-sta::srcver="active",dstver="nested",confirm
Step 4 Add an entry that associates the destination domain string, bob@atlanta.cisco.com, with the route list,
rtlist002, in the route selection table:
mml> numan-add:routesel:custgrpid="T002",svcname="group1",
destdmnstring="bob@atlanta.cisco.com",rtlistname="rtlist002"
Step 5 Add an entry that associates the source domain string, example.com, to the source domain blacklist
table:
mml> numan-add:sourceblack:custgrpid="T002",svcname="group1",srcdmnstring="example.com"
Step 6 Add an entry that associates the destination domain name, dbrpgw.cisco.com, with the new domain
name, atlanta.cisco.com:5079, to the destination username and domain translation table:
mml> numan-add:desttrans:custgrpid="T002",svcname="group1",
destdmnstring="dbrpgw.cisco.com",domainname="atlanta.cisco.com:5079"
Step 9 Add a result of the result type DRP_EXIT that the Cisco PGW 2200 Softswitch exits from the entire
DRP stage of the preanalysis for DRP step 1:
mml> numan-add:resulttable:custgrpid="T002",name="resultexitdrp",resulttype="DRP_EXIT",
dw1="2", setname="exitdrp"
Step 10 Add a result of the result type IP_SET_SOURCE_DMN that the Cisco PGW 2200 Softswitch changes
the source domain to domainname1 (abc.cisco.com):
mml> numan-add:resulttable:custgrpid="T002", name="changesource",
resulttype="IP_SET_SOURCE_DMN",dw1="domainname1",setname="setSource",dw2="0",dw3="1"
Step 11 Add a result of the result type IP_SOURCE_SCREEN that if the source username matches an entry in
the source domain blacklist table added Step 5, the Cisco PGW 2200 Softswitch uses the setSource
result set which you added results in Step 10:
mml> numan-add:resulttable:custgrpid="T002",setname="drpstep1",name="screen",
resulttype="IP_SOURCE_SCREEN",dw1="2",dw2="group1",dw3="setSource"
Step 12 Add a result of the result type IP_ROUTE_SEL that if the destination user name and destination host
name matches the entry added in Step 4, then uses the rtlist002 to route the call:
mml> numan-add:resulttable:custgrpid="T002", name="resultrsel1",resulttype="IP_ROUTE_SEL",
dw1="1",dw2="group1",dw3="exitdrp",setname="routeCall"
Step 13 Add a result of the result type IP_DEST_TRANS that if the destination host domain matches an entry in
the destination user name and destination host table added in Step 6, the Cisco PGW 2200 Softswitch
uses routeCall result set. Otherwise, the Cisco PGW 2200 Softswitch uses the exitdrp result set:
mml> numan-add:resulttable:custgrpid="T002", setname="drpstep2", name="trans",
resulttype="IP_DEST_TRANS", dw1="2",dw2="group1", dw3="routeCall", dw4="exitdrp"
Step 14 Add the two result sets, drpstep1, and drpstep2 into the DRP table:
mml> numan-add:drptable:custgrpid="T002", drpstepnum="1", setname="drpstep1"
mml> numan-add:drptable:custgrpid="T002", drpstepnum="2", setname="drpstep2"
Step 1 Start a new MML session by using the following MML command:
mml> prov-sta::srcver="active",dstver="nested",confirm
Step 2 Add a tag list that can be associated with a trunk group (type = 0):
mml> numan-add:taglist:name="trunkgrptaglist",type="0"
Step 3 Add a tag, climust, with value true to the tag list, trunkgrptaglist:
mml> numan-add:tag:name=”climust”,value=”true”,taglist=”trunkgrptaglist”
Step 4 Add a tag, codec, with value G721 to the tag list, trunkgrptaglist:
mml> numan-add:tag:name=”codec”,value=”G721”,taglist=”trunkgrptaglist”
Step 5 Add a tag list that can be assocaited added in a dial plan (type = 1):
mml> numan-add:taglist:name=”sipcalltaglist”,type=”1”
Step 6 Add a tag, codec, with value G711 to the tag list, sipcalltaglist:
mml> numan-add:tag:name="codec",value="G711",taglist="sipcalltaglist"
Step 7 Add a tag, routingclass, with value primum to the tag list, sipcalltaglist:
mml> numan-ed:tag:name="routingclass", value="primum", taglist="sipcalltaglist"
Step 9 Add a result of the CALL_TAG result type in the dial plan:
mml> numan-add:resulttable:name="tag_result",resulttype="CALL_TAG",custgrpid="1111",
setname="gencalltag",dw1="sipcalltaglist"
Step 10 Associate an SS7 trunk group with the tag list, taglist1:
mml> prov-add:trnkgrpprop:name="444",calltaglist="trunkgrptaglist"
Step 11 Associate a SIP trunk group with the tag list, sipcall:
mml> prov-add:profile:name="sip-prof1",type="SIPPROFILE",custgrpid="1111",
mgcdomain="10.0.57.158", calltaglist="trunkgrptaglist"
mml> prov-add:trnkgrpprof:name="100",profile="sip-prof1"
Note While managing the Generic Call Tagging feature, if you must delete the tagvalue.dat and taglist.dat
files, you must delete the tagvalue.dat file before the taglist.dat file.
Step 1 Enter the following command on the active Cisco MGC at the Man-Machine Language (MML) prompt:
mml> numan-add:digmodstring:custgrpid=”cgid”, name=”dname”, digstring=”dstring”
Where:
• cgid—Indicates the customer group ID. This ID is a 4-digit alphanumeric string.
• dname—MML name of the digit modification string.
• dstring—String of digits to modify.
Note Over-decadic digits can be used in your prefix. You must ensure that only over-decadic digits B and C
are used in your prefix if the call data is routed through a H.323 network. B and C are the only
over-decadic digits that are supported in H.323. If you use any of the other over-decadic digits in your
prefix, once the call data enters a H.323 network through the Cisco H.323 Signaling Interface (HSI) the
A-number will be forwarded without those over-decadic digits.
For example, to add a digit modification string, 666, called restpfx, enter the following MML command:
mml> numan-add:digmodstring:custgrpid=”T002”,name=”restpfx”,digstring=”666”
Step 2 To verify that the command was executed successfully, enter the command:
mml> numan-rtrv
Step 3 Repeat steps 1 and 2 for each entry you add to the digit modification string list.
Tip An implied index, which contains a single string of digits that are applied to the calling number or called
number, is used to access the DIGMODSTRING list.
Step 1 Enter the following command on the active Cisco MGC at the MML prompt:
mml> numan-add:resulttable:custgrpid=”cgid”, name=”resnam”, resulttype=”AMODDIG”,
dw1=”dw1”, dw2=”0”, dw3=”dw3”, dw4=”1”, setname=”snam”
Where:
• cgid—Indicates the customer group ID. This ID is a 4-digit alphanumeric string.
• resnam—MML name of the result table.
• dw1 (dataword1)—Provides an index into the Script table in the MGC database, where the details
of the Script table, such as the gateway type, language, location, and so on, are stored. This value is
an integer.
Note When adding an index in the Script table, be sure that the value you enter is a valid value in the Script
table.
Caution Dataword 2 (dw2) cannot be used to subtract digits when you are using dataword 4 (dw4) to add
A-number modification result data.
Step 2 To verify that the command was executed successfully, enter the command:
mml> numan-rtrv
Step 3 Repeat steps 1 and 2 for each A-number modification result table you want to add.
Step 1 Enter the following command on the active Cisco MGC at the MML prompt:
mml> numan-add:adigittree:custgrpid="cgid", digitstring="dstring", callside="cs",
setname="snam"
Where:
• cgid—Indicates the customer group ID. This ID is a 4-digit alphanumeric string.
• dstring—Defines the digit string.
• cs—Indicates the side of the call, either originating or terminating.
• sname—Indicates the MML result set name for this A-number digit tree. The user configures the set
name, which can be as many as 20 alphanumeric characters.
For example, to add an A-digit tree to the customer group ID t100, enter the following MML command:
mml> numan-add:adigittree:custgrpid="t100",digitstring="703484",callside="originating",
setname="setone"
Step 2 To verify that the command was executed successfully, enter the command:
mml> numan-rtrv
Step 3 Repeat steps 1 and 2 for each entry you add to the A-digit tree.
To enable A-number normalization for the trunk group or signaling service that is associated with your
dial plan, complete the following steps:
Step 1 Enter the following command on the active Cisco MGC at the MML prompt:
mml> prov-add:property:name="comp_name",anumnormalise=1
Where:
• property—MML component type for trunk group or signaling service properties. Select one of the
following:
– trnkgrpprop—MML component for trunk group properties.
– sigsrvprop—MML component for signaling service properties.
• comp_name—MML name for the trunk group or signaling service on which you want to enable
A-number normalization.
For example, to enable A-number normalization on a signaling service that is called va-5300-a, enter the
following MML command:
mml> prov-add:sigsvcprop:name=”va-5300-a:,anumnormalise=1
Step 2 To verify that the command was executed successfully, enter the command:
mml> prov-rtrv
Step 3 Repeat steps 1 and 2 for each trunk group or signaling service on which you want to enable A-number
normalization.
Where:
• custgrpid—The name of a previously defined customer group ID. A string of four alphanumeric
characters that uniquely defines the customer. The customer group ID should begin with a letter.
• name—The name you want to give to the component. The name can be as many as 20 characters
long and can contain numbers, letters, and the dash (-) symbol. The name should begin with a letter.
• resulttype—The result type name.
• dw1—The value of the IAM profile mapping. Valid profile values can be found in Table 1-4 on
page 1-32.
Step 3 Repeat Step 2 for each E911PROF result type you want to add to your provisioning data.
Step 4 If there are no other components that you need to provision, end your provisioning session.
Mapping Methods
Since the MGC does not support CAMA signaling natively, an IOS gateway provides the CAMA
interface. Thus, after analyzing the ESRN number, MGC proxies the INVITE message from the SIP call
server to the IOS gateway. The IOS gateway then routes the call to SR using CAMA signaling.
Depending on the version of SR and PSAP, the location key (ESQK) is delivered in a different parameter
of the Initial Address Message (IAM). The MGC implements the following mapping methods:
• Mapping method 1, ESRK, which is equivalent to ESQK in a Voice over IP (VoIP) network
• Mapping method 2, ESRD, which is equivalent to ESQK in a VoIP network
The various IAM profiles are listed in Table 4-9 for ESRK delivery and in Table 4-10 for ESRD delivery.
ISUP
Parameter OLI CpCAT
Option Wireless Emergency CDPN CPN CHGN GDP Note(s)
A1 No Yes 911 ESRK ESRK Blank 1, 2
A2 No Yes 911 ESRK — Blank 1, 2
A3 No Yes 911 — ESRK Blank 1, 2
B1 No No 911 ESRK ESRK Blank 1, 2
B2 No No 911 ESRK — Blank 1, 2
B3 No No 911 — ESRK Blank 1, 2
Note
1. This ISUP parameter option is widely supported in North America. It is estimated that 95% of the
E9-1-1 SRs deployed in North America support this option when the SR has been equipped with
wireless E9-1-1 features.
2. Blank—This parameter must not be populated.
ISUP
Parameter OLI CpCAT
Option Wireless Emergency CDPN CPN CHGN GDP Note(s)
1
A1 Yes Yes 911 CBN CBN ESRD 1
A2 Yes Yes 911 CBN — ESRD 1
A3 Yes Yes 911 — CBN ESRD 1
B1 Yes No 911 CBN CBN ESRD 3
B2 Yes No 911 CBN — ESRD 3
B3 Yes No 911 — CBN ESRD 3
C1 No Yes 911 CBN CBN ESRD 3
Note
1. This ISUP parameter option is widely supported in North America. It is estimated that 95% of the
E9-1-1 SRs deployed in North America support this option when the SR has been equipped with
wireless E9-1- 1 features.
2. Blank—This parameter must not be populated.
3. This ISUP parameter option is available in some areas. It is estimated that 50% of the E9-1-1 SRs
deployed in North America support this option when the SR has been equipped with wireless E9-1-1
features.
ISUP
Parameter OLI CpCAT
Option Wireless Emergency CDPN CPN CHGN GDP Note(s)
C2 No Yes 911 CBN — ESRD 3
C3 No Yes 911 — CBN ESRD 3
D1 No No 911 CBN CBN ESRD 3
D2 No No 911 CBN — ESRD 3
D3 No No 911 — CBN ESRD 3
E1 Yes Yes ESRD CBN CBN Blank 1, 2
E2 Yes Yes ESRD CBN — Blank 1, 2
F1 Yes No ESRD CBN CBN Blank 2, 3
F2 Yes No ESRD CBN — Blank 2, 3
G1 No Yes ESRD CBN CBN Blank 2, 3
G2 No Yes ESRD CBN — Blank 2, 3
H1 No No ESRD CBN CBN Blank 2, 3
H2 No No ESRD CBN — Blank 2, 3
I1 Yes Yes ESRD CBN CBN ESRD 1
I2 Yes Yes ESRD CBN — ESRD 1
I3 Yes Yes ESRD — CBN ESRD 3
J1 Yes No ESRD CBN CBN ESRD 3
J2 Yes No ESRD CBN — ESRD 3
K1 No Yes ESRD CBN CBN ESRD 3
K2 No Yes ESRD CBN — ESRD 3
L1 No No ESRD CBN CBN ESRD 3
L2 No No ESRD CBN — ESRD 3
Note
1. This ISUP parameter option is widely supported in North America. It is estimated that 95% of the
E9-1-1 SRs deployed in North America support this option when the SR has been equipped with
wireless E9-1- 1 features.
2. Blank—This parameter must not be populated.
3. This ISUP parameter option is available in some areas. It is estimated that 50% of the E9-1-1 SRs
deployed in North America support this option when the SR has been equipped with wireless E9-1-1
features.
1. ESRD, in a mobile network, is equivalent to ESQK. in a VoIP network.
The following sections contain the nature of address (NOA) and numbering plan indicator (NPI) codes
for the result types listed in Table 1-1 on page 1-11. In addition, the internal calling party category (CPC)
and transmission medium requirement (TMR) values are also listed.
NOA Codes
The NOA codes listed in the following sections define protocol-specific NOA values and the unique
mappings to numerical values supported by each protocol. An “X” in any of the variant cells in the
following tables indicates that the specified mapping is supported by that protocol variant.
The NOA codes described in the following tables include:
• Internal Call Context NOA Values—Table A-1 on page A-1 and A-2
• ANSI SS7 NOA Values—Table A-2 on page A-3
• PRI NOA Values—Table A-3 on page A-4
• Q.761 NOA Values—Table A-4 on page A-5 and A-5
• Q.767 Call Context NOA Values—Table A-5 on page A-6
Internal
Table A-1 describes the internal Call Context NOA values and corresponding numerical values.
ANSI SS7
Table A-2 describes the NOA values and corresponding bit code patterns for the ANSI SS7 protocol.
Protocol
Standard
Specific
Sprint
Binary Code
Bell
MCI
ANSI Call Context NOA Values Pattern
NOA_950_CALL 1110110 X X X X
NOA_ABBR 0000110 X X X
NOA_ANI 1100111 X
NOA_CARRIER_NO_NUM 1110101 X X X X
NOA_CREDIT_CARD 1100110 X
NOA_DIRECT_TERMINATION_OVERFLOW 1111100 X
NOA_INTERNATIONAL 0000100 X X X X
NOA_INTERNATIONAL_OPERATOR_TO_OPERATOR_ 1111011 X
INSIDE_WZI
NOA_INTERNATIONAL_OPERATOR_TO_OPERATOR_ 1111010 X
OUTSIDE_WZI
NOA_ISN_EXTENDED_INTERNATIONAL_TERMINATION 1111101 X
NOA_MCI_VNET 1111000 X
NOA_NATIONAL DEFAULT 0000011 X X X X
NOA_NO_ANI_RECD 1101000 X
NOA_NON_UNIQUE_INTERNATIONAL 1111001 X
NOA_NON_UNIQUE_INTERNATIONAL 1110100 X X X
NOA_NON_UNIQUE_NATIONAL 1110011 X X X
NOA_NON_UNIQUE_NATIONAL 1111000 X
NOA_NON_UNIQUE_SUBSCRIBER 1110001 X X X
NOA_NONE 0000000 X X X X
NOA_OPRREQ_INTERNATIONAL 1110011 X X X X
NOA_OPRREQ_NATIONAL 1110010 X X X X
NOA_OPRREQ_NO_NUM 1110100 X X X X
NOA_OPRREQ_SUBSCRIBER 1110001 X X X X
NOA_SUBSCRIBER 0000001 X X X X
NOA_TEST_LINE_CODE 1110111 X X X X
NOA_TRANSFER_ISN_TO_ISN 1111110 X
PRI
Table A-3 describes the NOA values and corresponding bit code patterns related to the PRI protocol.
In keeping with the PRI’s MDL program definition, the bit codes are listed with decimal values.
AT&T TR41459
ETSI 300-102
Protocol
INSNet
Specific
Bell
PRI DEFAULT:NOA_NATIONAL
INSNet DEFAULT:NOA_UNKNOWN
Q.761
Table A-4 describes the NOA values and corresponding bit code patterns for the Q.761 protocol.
Belgian Mobistar
Hong_Kong Q761
Australian Q.761
Japanese Q761
Standard Q.761
Finnish Q.761
Korean Q761
Protocol
Specific
Binary Code
Q.761 Call Context NOA Values Pattern
NOA_950_CALL 1110110
NOA_UNIQUE_3DIG_NAT_NUM 0000011 X X
NOA_ANI 1100111
NOA_NO_ANI_RECD 0000010 X X
NOA_CARRIER_NO_NUM 0000010 X X
NOA_CREDIT_CARD 1100110
NOA_DIRECT_TERMINATION_OVERFLOW 1111100
NOA_INT_INBOUND 0000100 X X
NOA_INTERNATIONAL 0000100 X X X X X
NOA_INTERNATIONAL_OPERATOR_TO_OPERATOR_ 1111011
NSIDE_WZI
NOA_INTERNATIONAL_OPERATOR_TO_OPERATOR_ 1111010
OUTSIDE_WZI
NOA_ISN_EXTENDED_INTERNATIONAL_TERMINATIO 1111101
N
NOA_MCI_VNET 1111000
NOA_NATIONAL DEFAULT 0000011 X X X X X X X
NOA_NAT_OR_INTL_CARRIER_ACC_CODE_INC 0000010 X X
NOA_NETWORK 1111110 X X
NOA_NO_ANI_RECD 1101000
NOA_NON_UNIQUE_INTERNATIONAL 1111001
NOA_NON_UNIQUE_INTERNATIONAL 0000100 X X
NOA_NON_UNIQUE_INTERNATIONAL 1110100
NOA_NON_UNIQUE_NATIONAL 0000011 X X
NOA_NON_UNIQUE_NATIONAL 1110011
NOA_NON_UNIQUE_NATIONAL 1111000
NOA_NON_UNIQUE_SUBSCRIBER 0000001 X X
NOA_NON_UNIQUE_SUBSCRIBER 1110001
Belgian Mobistar
Hong_Kong Q761
Australian Q.761
Japanese Q761
Standard Q.761
Finnish Q.761
Korean Q761
Protocol
Specific
Binary Code
Q.761 Call Context NOA Values Pattern
NOA_NONE 0000000 X X X
NOA_OPRREQ_INTERNATIONAL 0000100 X X
NOA_OPRREQ_NATIONAL 0000011 X
NOA_OPRREQ_NO_NUM 0000010 X X
NOA_OPRREQ_SUBSCRIBER 0000001 X X
NOA_SUBSCRIBER 0000001 X X X X
NOA_TEST_LINE_CODE 1110111
NOA_TRANSFER_ISN_TO_ISN 1111110
NOA_UK_SPECIFIC_ADDRESS 1111110 X
NOA_UKNOWN 1110000 X X
NOA_UKNOWN 0000010 X X X
Q.767
Table A-5 describes the NOA values and corresponding bit code patterns related to the Q.767 protocol.
ETS-300_121 Polish
Protocol
Standard
Swedish
Specific
Spanish
Russian
Italian
Binary Code
Q.767 Call Context NOA Values Pattern
NOA_950_CALL 1110110
NOA_ANI 1100111
NOA_NO_ANI_RECD 0000000 X X
NOA_CARRIER_NO_NUM 0000000 X
NOA_CREDIT_CARD 1100110
NOA_DIRECT_TERMINATION_OVERFLOW 1111100
NOA_INT_INBOUND 0000100 X
NOA_INTERNATIONAL 0000100 X X
ETS-300_121 Polish
Protocol
Standard
Swedish
Specific
Spanish
Russian
Italian
Binary Code
Q.767 Call Context NOA Values Pattern
NOA_INTERNATIONAL_OPERATOR_TO_OPERATOR_INSIDE_WZI 1111011
NOA_INTERNATIONAL_OPERATOR_TO_OPERATOR_OUTSIDE_WZI 1111010
NOA_ISN_EXTENDED_INTERNATIONAL_TERMINATION 1111101
NOA_MCI_VNET 1111000
NOA_NATIONAL DEFAULT 0000011 X X X X X
NOA_NO_ANI_RECD 1101000
NOA_UNIQUE_3DIG_NAT_NUM 0000011 X
NOA_NON_UNIQUE_INTERNATIONAL 0000100 X
NOA_NON_UNIQUE_INTERNATIONAL 1110100
NOA_NON_UNIQUE_NATIONAL 0000011 X X
NOA_NON_UNIQUE_NATIONAL 1111000
NOA_NON_UNIQUE_SUBSCRIBER 0000001 X
NOA_NONE 0000000 X
NOA_OPRREQ_NATIONAL 0000011 X X
NOA_OPRREQ_NO_NUM 0000000 X
NOA_OPRREQ_SUBSCRIBER 0000001 X
NOA_SPAIN 11111110 X
NOA_SUBSCRIBER 0000001 X X X
NOA_TEST_LINE_CODE 1110111
NOA_TRANSFER_ISN_TO_ISN 1111110
NOA_UNKNOWN 0000010 X
NPI Codes
The numbering plan indicator (NPI) codes listed in the following sections define protocol-specific NPI
values and the unique mappings to numerical values supported by each protocol. An “X” in any of the
variant cells in these tables indicates that the specified mapping is supported by that protocol variant.
The NPI codes described in the following tables include:
• Internal NPI Values—Table A-6 on page A-8
• ANSI SS7 NPI Values—Table A-7 on page A-8
• PRI NPI Values—Table A-8 on page A-9
Internal
Table A-6 describes the internal (Call Context) NPI code values.
ANSI SS7
Table A-7 describes the received protocol-specific bit code patterns to internal (Call Context) NPI value
mappings supported by the ANSI SS7 protocol.
Sprint
Bell
MCI
NAPI2:NPI_E164 DEFAULT
NAPI1:NPI_NONE DEFAULT
PRI
Table A-8 describes the received protocol-specific bit code patterns to internal (Call Context) NPI value
mappings supported by the PRI protocol.
INS Net
Bell
PRI Call Context NPI Values Bit Pattern
NOA_UNKNOWN 0000 X X X X X
NPI_E164 DEFAULT 0001 X X X X
NPI_DATA 0011 X X X
NPI_TELEX 0100 X X
NOA_NATIONAL 1000 X X
NPI_PNP 1001 X X X
DEFAULT: NPI_E164
NAPI1: NPI_NONE DEFAULT
CPC Values
The Calling Party Category (CPC) internal values are listed in Table A-9 and corresponding CPC
description.
Table A-12 Q.761_97Ver and Q.767 Russian Variant CPC Index (continued)
External
Binary Value
CPC Message (Decimal) CPC Index Internal Value
CPC_UNKNOWN 00000000—(0) CPC_UNKNWN 0
CPC_FRENCH 00000001—(1) CPC_OPER_FRENCH 1
CPC_ENGLISH 00000010—(2) CPC_OPER_ENGLISH 2
CPC_GERMAN 00000011—(3) CPC_OPER_GERMAN 3
CPC_RUSSIAN 00000100—(4) CPC_OPER_RUSSIAN 4
CPC_SPANISH 00000101—(5) CPC_OPER_SPANISH 5
CPC_ADMIN1 00000110—(6) CPC_ADMN1 6
CPC_ADMIN2 00000111—(7) CPC_ADMN2 7
CPC_ADMIN3 00001000—(8) CPC_ADMN3 8
CPC_ORD 00001010—(10) CPC_ORD_SUBSC 9
CPC_TEST 00001101—(13) CPC_TEST 13
CPC_PAYPHONE 00001111—(15) CPC_CUST_PAYPHONE 14
CPC_EMERGENCY 11100000—(224) CPC_EMERGENCY 16
CPC_HIGH_PRIO_EMERG 11100001—(225) CPC_HIGH_PRIO_EMERG 17
CPC_NAT_EMERGENCY 11100010—(226) CPC_NAT_EMERGENCY 18
CPC_Q_UNKNOWN 00010000—(16) CPC_Q_UNKNOWN 89
CPC_Q_FRENCH 00010001—(17) CPC_Q_FRENCH 90
CPC_Q_ENGLISH 00010010—(18) CPC_Q_ENGLISH 91
CPC_Q_GERMAN 00010011—(19) CPC_Q_GERMAN 92
CPC_Q_RUSSIAN 00010100—(20) CPC_Q_RUSSIAN 93
CPC_Q_SPANISH 00010101—(21) CPC_Q_SPANISH 94
CPC_Q_ADMIN1 00010110—(22) CPC_Q_ADMIN1 95
CPC_Q_ADMIN2 00010111—(23) CPC_Q_ADMIN2 96
CPC_Q_ADMIN3 00011000—(24) CPC_Q_ADMIN3 97
CPC_Q_ORD 00011010—(26) CPC_Q_ORD 98
CPC_Q_TEST 00011101—(31) CPC_Q_TEST 99
CPC_Q_EMERGENCY 11110000—(240) CPC_Q_EMERGENCY 100
CPC_Q_HIGH_PRIO_EMER 11110001—(241) CPC_Q_HIGH_PRIO_EMER 101
G G
CPC_Q_NAT_EMERGENCY 11110010—(242) CPC_Q_NAT_EMERGENCY 102
TMR Values
The Transmission Medium Requirement (TMR) internal values are listed in Table A-16 and
corresponding TMR description.
The TMR value range is from 0 through 255. Table A-16 lists the internal TMR value and corresponding
TMR description.
External
Binary Value
TMR Message (Decimal) TMR Index Internal Value
TMR_SPEECH 00000000—(0) TMR_SPEECH 0
TMR_AUDIO_3K 00000011—(3) TMR_AUDIO_3K 2
TMR_UNRES_64K 00000010—(2) TMR_UNRES_64K 1
TMR_64K_PREF 00000110—(6) TMR_64K_PREF 3
TMR_128K 00000111—(7) TMR_128K 4
TMR_384K 00001000—(8) TMR_384K 5
TMR_1536K 00001001—(9) TMR_1536K 6
TMR_1920K 00001010—(10) TMR_1920K 7
External
Binary Value
TMR Message (Decimal) TMR Index Internal Value
TMR_SPEECH 00000000—(0) TMR_SPEECH 0
TMR_AUDIO_3K 00000011—(3) TMR_AUDIO_3K 2
TMR_UNRES_64K 00000010—(2) TMR_UNRES_64K 1
TMR_384K 00001000—(8) TMR_384K 5
TMR_1536K 00001001—(9) TMR_1536K 6
TMR_1920K 00001010—(10) TMR_1920K 7
This appendix contains the cause and location codes for the result types listed in Table 1-1 on page 1-11.
• Internal Cause Codes, page B-1
• DPNSS Cause Codes, page B-15
• ISDN Cause Codes, page B-22
• ISDN PRI Cause Codes, page B-25
• Q.761 Cause Codes, page B-35
• ANSI SS7 Cause Codes, page B-68
• SIP to DPNSS Cause Codes, page B-75
• Release Cause Location Codes, page B-95
• MGCP 1.0 Cause and Location Codes, page B-100
• MGCP 1.0 Error and Return Codes, page B-106
The cause codes listed in the following sections are defined by their individual explanations.
Additionally, the following ISUP protocols are supported and map internal cause code 44 to an external
NOA value as listed in Table B-4.
Table B-4 Internal NOA 44 to External NOA Mapping for ISUP Protocols
Table B-5 Received DPNSS Cause Code to Internal Cause Code Mappings
Table B-5 Received DPNSS Cause Code to Internal Cause Code Mappings (continued)
Table B-6 Internal Cause Code to Transmitted DPNSS Cause Code Mappings
Table B-6 Internal Cause Code to Transmitted DPNSS Cause Code Mappings (continued)
Table B-6 Internal Cause Code to Transmitted DPNSS Cause Code Mappings (continued)
Table B-6 Internal Cause Code to Transmitted DPNSS Cause Code Mappings (continued)
Table B-6 Internal Cause Code to Transmitted DPNSS Cause Code Mappings (continued)
Table B-6 Internal Cause Code to Transmitted DPNSS Cause Code Mappings (continued)
Table B-6 Internal Cause Code to Transmitted DPNSS Cause Code Mappings (continued)
Cause i = 0x829F08
Parsed Hex Digits 0x82 9F 08
Cause Code Disconnect Cause Optional
Description origination point Code Diagnostic field
The leading 0x in the disconnect code indicates the digits that follow are in hexadecimal.
The first two digits after 0x indicate where in the circuit path the disconnected cause code was generated.
In the example above, 0x82 indicates the call was disconnected from the local telco switch.
This list will help you interpret where a call was disconnected:
• 0x80—From the router.
• 0x81—From the private network near the local user [(possibly a local private branch exchange
(PBX)].
• 0x82—From the public network near the local user (local telco switch).
• 0x83—From the transit network (in the ISDN cloud).
• 0x84—From the public network near the remote user (remote telco switch).
• 0x85—From the private the network near the remote user (possibly a remote PBX).
• 0x87—From the international network.
• 0x8A—From a network beyond the internetworking point.
The two hexadecimal digits that follow the cause code digits above are significant in troubleshooting
(9F in Table B-7). Table B-8 shows the cause value field and description.
The last two hexadecimal digits (08 in Table B-7) are optional and are not commonly used for diagnostic
purposes. Use the table below to associate a disconnect cause code and the reason for the disconnect.
D6 Call with requested call id Network receives a call resume request that contains a Call
has been cleared Identity that once indicated a suspended call. However, the
suspended call was cleared either by time-out or by remote user.
D8 Incompatible destination Indicates that an attempt is made to connect to non-ISDN
equipment. (For example, an analog line.)
DB Invalid transit network ISDN exchange is asked to route the call through an
selection unrecognized intermediate network.
DF Invalid message, An invalid message is received with no standard cause. This is
unspecified usually due to a D-channel error. If error occurs systematically,
report it to your ISDN service provider.
E0 Mandatory IE missing Receiving equipment receives a message that does not include
a mandatory information element. This is due to a D-channel
error. Ensure the switch type is configured correctly. A Cisco
IOS® Software upgrade on the router can alleviate this issue. If
error occurs systematically, report it to your ISDN service
provider.
Code Cause Description Additional Information
E1 Message type not Receiving equipment receives an unrecognized message,
implemented because the message type is invalid or the message type is valid,
but not supported. The cause is a problem with the remote
configuration or with the local D-channel.
E2 Message not compatible Remote equipment receives an invalid message with no
with call state or not standard cause. The cause is a D-channel error. If the error
implemented occurs systematically, report it to ISDN service provider.
E3 IE not implemented Remote equipment receives a message that includes
unrecognized information elements. This is a D-channel error.
If the error occurs systematically, report it to your ISDN service
provider.
E4 Invalid IE contents Remote equipment receives a message that includes invalid
information elements. This is due to a D-channel error.
E5 Message not compatible Remote equipment receives an expected message that does not
with call state correspond to the current state of the connection. This is a
D-channel error.
EF Protocol error, unspecified An unspecified D-channel error with no other standard cause.
FF Interworking, unspecified An event occurs, but the network does not provide causes for
the action it takes. The precise problem is unknown.
?? Unknown Cause value The cause value is unknown.
Table B-9 Received PRI Cause Code to Internal Cause Code Mappings
Table B-9 Received PRI Cause Code to Internal Cause Code Mappings (continued)
Table B-10 Received AT&T TR41459 Specific PRI Cause Code to Internal Cause Code Mappings
Received AT&T TR41459 PRI Cause Codes Value Internal Cause Code Value
ICPCallingDroppedWhileOnHold 3 IC_CALLING_DROPPED_WHILE_ON_HOLD 97
ICPCallingPartyOffHold 2 IC_CALLING_PARTY_OFF_HOLD 96
ICPIncomingCallsBarred 54 IC_INCOMING_CALLS_BARRED 62
ICPNewDestination 47 IC_NEW_DESTINATION 98
ICPOutgoingCallsBarred 52 IC_OUTGOING_CALLS_BARRED 99
Table B-11 Received Bell 1268 Specific PRI Cause Code to Internal Cause Code Mappings
Received Bell 1268 PRI Cause Codes Value Internal Cause Code Value
ICPExcessiveDigCallProceeding 11 IC_EXCESSIVE_DIG_CALL_PROCEEDING 122
ICPPrefix0DialledInError 8 IC_PREFIX_0_DIALLED_IN_ERROR 119
ICPPrefix1DialledInError 9 IC_PREFIX_1_DIALLED_IN_ERROR 120
ICPPrefix1NotDialled 10 IC_PREFIX_1_NOT_DIALLED 121
ICPProtErrThresholdExceeded 101 IC_PROT_ERR_THRESHOLD_EXCEEDED 123
ICPVacantCode 4 IC_VACENT_CODE 118
Table B-12 INS1500 Specific PRI Cause Code to Internal Cause Code Mappings
Received INS 1500 PRI Cause Codes Value Internal Cause Code Value
ICPIncomingCallsBarredWithinCUG 55 IC_INCOMING_CALLS_BARRED_IN_CUG 80
ICPInconsistencyInOGAccess 62 IC_INCON_OUTGOING_ACC_AND_SUB_CLASS 125
ICPMisDialedTrunkPrefix 5 IC_MISDIALLED_TK_PREFIX 83
ICPMsgWithUnreqParamDiscarded 110 IC_MESG_WITH_UNREC_ELEM_DISCARDED 127
ICPNonExistentCUG 90 IC_NON_EXISTENT_CUG 126
ICPOutgoingCallsBarredWithinCUG 53 IC_OUTGOING_CALLS_BARRED_IN_CUG 124
ICPParameterNonExistentPassedOn 103 IC_PARAM_UNREC_PASSED 84
ICPPermFrameModeOOS 39 IC_PERMANENT_FRAME_MODE_OOS 129
ICPPermFrameModeOperational 40 IC_PERMANENT_FRAME_MODE_OPERATIONA 130
L
ICPPrecedenceCallBlocked 46 IC_PRECEDENCE_BLOCKED 93
ICPPreemption 8 IC_PREEMPTION 86
ICPPreemptionCircuitReserved 9 IC_PREEMPTION_CCT_RES 128
ICPSendSpecialInformationTone 4 IC_SPECIAL_INFORMATION_TONE 81
ICPSubscriberAbsent 20 IC_SUB_ABSCENT 90
ICPUserNotMemberOfCUG 87 IC_USER_NOT_MEMBER_OF_CUG 82
Table B-13 Internal Cause Code to Transmitted PRI Cause Code Mappings
BELL 1268
Valu Valu
Internal Cause Code e Transmitted PRI Cause Code e
IC_ACCESS_BARRED 54 ICPNormalClearing 16 X X X X X
IC_ACCESS_INFO_DISCARDED 1 ICPAccessInfoDiscarded 43 X X X
IC_ACKNOWLEDGEMENT 55 ICPNormalClearing 16 X X X X X
IC_ADDRESS_INCOMPLETE 55 ICPInvalidNumberFormat 28 X X X X
IC_ADDRESS_INCOMPLETE 56 ICPNormalClearing 16 X
IC_ANONYMOUS_CALL_REJECTION 116 ICPNormalUnspecified 31 X X X X X
IC_BEARCAP_NOT_AUTHORIZED 2 ICPBearCapNotAuthorized 57 X X X X
IC_BEARCAP_NOT_AVAIL 3 ICPBearCapNotAvail 58 X X X X
IC_BEARCAP_NOT_IMP 4 ICPBearCapNotImp 65 X X X X X
IC_BLACKLIST_BNUMBER_MATCHED 137 ICPServiceOrOptionNotAvail 63 X X X X X
IC_BLACKLIST_CLI_LENGTH_INVALID 133 ICPServiceOrOptionNotAvail 63 X X X X X
IC_BLACKLIST_CLI_MATCHED 134 ICPServiceOrOptionNotAvail 63 X X X X X
IC_BLACKLIST_CPC_RESTRICTED 135 ICPServiceOrOptionNotAvail 63 X X X X X
IC_BLACKLIST_NO_CLI 132 ICPServiceOrOptionNotAvail 63 X X X X X
IC_BLACKLIST_NOA_RESTRICTED 136 ICPServiceOrOptionNotAvail 63 X X X X X
IC_BUSY 57 ICPUserBusy 17 X X X X X
IC_CALL_AWARDED_DELIVERED_EST_CH 5 ICPCallAwardedDeliveredEstCh 7 X X X
IC_CALL_ID_HAS_BEEN_CLEARED 6 ICPCallIdHasBeenCleared 86 X X
IC_CALL_ID_IN_USE 7 ICPCallIdInUse 84 X X
IC_CALL_REJECT_CALL_GAPPING 102 ICPNormalUnspecified 31 X X X X X
IC_CALL_REJECTED 8 ICPCallRejected 21 X X X X X
IC_SIP_CALL_SETUP_TIMEOUT 221 ICPNoUserResponding 18 X X X X X
IC_CALL_TERMINATION 61 ICPNormalClearing 16 X X X X X
IC_CALL_TYPE_INCOMPATIBLE 95 ICPNormalUnspecified 31 X X X X X
IC_CALLING_DROPPED_WHILE_ON_HOLD 98 ICPCallingDroppedWhileOnHold 3 X
IC_CALLING_PARTY_OFF_HOLD 97 ICPCallingPartyOffHold 2 X
Table B-13 Internal Cause Code to Transmitted PRI Cause Code Mappings (continued) (continued)
BELL 1268
Valu Valu
Internal Cause Code e Transmitted PRI Cause Code e
IC_CH_ID_NOT_EXIST 9 ICPChIdNotExist 82 X X X X
IC_CH_TYPE_NOT_IMP 10 ICPChTypeNotImp 66 X X X X
IC_CH_UNACCEPTABLE 11 ICPChUnacceptable 6 X X X X X
IC_CHANNEL_OUT_OF_SERVICE 58 ICPTemporaryFailure 41 X X X X X
IC_CONGESTION 60 ICPNoCircuitAvailable 34 X X X X X
IC_COT_FAILURE 141 ICPNormalUnspecified 31 X X X X X
IC_CUG_ACCESS_BARRED 108 ICPNormalUnspecified 31 X X X X X
IC_DEST_OUT_OF_ORDER 12 ICPDestOutOfOrder 27 X X X
IC_DTE_CONTROLLED_NOT_READY 59 ICPNormalClearing 16 X X X X X
IC_DTE_UNCONTROLLED_NOT_READY 79 ICPNormalClearing 16 X X X X X
IC_ELEM_TYPE_NOT_IMP 13 ICPElemTypeNotImp 99 X X X X X
IC_EXCESSIVE_DIG_CALL_PROCEEDING 123 ICPExcessiveDigCallProceeding 11 X
IC_FACILITY_NOT_REGISTERED 62 ICPNormalClearing 16 X X X X X
IC_FACILITY_REJECTED 14 ICPFacilityRejected 29 X X X
IC_FLOW_CONTROLLED_CONGESTION 110 ICPNormalUnspecified 31 X X X X X
IC_GROUP_RESTRICTIONS 96 ICPNormalUnspecified 31 X X X X X
IC_INCOMING_CALLS_BARRED 62 ICPCallRejected 21 X X X X
IC_INCOMING_CALLS_BARRED 63 ICPIncomingCallsBarred 54 X
IC_INCOMING_CALLS_BARRED_IN_CUG 81 ICPIncomingCallsBarredWithinCU 55 X
G
IC_INCOMPATIBLE_DEST 15 ICPIncompatibleDest 88 X X X X X
IC_INCON_OUTGOING_ACC_AND_SUB_CLA 126 ICPInconsistencyInOGAccess 62 X
SS
IC_INTERCEPTED_SUBSCRIBER 53 ICPNormalUnspecified 31 X X X X X
IC_INTERWORK_UNSPEC 16 ICPInterworkUnspec 127 X X X X
IC_INVALID_CALL_REF 143 ICPNormalUnspecified 31 X X X X X
IC_INVALID_CALL_REFERENCE_VALUE 17 ICPInvalidCallReferenceValue 81 X X X X X
IC_INVALID_ELEM_CONTENTS 18 ICPInvalidElemContents 100 X X X X X
IC_INVALID_MSG_UNSPEC 19 ICPInvalidMsgUnspec 95 X X
IC_INVALID_NUMBER_FORMAT 20 ICPInvalidNumberFormat 28 X X X X X
IC_INVALID_TNS 21 ICPInvalidTNS 91 X X
IC_MANDATORY_ELEMENT_MISSING 22 ICPMandatoryElementMissing 96 X X X X X
Table B-13 Internal Cause Code to Transmitted PRI Cause Code Mappings (continued) (continued)
BELL 1268
Valu Valu
Internal Cause Code e Transmitted PRI Cause Code e
IC_MESG_WITH_UNREC_ELEM_DISCARDED 128 ICPMsgWithUnreqParamDiscarded 110 X
IC_MESSAGE_NOT_UNDERSTOOD 65 ICPNormalUnspecified 31 X X X X X
IC_MISDIALLED_TK_PREFIX 84 ICPMisDialedTrunkPrefix 5 X
IC_MISROUTED_CALL_PORTED_NUM 142 ICPNormalUnspecified 31 X X X X X
IC_MSG_IN_WRONG_STATE 23 ICPMsgInWrongState 101 X X X X
IC_MSG_TYPE_NOT_IMP 24 ICPMsgTypeNotImp 97 X X X X X
IC_MSG_TYPE_NOT_IMP_OR_WRONG_STATE 25 ICPMsgTypeNotImpOrWrongState 98 X X X X
IC_NETWORK_ADDRESS_EXTENSION_ERRO 66 ICPNormalClearing 16 X X X X X
R
IC_NETWORK_OUT_OF_ORDER 26 ICPNetworkOutOfOrder 38 X X
IC_NETWORK_TERMINATION 67 ICPNormalUnspecified 31 X X X X X
IC_NEW_DESTINATION 99 ICPNewDestination 47 X
IC_NO_ANSWER_ALERTED_USER 28 ICPNoAnswerAlertedUser 19 X X X X X
IC_NO_CALL_SUSPENDED 27 ICPNoCallSuspended 85 X X
IC_NO_CIRCUIT_AVAILABLE 29 ICPNoCircuitAvailable 34 X X X X X
IC_NO_ROUTE_TO_DEST 33 ICPNoRouteToDest 3 X X X X
IC_NO_ROUTE_TO_TNS 34 ICPNoRouteToTNS 2 X X X
IC_NO_USER_RESPONDING 35 ICPNoUserResponding 18 X X X X X
IC_NON_EXISTENT_CUG 127 ICPNonExistentCUG 90 X
IC_NON_SELECTED_USER_CLEARING 30 ICPNonSelectedUserClearing 26 X X
IC_NORMAL_CLEARING 31 ICPNormalClearing 16 X X X X X
IC_NORMAL_UNSPECIFIED 32 ICPNormalUnspecified 31 X X X X X
IC_NUMBER_CHANGED 36 ICPNumberChanged 22 X X X X
IC_NUMBER_UNOBTAINABLE 68 ICPUnallocatedNumber 1 X X X X X
IC_ONLY_RESTRICT_DIG_INFO_BEARER 37 ICPOnlyRestrictDigInfoBearer 70 X X
IC_OPERATOR_PRIORITY_ACCESS 107 ICPNormalUnspecified 31 X X X X X
IC_OUT_OF_CATCHMENT_AREA 111 ICPNormalUnspecified 31 X X X X X
IC_OUTGOING_CALLS_BARRED 100 ICPOutgoingCallsBarred 52 X
IC_OUTGOING_CALLS_BARRED_IN_CUG 125 ICPOutgoingCallsBarredWithinCU 53 X
G
IC_PARAM_UNREC_PASSED 85 ICPParameterNonExistentPassedOn 103 X
IC_PERMANENT_FRAME_MODE_OOS 130 ICPPermFrameModeOOS 39 X
Table B-13 Internal Cause Code to Transmitted PRI Cause Code Mappings (continued) (continued)
BELL 1268
Valu Valu
Internal Cause Code e Transmitted PRI Cause Code e
IC_PERMANENT_FRAME_MODE_OPERATIO 131 ICPPermFrameModeOperational 40 X
NAL
IC_PERMANENT_ICB 113 ICPNormalUnspecified 31 X X X X X
IC_PORTED_NUMBER 139 ICPNormalUnspecified 31 X X X X X
IC_PRECEDENCE_BLOCKED 94 ICPPrecedenceCallBlocked 46 X
IC_PREEMPTION 87 ICPPreemption 8 X
IC_PREEMPTION_CCT_RES 129 ICPPreemption Circuit Reserved 9 X
IC_PREEMPTION_CCT_UNAVAILABLE 88 ICPPreemptionCircuitReserved 9 X
IC_PREFIX_0_DIALLED_IN_ERROR 120 ICPPrefix0DialledInError 8 X
IC_PREFIX_1_DIALLED_IN_ERROR 121 ICPPrefix1DialledInError 9 X
IC_PREFIX_1_NOT_DIALLED 122 ICPPrefix1NotDialed 10 X
IC_PRIORITY_FORCED_RELEASE 69 ICPNormalClearing 16 X X X X X
IC_PROPRIETARY 86 ICPNormalUnspecified 31 X X X X X
IC_PROT_ERR_THRESHOLD_EXCEEDED 124 ICPProtErrorThresholdExceeded 101 X
IC_PROTOCOL_ERROR_UNSPEC 38 ICPProtocolErrorUnspec 111 X X X X
IC_QUALITY_UNAVAIL 39 ICPQualityUnavail 49 X X
IC_RECOVERY_ON_TIMER_EXPIRY 40 ICPRecoveryOnTimerExpiry 102 X X X X X
IC_REDIRECTION_TO_NEW_DEST 140 ICPNormalUnspecified 31 X X X X X
IC_REJECT 70 ICPNormalClearing 16 X X X X X
IC_REJECTED_BY_FEATURE 169 ICPCallRejectedByFeature 24 X X
IC_REJECTED_DIVERTED_CALL 103 ICPNormalUnspecified 31 X X X X X
IC_REMOTE_PROC_ERROR 105 ICPNormalUnspecified 31 X X X X X
IC_REPEAT_ATTEMPT 118 ICPNormalUnspecified 31 X X X X X
IC_REQ_CIRCUIT_UNAVAIL 41 ICPReqCircuitUnavail 44 X X X X X
IC_REQ_FACILITY_NOT_IMP 42 ICPReqFacilityNotImp 69 X X X
IC_REQ_FACILITY_NOT_SUBSCR 43 ICPReqFacilityNotSubscr 50 X X X
IC_RESOURCES_UNAVAIL_UNSPEC 44 ICPResourcesUnavailUnspec 47 X X
IC_RESPONSE_TO_STATUS_ENQUIRY 45 ICPResponseToStatusEnquiry 30 X X X X X
IC_REJECT 70 ICPNetworkOutOfOrder 38 X X X
IC_REJECT 70 ICPSwitchingEquipCongestion 42 X
IC_ROUTE_OUT_OF_SERVICE 71 ICPDestOutOfOrder 27 X
Table B-13 Internal Cause Code to Transmitted PRI Cause Code Mappings (continued) (continued)
BELL 1268
Valu Valu
Internal Cause Code e Transmitted PRI Cause Code e
IC_ROUTING_ERROR 93 ICPNormalUnspecified 31 X X X X X
IC_SELECTIVE_CALL_BARRING 104 ICPNormalUnspecified 31 X X X X X
IC_SERVICE_INCOMPATIBLE 64 ICPBearCapNotImp 65 X X X X X
IC_SERVICE_OR_OPTION_NOT_AVAIL 47 ICPServiceOrOptionNotAvail 63 X X X X
IC_SERVICE_OR_OPTION_NOT_IMP_UNSPEC 46 ICPServiceOrOptionNotImpUnspec 79 X X
IC_SERVICE_TEMPORARILY_UNAVAILABLE 77 ICPNormalClearing 16 X X X X X
IC_SERVICE_UNAVAILABLE 78 ICPNormalClearing 16 X X X X X
IC_SIGNAL_NOT_UNDERSTOOD 73 ICPNormalUnspecified 31 X X X X X
IC_SIGNAL_NOT_VALID 74 ICPNormalUnspecified 31 X X X X X
IC_SIGNALLING_SYSTEM_INCOMPATIBLE 76 ICPNormalUnspecified 31 X X X X X
IC_SPECIAL_INFORMATION_TONE 82 ICPSendSpecialInformationTone 4 X
IC_SUB_ABSCENT 91 ICPSubscriberAbsent 20 X
IC_SUB_CONTROLLED_ICB 101 ICPNormalUnspecified 31 X X X X X
IC_SUB_NOT_FOUND_DLE 115 ICPNormalUnspecified 31 X X X X X
IC_SUBSCRIBER_CALL_TERMINATE 109 ICPNormalClearing 16 X X X X X
IC_SUBSCRIBER_INCOMPATIBLE 72 ICPIncompatibleDest 88 X X X X X
IC_SUBSCRIBER_MOVED 114 ICPNormalUnspecified 31 X X X X X
IC_SUBSCRIBER_OUT_OF_SERVICE 74 ICPDestOutOfOrder 27 X X X X
IC_SUBSCRIBER_OUT_OF_SERVICE 75 ICPSwitchingEquipCongestion 42 X
IC_SUSPEND_EXIST_BUT_NOT_THIS_ID 48 ICPSuspendExistButNotThisId 83 X X
IC_SWITCHING_EQUIP_CONGESTION 49 ICPSwitchingEquipCongestion 42 X X X X
IC_TEMPORARY_FAILURE 50 ICPTemporaryFailure 41 X X X X X
IC_TEMPORARY_OOS 106 ICPNormalUnspecified 31 X X X X X
IC_TERMINAL_CONGESTION 117 ICPNormalUnspecified 31 X X X X X
IC_TRANSFERRED 80 ICPNormalUnspecified 31 X X X X X
IC_TRANSLATION_OOS 112 ICPNormalUnspecified 31 X X X X X
IC_UNALLOCATED_DEST_NUMBER 89 ICPNormalUnspecified 31 X X X X X
IC_UNALLOCATED_NUMBER 51 ICPUnallocatedNumber 1 X X X X X
IC_UNDEFINED_BG 92 ICPNormalUnspecified 31 X X X X X
IC_UNKNOWN 147 ICPNormalUnspecified 31 X X X X X
IC_UNREC_ELEM_PASSED_ON 90 ICPNormalUnspecified 31 X X X X X
IC_USER_BUSY 52 ICPUserBusy 17 X X X X X
Table B-13 Internal Cause Code to Transmitted PRI Cause Code Mappings (continued) (continued)
BELL 1268
Valu Valu
Internal Cause Code e Transmitted PRI Cause Code e
IC_USER_NOT_MEMBER_OF_CUG 83 ICPUserNotMemberOfCUG 87 X
IC_VACANT_CODE 119 ICPVacantCode 4 X
IC_WHITELIST_CLI_NOT_MATCHED 138 ICPNormalUnspecified 31 X X X X X
IC_BAD_REQUEST 177 ICPTEmporaryFailure 41
IC_UNAUTHORIZED 178 ICPCallRejected 21
IC_PAYMENT_REQUIRED 179 ICPCallRejected 21
IC_FORBIDDEN 180 ICPCallRejected 21
IC_METHOD_NOT_ALLOWED 181 ICPServiceOrOptionNotAvail 63
IC_NOT_ACCEPTABLE 182 ICPServiceOrOptionNotImpUnspec 79
IC_PROXY_AUTHEN_REQUIRED 183 ICPCallRejected 21
IC_REQUEST_TIMEOUT 184 ICPRecoveryOnTimerExpiry 102
IC_CONFLICT 185 ICPTEmporaryFailure 41
IC_LENGTH_REQUIRED 186 ICPInterworkUnspec 127
IC_ENTITY_TOO_LONG 187 ICPInterworkUnspec 127
IC_URI_TOO_LONG 188 ICPInterworkUnspec 127
IC_UNSUPPORTED_MEDIA_TYPE 189 ICPServiceOrOptionNotImpUnspec 79
IC_UNSUPPORTED_URI_SCHEME 190 ICPInterworkUnspec 127
IC_BAD_EXTENSION 191 ICPInterworkUnspec 127
IC_EXTENSION_REQUIRED 192 ICPInterworkUnspec 127
IC_SESSION_INTERVAL_TOO_SMALL 193 ICPNormalUnspecified 31
IC_INTERVAL_TOO_BRIEF 194 ICPInterworkUnspec 127
IC_ANONYMITY_DISALLOWED 195 ICPNormalUnspecified 31
IC_TEMP_NOT_AVAILABLE 196 ICPNoUserResponding 18
IC_LEG_OR_TRANSACTION_NOT_EXIST 197 ICPTemporaryFailure 41
IC_LOOP_DETECTED 198 ICPNormalUnspecified 31
IC_TOO_MANY_HOPS 199 ICPNormalUnspecified 31
IC_AMBIGUOUS 200 ICPUnallocatedNumber 1
IC_REQUEST_TERMINATED 201 ICPNormalClearing 16
IC_NOT_ACCEPT_HERE 202 ICPNormalUnspecified 31
IC_BAD_EVENT 203 ICPNormalUnspecified 31
IC_REQUEST_PENDING 204 ICPNormalUnspecified 31
IC_UNDECIPHERABLE 205 ICPNormalUnspecified 31
Table B-13 Internal Cause Code to Transmitted PRI Cause Code Mappings (continued) (continued)
BELL 1268
Valu Valu
Internal Cause Code e Transmitted PRI Cause Code e
IC_SERVER_INTERNAL_ERROR 206 ICPTemporaryFailure 41
IC_NOT_IMPLEMENTED 207 ICPServiceOrOptionNotImpUnspec 79
IC_BAD_GATEWAY 208 ICPNetworkOutOfOrder 38
IC_SERVICE_UNAVAIL 209 ICPNormalClearing 16
IC_SERVER_TIMEOUT 210 ICPRecoveryOnTimerExpiry 102
IC_VERSION_NOT_SUPPORT 211 ICPInterworkUnspec 127
IC_MSG_TOO_LARGE 212 ICPInterworkUnspec 127
IC_PRECONDITION_FAILURE 213 ICPTemporaryFailure 41
IC_DECLINE 214 ICPCallRejected 21
IC_NOT_EXIST_ANYWHERE 215 ICPCallRejected 1
IC_NOT_ACCEPTABLE_606 216 ICPNormalUnspecified 31
IC_MULTIPLE_CHOICES 217 ICPNormalUnspecified 31
IC_MOVED_PERMANENTLY 218 ICPNormalUnspecified 31
IC_USE_PROXY 219 ICPUnallocatedNumber 1
IC_ALTERNATIVE_SERVICE 220 ICPNormalUnspecified 31
IC_SIP_CALL_SETUP_TIMEOUT 221 ICPNoUserResponding 18
Received
Q.761
Cause External Cause Code Internal Cause
Code Value Received Cause Code Description Value Code Value
001 UNALLOCATED_NUMBER 1 51
002 NO_ROUTE_TO_TNS 2 34
003 NO_ROUTE_TO_DEST 3 33
004 SPECIAL_INFORMATION_TONE 4 82
005 MISDIALLED_TK_PREFIX 5 84
006 NORMAL_EVENT_NOTUSED 6 — not used — not used
007 NORMAL_EVENT_NOTUSED 7 — not used — not used
008 PREEMPTION 8 87
009 PREEMPTION_CCT_UNAVAILABLE 9 88
010 NORMAL_EVENT_NOTUSED 10 — not used — not used
011 NORMAL_EVENT_NOTUSED 11 — not used — not used
012 NORMAL_EVENT_NOTUSED 12 — not used — not used
013 NORMAL_EVENT_NOTUSED 13 — not used — not used
014 NP_QOR_NUM_NOT_FOUND 14 164
015 NORMAL_EVENT_NOTUSED 15 — not used — not used
016 NORMAL_CLEARING 16 31
017 USER_BUSY 17 52
018 NO_USER_RESPONDING 18 35
019 NO_ANSWER_ALERTED_USER 19 28
020 SUB_ABSCENT 20 91
021 CALL_REJECTED 21 8
022 NUMBER_CHANGED 22 36
023 REDIRECTION_TO_NEW_DEST 23 140
024 REJECTED_BY_FEATURE 24 — not used 169 (UK only)
025 ROUTING_ERROR 25 93
026 NORMAL_EVENT_NOTUSED 26 — not used — not used
027 DEST_OUT_OF_ORDER 27 12
028 ADDRESS_INCOMPLETE 28 56
029 FACILITY_REJECTED 29 14
030 NORMAL_EVENT_NOTUSED 30 — not used — not used
031 NORMAL_UNSPECIFIED 31 32
032 NORMAL_EVENT_NOTUSED 32 — not used — not used
033 NORMAL_EVENT_NOTUSED 33 — not used — not used
Received
Q.761
Cause External Cause Code Internal Cause
Code Value Received Cause Code Description Value Code Value
034 NO_CIRCUIT_AVAILABLE 34 29
035 NORMAL_EVENT_NOTUSED 35 — not used — not used
036 NORMAL_EVENT_NOTUSED 36 — not used — not used
037 NORMAL_EVENT_NOTUSED 37 — not used — not used
038 NETWORK_OUT_OF_ORDER 38 26
039 RES_UNAVAIL_NOTUSED 39 — not used — not used
040 RES_UNAVAIL_NOTUSED 40 — not used — not used
041 TEMPORARY_FAILURE 41 50
042 SWITCHING_EQUIP_CONGESTION 42 49
043 ACCESS_INFO_DISCARDED 43 1
044 IC_REQ_CIRCUIT_UNAVAIL 44 41
045 CALL_FORWARD 45 160
046 PRECEDENCE_BLOCKED 46 94
047 RESOURCES_UNAVAIL_UNSPEC 47 44
048 SERV_NOT_AVAIL_NOTUSED 48 — not used — not used
032 NORMAL_EVENT_NOTUSED 49 — not used — not used
050 IC_REQ_FACILITY_NOT_SUBSC 50 43
051 NORMAL_EVENT_NOTUSED 51 — not used — not used
052 NORMAL_EVENT_NOTUSED 52 — not used — not used
053 OUTGOING_CALLS_BARRED_IN_C 53 125
UG
054 SERV_NOT_AVAIL_NOTUSED 54 — not used — not used
055 INCOMING_CALLS_BARRED_IN_CU 55 81
056 SERV_NOT_AVAIL_NOTUSED 56 — not used — not used
057 BEARCAP_NOT_AUTHORIZED 57 2
058 BEARCAP_NOT_AVAIL 58 3
059 SERV_NOT_AVAIL_NOTUSED 59 — not used — not used
060 SERV_NOT_AVAIL_NOTUSED 60 — not used — not used
061 SERV_NOT_AVAIL_NOTUSED 61 — not used — not used
062 INCON_OUTGOING_ACC_AND_SUB 62 126
_CLASS
063 SERVICE_OR_OPTION_NOT_AVAIL 63 47
064 SERV_NOT_IMP_NOTUSED 64 — not used — not used
065 BEARCAP_NOT_IMP 65 4
Received
Q.761
Cause External Cause Code Internal Cause
Code Value Received Cause Code Description Value Code Value
066 SERVICE_OR_OPTION_NOT_IMP_U 66 46
NSPEC
067 SERV_NOT_IMP_NOTUSED 67 — not used — not used
068 SERV_NOT_IMP_NOTUSED 68 — not used — not used
069 REQ_FACILITY_NOT_IMP 69 42
070 ONLY_RESTRICT_DIG_INFO_BEAR 70 37
ER
071 SERV_NOT_IMP_NOTUSED 71 — not used — not used
072 SERV_NOT_IMP_NOTUSED 72 — not used — not used
073 SERV_NOT_IMP_NOTUSED 73 — not used — not used
074 SERV_NOT_IMP_NOTUSED 74 — not used — not used
075 SERV_NOT_IMP_NOTUSED 75 — not used — not used
076 SERV_NOT_IMP_NOTUSED 76 — not used — not used
077 SERV_NOT_IMP_NOTUSED 77 — not used — not used
078 SERV_NOT_IMP_NOTUSED 78 — not used — not used
079 SERVICE_OR_OPTION_NOT_IMP_U 79 46
NSPEC
080 INVALID_MSG_NOTUSED 80 — not used — not used
081 INVALID_MSG_NOTUSED 81 — not used — not used
082 INVALID_MSG_NOTUSE 82 — not used — not used
083 INVALID_MSG_NOTUSED 83 — not used — not used
084 INVALID_MSG_NOTUSED 84 — not used — not used
085 INVALID_MSG_NOTUSED 85 — not used — not used
086 INVALID_MSG_NOTUSED 86 — not used — not used
087 USER_NOT_MEMBER_OF_CUG 87 83
088 INCOMPATIBLE_DEST 88 15
089 INVALID_MSG_NOTUSED 89 — not used — not used
090 NON_EXISTENT_CUG 90 127
091 INVALID_TNS 91 21
092 INVALID_MSG_NOTUSED 92 — not used — not used
093 INVALID_MSG_NOTUSED 93 — not used — not used
094 INVALID_MSG_NOTUSED 94 — not used — not used
095 INVALID_MSG_UNSPEC 95 19
096 INVALID_MSG_NOTUSED 96 — not used — not used
097 MSG_TYPE_NOT_IMP 97 24
Received
Q.761
Cause External Cause Code Internal Cause
Code Value Received Cause Code Description Value Code Value
098 INVALID_MSG_NOTUSED 98 — not used — not used
099 ELEM_TYPE_NOT_IMP 99 13
100 INVALID_MSG_NOTUSED 100 — not used — not used
101 INVALID_MSG_NOTUSED 101 — not used — not used
102 RECOVERY_ON_TIMER_EXPIRY 102 40
103 PARAM_UNREC_PASSED 103 85
104 PROT_ERROR_NOTUSED 104 — not used — not used
105 PROT_ERROR_NOTUSED 105 — not used — not used
106 PROT_ERROR_NOTUSED 106 — not used — not used
107 PROT_ERROR_NOTUSED 107 — not used — not used
108 PROT_ERROR_NOTUSED 108 — not used — not used
109 PROT_ERROR_NOTUSED 109 — not used — not used
110 MESG_WITH_UNREC_ELEM_DISCA 110 128
RDED
111 PROTOCOL_ERROR_UNSP 111 38
112 INTERWORK_NOTUSED 112 — not used — not used
113 INTERWORK_NOTUSED 113 — not used — not used
114 INTERWORK_NOTUSED 114 — not used — not used
115 INTERWORK_NOTUSED 115 — not used — not used
116 INTERWORK_NOTUSED 116 — not used — not used
117 INTERWORK_NOTUSED 117 — not used — not used
118 INTERWORK_NOTUSED 118 — not used — not used
119 INTERWORK_NOTUSED 119 — not used — not used
120 INTERWORK_NOTUSED 120 — not used — not used
121 INTERWORK_NOTUSED 121 — not used — not used
122 INTERWORK_NOTUSED 122 — not used — not used
123 INTERWORK_NOTUSED 123 — not used — not used
124 INTERWORK_NOTUSED 124 — not used — not used
125 INTERWORK_NOTUSED 125 — not used — not used
126 PORTED_NUMBER 126 139
127 INTERWORK_UNSP 127 16
Table B-15 lists the received Q.761 cause code description in alphabetical order along with their
associated internal cause value.
Received
Q.761
Cause External Cause Code Internal Cause
Received Cause Code Description Code Value Value Code Value
ACCESS_INFO_DISCARDED 043 43 1
ADDRESS_INCOMPLETE 028 28 56
BEARCAP_NOT_AUTHORIZED 057 57 2
BEARCAP_NOT_AVAIL 058 58 3
BEARCAP_NOT_IMP 065 65 4
CALL_FORWARD 045 45 160
CALL_REJECTED 021 21 8
DEST_OUT_OF_ORDER 027 27 12
ELEM_TYPE_NOT_IMP 099 99 13
FACILITY_REJECTED 029 29 14
IC_REQ_CIRCUIT_UNAVAIL 044 44 41
IC_REQ_FACILITY_NOT_SUBSC 050 50 43
INCOMING_CALLS_BARRED_IN_CU 055 55 81
INCOMPATIBLE_DEST 088 88 15
INCON_OUTGOING_ACC_AND_SUB 062 62 126
_CLASS
INTERWORK_NOTUSED 112 112 — not used — not used
INTERWORK_NOTUSED 113 113 — not used — not used
INTERWORK_NOTUSED 114 114 — not used — not used
INTERWORK_NOTUSED 115 115 — not used — not used
INTERWORK_NOTUSED 116 116 — not used — not used
INTERWORK_NOTUSED 117 117 — not used — not used
INTERWORK_NOTUSED 118 118 — not used — not used
INTERWORK_NOTUSED 119 119 — not used — not used
INTERWORK_NOTUSED 120 120 — not used — not used
INTERWORK_NOTUSED 121 121 — not used — not used
INTERWORK_NOTUSED 122 122 — not used — not used
INTERWORK_NOTUSED 123 123 — not used — not used
INTERWORK_NOTUSED 124 43 1
INTERWORK_NOTUSED 125 28 56
INTERWORK_UNSP 127 57 2
INVALID_MSG_NOTUSE 082 58 3
INVALID_MSG_NOTUSED 080 65 4
INVALID_MSG_NOTUSED 081 45 160
Received
Q.761
Cause External Cause Code Internal Cause
Received Cause Code Description Code Value Value Code Value
INVALID_MSG_NOTUSED 083 21 8
INVALID_MSG_NOTUSED 084 27 12
INVALID_MSG_NOTUSED 085 99 13
INVALID_MSG_NOTUSED 086 29 14
INVALID_MSG_NOTUSED 089 44 41
INVALID_MSG_NOTUSED 092 50 43
INVALID_MSG_NOTUSED 093 55 81
INVALID_MSG_NOTUSED 094 88 15
INVALID_MSG_NOTUSED 096 62 126
INVALID_MSG_NOTUSED 098 112 — not used — not used
INVALID_MSG_NOTUSED 100 113 — not used — not used
INVALID_MSG_NOTUSED 101 114 — not used — not used
INVALID_MSG_UNSPEC 095 115 — not used — not used
INVALID_TNS 091 116 — not used — not used
MESG_WITH_UNREC_ELEM_DISCA 110 117 — not used — not used
RDED
MISDIALLED_TK_PREFIX 005 118 — not used — not used
MSG_TYPE_NOT_IMP 097 119 — not used — not used
NETWORK_OUT_OF_ORDER 038 120 — not used — not used
NO_ANSWER_ALERTED_USER 019 121 — not used — not used
NO_CIRCUIT_AVAILABLE 034 122 — not used — not used
NO_ROUTE_TO_DEST 003 123 — not used — not used
NO_ROUTE_TO_TNS 002 43 1
NO_USER_RESPONDING 018 28 56
NON_EXISTENT_CUG 090 57 2
NORMAL_CLEARING 016 58 3
NORMAL_EVENT_NOTUSED 006 65 4
NORMAL_EVENT_NOTUSED 007 45 160
NORMAL_EVENT_NOTUSED 010 21 8
NORMAL_EVENT_NOTUSED 011 27 12
NORMAL_EVENT_NOTUSED 012 99 13
NORMAL_EVENT_NOTUSED 013 29 14
NORMAL_EVENT_NOTUSED 015 44 41
NORMAL_EVENT_NOTUSED 026 50 43
Received
Q.761
Cause External Cause Code Internal Cause
Received Cause Code Description Code Value Value Code Value
NORMAL_EVENT_NOTUSED 030 55 81
NORMAL_EVENT_NOTUSED 032 88 15
NORMAL_EVENT_NOTUSED 033 62 126
NORMAL_EVENT_NOTUSED 035 112 — not used — not used
NORMAL_EVENT_NOTUSED 036 113 — not used — not used
NORMAL_EVENT_NOTUSED 037 114 — not used — not used
NORMAL_EVENT_NOTUSED 032 115 — not used — not used
NORMAL_EVENT_NOTUSED 051 116 — not used — not used
NORMAL_EVENT_NOTUSED 052 117 — not used — not used
NORMAL_UNSPECIFIED 031 118 — not used — not used
NP_QOR_NUM_NOT_FOUND 014 119 — not used — not used
NUMBER_CHANGED 022 120 — not used — not used
ONLY_RESTRICT_DIG_INFO_BEAR 070 121 — not used — not used
ER
OUTGOING_CALLS_BARRED_IN_C 053 122 — not used — not used
UG
PARAM_UNREC_PASSED 103 123 — not used — not used
PORTED_NUMBER 126 43 1
PRECEDENCE_BLOCKED 046 28 56
PREEMPTION 008 57 2
PREEMPTION_CCT_UNAVAILABLE 009 58 3
PROT_ERROR_NOTUSED 104 65 4
PROT_ERROR_NOTUSED 105 45 160
PROT_ERROR_NOTUSED 106 21 8
PROT_ERROR_NOTUSED 107 27 12
PROT_ERROR_NOTUSED 108 99 13
PROT_ERROR_NOTUSED 109 29 14
PROTOCOL_ERROR_UNSP 111 44 41
RECOVERY_ON_TIMER_EXPIRY 102 50 43
REDIRECTION_TO_NEW_DEST 023 55 81
REJECTED_BY_FEATURE 024 88 15
REQ_FACILITY_NOT_IMP 069 62 126
RES_UNAVAIL_NOTUSED 039 112 — not used — not used
RES_UNAVAIL_NOTUSED 040 113 — not used — not used
Received
Q.761
Cause External Cause Code Internal Cause
Received Cause Code Description Code Value Value Code Value
RESOURCES_UNAVAIL_UNSPEC 047 114 — not used — not used
ROUTING_ERROR 025 115 — not used — not used
SERV_NOT_AVAIL_NOTUSED 048 116 — not used — not used
SERV_NOT_AVAIL_NOTUSED 054 117 — not used — not used
SERV_NOT_AVAIL_NOTUSED 056 118 — not used — not used
SERV_NOT_AVAIL_NOTUSED 059 119 — not used — not used
SERV_NOT_AVAIL_NOTUSED 060 120 — not used — not used
SERV_NOT_AVAIL_NOTUSED 061 121 — not used — not used
SERV_NOT_IMP_NOTUSED 064 122 — not used — not used
SERV_NOT_IMP_NOTUSED 067 123 — not used — not used
SERV_NOT_IMP_NOTUSED 068 43 1
SERV_NOT_IMP_NOTUSED 071 28 56
SERV_NOT_IMP_NOTUSED 072 57 2
SERV_NOT_IMP_NOTUSED 073 58 3
SERV_NOT_IMP_NOTUSED 074 65 4
SERV_NOT_IMP_NOTUSED 075 45 160
SERV_NOT_IMP_NOTUSED 076 21 8
SERV_NOT_IMP_NOTUSED 077 27 12
SERV_NOT_IMP_NOTUSED 078 99 13
SERVICE_OR_OPTION_NOT_AVAIL 063 29 14
SERVICE_OR_OPTION_NOT_IMP_U 066 44 41
NSPEC
SERVICE_OR_OPTION_NOT_IMP_U 079 50 43
NSPEC
SPECIAL_INFORMATION_TONE 004 55 81
SUB_ABSCENT 020 88 15
SWITCHING_EQUIP_CONGESTION 042 62 126
TEMPORARY_FAILURE 041 112 — not used — not used
UNALLOCATED_NUMBER 001 113 — not used — not used
USER_BUSY 017 114 — not used — not used
USER_NOT_MEMBER_OF_CUG 087 115 — not used — not used
Table B-16 Internal Cause Code to Transmitted Q.761 Cause Code Mappings
Value
Value
Standard Q.761
Australian Q.761
Finnish Q.761
Japanese Q.761
Japanese ETS_300_356
Hong_Kong Q.761
Belgian Mobistar
Korean Q761
ETS_300_356 & NTT
ETS_300_356 Spanish
ETS_300_356_V3 & UK
Taiwan Q.761
German Q.761
Thailand Q.761
KPNPB Q.761
Swiss Q.761
China. Q.761
Table B-16 Internal Cause Code to Transmitted Q.761 Cause Code Mappings (continued)
Value
Value
Standard Q.761
Australian Q.761
Finnish Q.761
Japanese Q.761
Japanese ETS_300_356
Hong_Kong Q.761
Belgian Mobistar
Korean Q761
ETS_300_356 & NTT
ETS_300_356 Spanish
ETS_300_356_V3 & UK
Taiwan Q.761
German Q.761
Thailand Q.761
KPNPB Q.761
Swiss Q.761
China. Q.761
Internal Cause Code Transmitted Q.761 Cause
IC_BEARCAP_NOT_IM 4 BEARCAPNOTIMP 65 X X X X X X X X
P
IC_CALL_AWARDED_D 5 TEMPORARYFAILURE 41 X X X X X X X X X X X X X X X X X
ELIVERED_EST_CH
IC_CALL_ID_HAS_BEE 6 TEMPORARYFAILURE 41 X X X X X X X X X X X X X X X X
N_CLEARED
IC_CALL_ID_IN_USE 7 NORMALUNSPECIFIED 31 X X
IC_CALL_ID_IN_USE 7 TEMPORARYFAILURE 41 X X X X X X X X X X X X X X X
IC_CALL_REJECTED 8 CALLREJECTED 21 X X X X X X X X X
IC_CH_ID_NOT_EXIST 9 INTERWORKUNSPEC 12 X X X X X X X X X X X X X X X X X
7
IC_CH_TYPE_NOT_IMP 10 INTERWORKUNSPEC 12 X X X X X X X X X X X X X X X X X
7
IC_CH_UNACCEPTABL 11 TEMPORARYFAILURE 41 X X X X X X X X X X X X X X X X X
E
IC_DEST_OUT_OF_OR 12 DESTOUTOFORDER 27 X X X X X X X
DER
IC_ELEM_TYPE_NOT_I 13 ELEMUNRECDISCARD 99 X X X X X X X X
MP ED
IC_FACILITY_REJECTE 14 SERVNOTAVAIL 63 X X X X X X X X X X X X X
D
IC_FACILITY_REJECTE 14 FACILITYREJECTED 29 X
D
IC_INCOMPATIBLE_DE 15 INCOMP_DEST 88 X X X X X X X X
ST
IC_INTERWORK_UNSP 16 INTERWORKUNSPEC 12 X X X X X X X X
EC 7
IC_INVALID_CALL_RE 17 TEMPORARYFAILURE 41 X X X X X X X X X X X X X X X X X
FERENCE_VALUE
IC_INVALID_ELEM_CO 18 MSGUNRECELEMENTD 11 X X X X X X X
NTENTS ISCARDED 0
IC_INVALID_MSG_UNS 19 INVALIDMESSAGE 95 X X X X X X X X X X X X X X X
PEC
IC_INVALID_NUMBER 20 ADDRESSINCOMPLETE 28 X X X X X X X X X X X X X X X X X
_FORMAT
Table B-16 Internal Cause Code to Transmitted Q.761 Cause Code Mappings (continued)
Value
Value
Standard Q.761
Australian Q.761
Finnish Q.761
Japanese Q.761
Japanese ETS_300_356
Hong_Kong Q.761
Belgian Mobistar
Korean Q761
ETS_300_356 & NTT
ETS_300_356 Spanish
ETS_300_356_V3 & UK
Taiwan Q.761
German Q.761
Thailand Q.761
KPNPB Q.761
Swiss Q.761
China. Q.761
Internal Cause Code Transmitted Q.761 Cause
IC_INVALID_TNS 21 INVALIDTNS 91 X X X X X
IC_INVALID_TNS 21 NOROUTETODESTINAT 3 X X X X X X X X X X X X X X X
ION
IC_MANDATORY_ELE 22 PROTOCOLERRORUNSP 11 X X X X X X X X X X X X X X X X X
MENT_MISSING ECIFIED 1
IC_MSG_IN_WRONG_S 23 PROTOCOLERRORUNSP 11 X X X X X X X X X X X X X X X X
TATE ECIFIED 1
IC_MSG_IN_WRONG_S 23 MSG_IN_WRONG_STAT 10 X
TATE E 1
IC_MSG_TYPE_NOT_I 24 MSGNOTEXIST 97 X X X X X X X
MP
IC_ MSG_ TYPE_ NOT_ 25 PROTOCOLERRORUNSP 11 X X X X X X X X X X X X X X X X X
IMP_ OR_ WRONG_ ECIFIED 1
STATE
IC_NETWORK_OUT_O 26 NETWORKOUTOFORDE 38 X X X X X X X X
F_ORDER R
IC_NO_CALL_SUSPEN 27 TEMPORARYFAILURE 41 X X X X X X X X X X X X X X X X X
DED
IC_NO_ANSWER_ALE 28 NOANSWER 19 X X X X X X X X
RTED_USER
IC_NO_CIRCUIT_AVAI 29 NOCIRCUIT 34 X X X X X X X X
LABLE
IC_NON_SELECTED_U 30 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
SER_CLEARING
IC_NORMAL_CLEARIN 31 NORMALRELEASE 16 X X X X X X X X
G
IC_NORMAL_UNSPECI 32 NORMALUNSPECIFIED 31 X X X X X X
FIED
IC_NO_ROUTE_TO_DE 33 NOROUTETODEST 3 X X X X X X X
ST
IC_NO_ROUTE_TO_TN 34 NOROUTETOTRANSIT 2 X X X X X
S
IC_NO_USER_RESPON 35 NORESPONSE 18 X X X X X X X X
DING
IC_NUMBER_CHANGE 36 NUMBERCHANGED 22 X X X X X X X X
D
Table B-16 Internal Cause Code to Transmitted Q.761 Cause Code Mappings (continued)
Value
Value
Standard Q.761
Australian Q.761
Finnish Q.761
Japanese Q.761
Japanese ETS_300_356
Hong_Kong Q.761
Belgian Mobistar
Korean Q761
ETS_300_356 & NTT
ETS_300_356 Spanish
ETS_300_356_V3 & UK
Taiwan Q.761
German Q.761
Thailand Q.761
KPNPB Q.761
Swiss Q.761
China. Q.761
Internal Cause Code Transmitted Q.761 Cause
IC_ONLY_RESTRICT_D 37 RESTRICTDIGBEARER 70 X X X X X
IG_INFO_BEARER CAPONLY
IC_PROTOCOL_ERROR 38 PROTOCOLERRORUNSP 11 X X X X X X X X
_UNSPEC ECIFIED 1
IC_QUALITY_UNAVAIL 39 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X
IC_RECOVERY_ON_TI 40 TEMPORARYFAILURE 41 X X X X X X X X X X X
MER_EXPIRY
IC_REQ_CIRCUIT_UNA 41 CHANNELNOTAVAILAB 44 X X X X X X X X
VAIL LE
IC_REQ_FACILITY_NO 42 REQFACILITYNOTIMP 69 X X X X X X
T_IMP
IC_REQ_FACILITY_NO 42 SERVICENOTIMP 79 X X X X X X X X X X X X X X X
T_IMP
IC_REQ_FACILITY_NO 43 SERVICENOTAVAILABL 63 X X X X X X X X X X X X X X X X X
T_SUBSCR E
IC_RESOURCES_UNAV 44 RESOURCESUNAVAILA 47 X X X X X X X X
AIL_UNSPEC BLE
IC_RESPONSE_TO_STA 45 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
TUS_ENQUIRY
IC_SERVICE_OR_OPTI 46 SERVICENOTIMPLEME 79 X X X X X X X X
ON_NOT_IMP_UNSPEC NTED
IC_SERVICE_OR_OPTI 47 SERVICENOTAVAILABL 63 X X X X X X X X
ON_NOT_AVAIL E
IC_SUSPEND_EXIST_B 48 TEMPORARYFAILURE 41 X X X X X X X X X X X X X X X X X
UT_NOT_THIS_ID
IC_SWITCHING_EQUIP 49 SWITCHCONGESTION 42 X X X X X X X X
_CONGESTION
IC_TEMPORARY_FAIL 50 TEMPORARYFAILURE 41 X X X X X X X X
URE
IC_UNALLOCATED_NU 51 UNALLOCATEDNUMBE 1 X X X X X X X X
MBER R
IC_USER_BUSY 52 USERBUSY 17 X X X X X X X X
IC_OUTGOING_CALLS 53 OUTGOINGCALLSBAR 12 X X X X X X X X X X X X X X X X X
_BARRED_IN_CUG RED 5
IC_ACCESS_BARRED 54 NORMALRELEASE 16 X X X X X X X X X X X X X X X X X
Table B-16 Internal Cause Code to Transmitted Q.761 Cause Code Mappings (continued)
Value
Value
Standard Q.761
Australian Q.761
Finnish Q.761
Japanese Q.761
Japanese ETS_300_356
Hong_Kong Q.761
Belgian Mobistar
Korean Q761
ETS_300_356 & NTT
ETS_300_356 Spanish
ETS_300_356_V3 & UK
Taiwan Q.761
German Q.761
Thailand Q.761
KPNPB Q.761
Swiss Q.761
China. Q.761
Internal Cause Code Transmitted Q.761 Cause
IC_ACKNOWLEDGEME 55 NORMALRELEASE 16 X X X X X X X X X X X X X X X X X
NT
IC_ADDRESS_INCOMP 56 ADDRESSINCOMPLETE 28 X X X X X X X X X X X X X X X X X
LETE
IC_BUSY 57 USERBUSY 17 X X X X X X X X X X X X X X X X X
IC_CHANNEL_OUT_OF 58 NETWORKOUTOFORDE 38 X X X X X X X X X X X X X X X X X
_SERVICE R
IC_DTE_CONTROLLED 59 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
_NOT_READY
IC_CONGESTION 60 SWITCHCONGESTION 42 X X X X X X X X X X X X X X X X X
IC_CALL_TERMINATIO 61 NORMALRELEASE 16 X X X X X X X X X X X X X X X X X
N
IC_INCON_OUTGOING 62 INCONSISTENCY 12 X X X X X X X X X X X X X X X X X
_ACC_AND_SUB_CLAS 6
S
IC_INCOMING_CALLS 63 CALLREJECTED 21 X X X X X X X X X X X X X X X X X
_BARRED
IC_SERVICE_INCOMPA 64 SERVICENOTAVAILABL 63 X X X X X X X X X X X X X X X X X
TIBLE E
IC_MESSAGE_NOT_UN 65 PROTOCOLERRORUNSP 11 X X X X X X X X X X X X X X X X X
DERSTOOD ECIFIED 1
IC_NETWORK_ADDRE 66 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
SS_EXTENSION_ERRO
R
IC_NETWORK_TERMI 67 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
NATION
IC_NUMBER_UNOBTAI 68 UNALLOCATEDNUMBE 1 X X X X X X X X X X X X X X X X X
NABLE R
IC_PRIORITY_FORCED 69 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
_RELEASE
IC_REJECT 70 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
IC_ROUTE_OUT_OF_S 71 NETWORKOUTOFORDE 38 X X X X X X X X X X X X X X X X X
ERVICE R
IC_SUBSCRIBER_INCO 72 INCOMPATIBLEDEST 88 X X X X X X X X X X X X X X X X X
MPATIBLE
Table B-16 Internal Cause Code to Transmitted Q.761 Cause Code Mappings (continued)
Value
Value
Standard Q.761
Australian Q.761
Finnish Q.761
Japanese Q.761
Japanese ETS_300_356
Hong_Kong Q.761
Belgian Mobistar
Korean Q761
ETS_300_356 & NTT
ETS_300_356 Spanish
ETS_300_356_V3 & UK
Taiwan Q.761
German Q.761
Thailand Q.761
KPNPB Q.761
Swiss Q.761
China. Q.761
Internal Cause Code Transmitted Q.761 Cause
IC_SIGNAL_NOT_UND 73 PROTOCOLERRORUNSP 11 X X X X X X X X X X X X X X X X X
ERSTOOD ECIFIED 1
IC_SIGNAL_NOT_VALI 74 PROTOCOLERRORUNSP 11 X X X X X X X X X X X X X X X X
D ECIFIED 1
IC_SUBSCRIBER_OUT_ 75 DESTOUTOFORDER 27 X X X X X X X X X X X X X X X X X
OF_SERVICE
IC_SIGNALLING_SYST 76 INTERWORKINGUNSPE 12 X X X X X X X X X X X X X X X X X
EM_INCOMPATIBLE CIFIED 7
IC_SERVICE_TEMPOR 77 SERVICENOTAVAILABL 63 X X X X X X X X X X X X X X X X X
ARILY_UNAVAILABLE E
IC_SERVICE_UNAVAIL 78 SERVICENOTAVAILABL 63 X X X X X X X X X X X X X X X X X
ABLE E
IC_DTE_UNCONTROLL 79 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
ED_NOT_READY
IC_TRANSFERRED 80 (No Q.761 cause code X
listed)
IC_INCOMING_CALLS 81 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X
_BARRED_IN_CUG
IC_SPECIAL_INFORMA 82 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X
TION_TONE
IC_SPECIAL_INFORMA 82 SENDSIT 4 X X X X
TION_TONE
IC_USER_NOT_MEMBE 83 CALLREJECTED 21 X X X X X X X X X X X X X X X X X
R_OF_CUG
IC_USER_NOT_MEMBE 83 USERNOTMEMBEROFC 87 X X
R_OF_CUG UG
IC_MISDIALLED_TK_P 84 MISDIALEDTRUNKPRE 5 X X X X X X X X
REFIX FIX
IC_PARAM_UNREC_PA 85 PARAMETERUNRECPAS 10 X X X X X X
SSED SED 3
IC_PARAM_UNREC_PA 85 PROTOCOLERRORUNSP 11 X
SSED ECIFIED 1
IC_PROPRIETARY 86 NORMALRELEASE 16 X X X X X X X X X X X X X X X X X
IC_PREEMPTION 87 NORMALUNSPECIFIED 31 X X X X X X X X X X X
Table B-16 Internal Cause Code to Transmitted Q.761 Cause Code Mappings (continued)
Value
Value
Standard Q.761
Australian Q.761
Finnish Q.761
Japanese Q.761
Japanese ETS_300_356
Hong_Kong Q.761
Belgian Mobistar
Korean Q761
ETS_300_356 & NTT
ETS_300_356 Spanish
ETS_300_356_V3 & UK
Taiwan Q.761
German Q.761
Thailand Q.761
KPNPB Q.761
Swiss Q.761
China. Q.761
Internal Cause Code Transmitted Q.761 Cause
IC_PREEMPTION_CCT_ 88 NOCIRCUIT 34 X X X X X X X X X X X
UNAVAILABLE
IC_UNALLOCATED_DE 89 UNALLOCATEDNUMBE 1 X X X X X X X X
ST_NUMBER R
IC_UNREC_ELEM_PAS 90 PARAMETERUNRECPAS 10 X X X X X X X X X X X X X X X
SED_ON SED 3
IC_NON_EXISTEND_C 90 NONEXISTENTCUG 12 X X X X X X X X X X X X X X X X X
UG 7
IC_SUB_ABSENT 91 NORESPONSE 18 X X X X X X X X X X X
IC_UNDEFINED_BG 92 UNALLOCATEDNUMBE 1 X X X X X X X X X X X X X X X X X
R
IC_ROUTING_ERROR 93 NOROUTETODESTINAT 3 X X X X X X X X X X X X X X X X
ION
IC_PRECEDENCE_BLO 94 NOROUTETODESTINAT 3 X X X X X X X X X X X
CKED ION
IC_CALL_TYPE_INCO 95 CALLREJECTED 21 X X X X X X X X X X X X X X X X X
MPATIBLE
IC_GROUP_RESTRICTI 96 CALLREJECTED 21 X X X X X X X X X X X X X X X X X
ONS
IC_CALLING_PARTY_O 97 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X
FF_HOLD
IC_CALLING_DROPPE 98 NORMALRELEASE 16 X X X X X X X X X X X X X X X X X
D_WHILE_ON_HOLD
IC_NEW_DESTINATIO 99 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
N
IC_OUTGOING_CALLS 100 CALLREJECTED 21 X X X X X X X X X X X X X X X X X
_BARRED
IC_SUB_CONTROLLED 101 CALLREJECTED 21 X X X X X X X X X X X X X X X X X
_ICB
IC_CALL_REJECT_CAL 102 CALLREJECTED 21 X X X X X X X X X X X X X X X X X
L_GAPPING
IC_REJECTED_DIVERT 103 CALLREJECTED 21 X X X X X X X X X X X X X X X X X
ED_CALL
IC_SELECTIVE_CALL_ 104 CALLREJECTED 21 X X X X X X X X X X X X X X X X X
BARRING
Table B-16 Internal Cause Code to Transmitted Q.761 Cause Code Mappings (continued)
Value
Value
Standard Q.761
Australian Q.761
Finnish Q.761
Japanese Q.761
Japanese ETS_300_356
Hong_Kong Q.761
Belgian Mobistar
Korean Q761
ETS_300_356 & NTT
ETS_300_356 Spanish
ETS_300_356_V3 & UK
Taiwan Q.761
German Q.761
Thailand Q.761
KPNPB Q.761
Swiss Q.761
China. Q.761
Internal Cause Code Transmitted Q.761 Cause
IC_REMOTE_PROC_ER 105 TEMPORARYFAILURE 41 X X X X X X X X X X X X X X X X X
ROR
IC 106 UNALLOCATEDNUMBE 1 X X X X X X X X X X X X X X X X X
R
IC_OPERATOR_PRIORI 107 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
TY_ACCESS
IC_CUG_ACCESS_BAR 108 CALLREJECTED 21 X X X X X X X X X X X X X X
RED
IC_CUG_ACCESS_BAR 108 USERNOTMEMOFCUG 87 X X X
RED
IC_SUBSCRIBER_CALL 109 NORMALRELEASE 16 X X X X X X X X X X X X X X X X X
_TERMINATE
IC_FLOW_CONTROLLE 110 SWITCHCONGESTION 42 X X X X X X X X X X X X X X X X
D_CONGESTION
IC_OUT_OF_CATCHME 111 NORESPONSE 18 X X X X X X X X X X X X X X X X X
NT_AREA
IC_TRANSLATION_OO 112 UNALLOCATEDNUMBE 1 X X X X X X X X X X X X X X X X X
S R
IC_PERMANENT_ICB 113 CALLREJECTED 21 X X X X X X X X X X X X X X X X X
IC_SUBSCRIBER_MOV 114 NORESPONSE 18 X X X X X X X X X X X
ED
IC_SUBSCRIBER_MOV 114 SUBSCRIBERABSENT 20 X X X X X X
ED
IC_SUB_NOT_FOUND_ 115 UNALLOCATEDNUMBE 1 X X X X X X X X X X X X X X X X X
DLE R
IC_ANONYMOUS_CAL 116 CALLREJECTED 21 X X X X X X X X X X X X X X X X X
L_REJECTION
IC_TERMINAL_CONGE 117 SWITCHCONGESTION 42 X X X X X X X X X X X X X X X X
STION
IC_REPEAT_ATTEMPT 118 (No Q.761 cause code
listed)
IC_VACENT_CODE 119 UNALLOCATEDNUMBE 1 X X X X X X X X X X X X X X X X X
R
IC_PREFIX_0_DIALLE 120 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
D_IN_ERROR
Table B-16 Internal Cause Code to Transmitted Q.761 Cause Code Mappings (continued)
Value
Value
Standard Q.761
Australian Q.761
Finnish Q.761
Japanese Q.761
Japanese ETS_300_356
Hong_Kong Q.761
Belgian Mobistar
Korean Q761
ETS_300_356 & NTT
ETS_300_356 Spanish
ETS_300_356_V3 & UK
Taiwan Q.761
German Q.761
Thailand Q.761
KPNPB Q.761
Swiss Q.761
China. Q.761
Internal Cause Code Transmitted Q.761 Cause
IC_PREFIX_1_DIALLE 121 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
D_IN_ERROR
IC_PREFIX_1_NOT_DI 122 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
ALLED
IC_EXCESSIVE_DIG_C 123 NORMALUNSPECIFIED 31 X X X X X X X X X X X X X X X X X
ALL_PROCEEDING
IC_PROT_ERR_THRES 124 PROTOCOLERRORUNSP 11 X X X X X X X X X X X X X X X X X
HOLD_EXCEEDED ECIFIED 1
IC_OUTGOING_CALLS 125 CALLREJECTED 21 X X X X X X X X X X X
_BARRED_IN_CUG
IC_INCON_OUTGOING 126 INTERWORKINGUNSPE 12 X X X X X X X X X X X
_ACC_AND_SUB_CLAS CIFIED 7
S
IC_INCON_OUTGOING 126 INCON_OUT_ACC_SUB 62 X
_ACC_AND_SUB_CLAS
S
IC_NON_EXISTENT_C 127 CALLREJECTED 21 X X X X X X X X X X X
UG
IC_MSG_WITH_UNREC 128 MSGUNRECELEMDISC 11 X X X X X X
_ELEM_DISCARDED ARDED 0
IC_MSG_WITH_UNREC 128 PROTOCOLERRORUNSP 11 X
_ELEM_DISCARDED ECFIED 1
IC_PREEMPTION_CCT_ 129 NORMALUNSPECIFIED 31 X X X X X X X X X X
RES
IC_PREEMPTION_CCT_ 129 PREEMPTION 8 X X X X X X
RES
IC_PERMANENT_FRA 130 (No Q.761 cause code
ME_MODE_OOS listed)
IC_PERMANENT_FRA 131 (No Q.761 cause code
ME_MODE_OPERATIO listed)
NAL
IC_BLACKLIST_NO_CL 132 (No Q.761 cause code
I listed)
IC_BLACKLIST_CLI_L 133 (No Q.761 cause code
ENGTH_INVALID listed)
Table B-16 Internal Cause Code to Transmitted Q.761 Cause Code Mappings (continued)
Value
Value
Standard Q.761
Australian Q.761
Finnish Q.761
Japanese Q.761
Japanese ETS_300_356
Hong_Kong Q.761
Belgian Mobistar
Korean Q761
ETS_300_356 & NTT
ETS_300_356 Spanish
ETS_300_356_V3 & UK
Taiwan Q.761
German Q.761
Thailand Q.761
KPNPB Q.761
Swiss Q.761
China. Q.761
Internal Cause Code Transmitted Q.761 Cause
IC_BLACKLIST_CLI_M 134 (No Q.761 cause code
ATCHED listed)
IC_BLACKLIST_CPC_R 135 (No Q.761 cause code
ESTRICTED listed)
IC_BLACKLIST_NOA_ 136 (No Q.761 cause code
RESTRICTED listed)
IC_BLACKLIST_BNUM 137 (No Q.761 cause code
BER_MATCHED listed)
IC_WHITELIST_CLI_N 138 (No Q.761 cause code
OT_MATCHED listed)
IC_PORTED_NUMBER 139 (No Q.761 cause code
listed)
IC_REDIRECTION_TO_ 140 (No Q.761 cause code
NEW_DEST listed)
IC_COT_FAILURE 141 (No Q.761 cause code
listed)
IC_MISROUTED_CALL 142 (No Q.761 cause code
_PORTED_NUM listed)
IC_INVALID_CALL_RE 143 (No Q.761 cause code
F listed)
IC_UNKNOWN 147 (No Q.761 cause code
listed)
IC_RE_ANALYSIS_REQ 145 (No Q.761 cause code
UESTED listed)
IC_REJECTED_BY_FEA 169 (No Q.761 cause code 24 X
TURE listed)
IC_BAD_REQUEST 177 INTERWORKINGUNSPE 12
CIFIED 7
IC_UNAUTHORIZED 178 INTERWORKINGUNSPE 12
CIFIED 7
IC_PAYMENT_REQUIR 179 INTERWORKINGUNSPE 12
ED CIFIED 7
IC_FORBIDDEN 180 INTERWORKINGUNSPE 12
CIFIED 7
IC_METHOD_NOT_ALL 181 INTERWORKINGUNSPE 12
OWED CIFIED 7
Table B-16 Internal Cause Code to Transmitted Q.761 Cause Code Mappings (continued)
Value
Value
Standard Q.761
Australian Q.761
Finnish Q.761
Japanese Q.761
Japanese ETS_300_356
Hong_Kong Q.761
Belgian Mobistar
Korean Q761
ETS_300_356 & NTT
ETS_300_356 Spanish
ETS_300_356_V3 & UK
Taiwan Q.761
German Q.761
Thailand Q.761
KPNPB Q.761
Swiss Q.761
China. Q.761
Internal Cause Code Transmitted Q.761 Cause
IC_NOT_ACCEPTABLE 182 INTERWORKINGUNSPE 12
CIFIED 7
IC_PROXY_AUTHEN_R 183 INTERWORKINGUNSPE 12
EQUIRED CIFIED 7
IC_REQUEST_TIMEOU 184 INTERWORKINGUNSPE 12
T CIFIED 7
IC_CONFLICT 185 INTERWORKINGUNSPE 12
CIFIED 7
IC_LENGTH_REQUIRE 186 INTERWORKINGUNSPE 12
D CIFIED 7
IC_ENTITY_TOO_LON 187 INTERWORKINGUNSPE 12
G CIFIED 7
IC_URI_TOO_LONG 188 INTERWORKINGUNSPE 12
CIFIED 7
IC_UNSUPPORTED_ME 189 INTERWORKINGUNSPE 12
DIA_TYPE CIFIED 7
IC_UNSUPPORTED_UR 190 INTERWORKINGUNSPE 12
I_SCHEME CIFIED 7
IC_BAD_EXTENSION 191 INTERWORKINGUNSPE 12
CIFIED 7
IC_EXTENSION_REQUI 192 INTERWORKINGUNSPE 12
RED CIFIED 7
IC_SESSION_INTERVA 193 INTERWORKINGUNSPE 12
L_TOO_SMALL CIFIED 7
IC_INTERVAL_TOO_BR 194 INTERWORKINGUNSPE 12
IEF CIFIED 7
IC_ANONYMITY_DISA 195 INTERWORKINGUNSPE 12
LLOWED CIFIED 7
IC_TEMP_NOT_AVAIL 196 SUBSCRIBERABSENT 20
ABLE
IC_LEG_OR_TRANSAC 197 INTERWORKINGUNSPE 12
TION_NOT_EXIST CIFIED 7
IC_LOOP_DETECTED 198 INTERWORKINGUNSPE 12
CIFIED 7
IC_TOO_MANY_HOPS 199 INTERWORKINGUNSPE 12
CIFIED 7
Table B-16 Internal Cause Code to Transmitted Q.761 Cause Code Mappings (continued)
Value
Value
Standard Q.761
Australian Q.761
Finnish Q.761
Japanese Q.761
Japanese ETS_300_356
Hong_Kong Q.761
Belgian Mobistar
Korean Q761
ETS_300_356 & NTT
ETS_300_356 Spanish
ETS_300_356_V3 & UK
Taiwan Q.761
German Q.761
Thailand Q.761
KPNPB Q.761
Swiss Q.761
China. Q.761
Internal Cause Code Transmitted Q.761 Cause
IC_AMBIGUOUS 200 INTERWORKINGUNSPE 12
CIFIED 7
IC_REQUEST_TERMIN 201 INTERWORKINGUNSPE 12
ATED CIFIED 7
IC_NOT_ACCEPT_HER 202 INTERWORKINGUNSPE 12
E CIFIED 7
IC_BAD_EVENT 203 INTERWORKINGUNSPE 12
CIFIED 7
IC_REQUEST_PENDIN 204 INTERWORKINGUNSPE 12
G CIFIED 7
IC_UNDECIPHERABLE 205 INTERWORKINGUNSPE 12
CIFIED 7
IC_SERVER_INTERNAL 206 INTERWORKINGUNSPE 12
_ERROR CIFIED 7
IC_NOT_IMPLEMENTE 207 INTERWORKINGUNSPE 12
D CIFIED 7
IC_BAD_GATEWAY 208 INTERWORKINGUNSPE 12
CIFIED 7
IC_SERVICE_UNAVAIL 209 INTERWORKINGUNSPE 12
CIFIED 7
IC_SERVER_TIMEOUT 210 INTERWORKINGUNSPE 12
CIFIED 7
IC_VERSION_NOT_SUP 211 INTERWORKINGUNSPE 12
PORT CIFIED 7
IC_MSG_TOO_LARGE 212 INTERWORKINGUNSPE 12
CIFIED 7
IC_PRECONDITION_FA 213 INTERWORKINGUNSPE 12
ILURE CIFIED 7
IC_DECLINE 214 CALLREJECTED 21
IC_NOT_EXIST_ANYW 215 UNALLOCATEDNUMBE 1
HERE R
IC_NOT_ACCEPTABLE 216 INTERWORKINGUNSPE 12
_606 CIFIED 7
IC_MULTIPLE_CHOICE 217 NORMALUNSPECIFIED 31
S
Table B-16 Internal Cause Code to Transmitted Q.761 Cause Code Mappings (continued)
Value
Value
Standard Q.761
Australian Q.761
Finnish Q.761
Japanese Q.761
Japanese ETS_300_356
Hong_Kong Q.761
Belgian Mobistar
Korean Q761
ETS_300_356 & NTT
ETS_300_356 Spanish
ETS_300_356_V3 & UK
Taiwan Q.761
German Q.761
Thailand Q.761
KPNPB Q.761
Swiss Q.761
China. Q.761
Internal Cause Code Transmitted Q.761 Cause
IC_MOVED_PERMANE 218 NORMALUNSPECIFIED 31
NTLY
IC_USE_PROXY 219 NORMALUNSPECIFIED 31
IC_ALTERNATIVE_SER 220 NORMALUNSPECIFIED 31
VICE
IC_SIP_CALL_SETUP_ 221 NORESPONSE 18 X X X X X X X X
TIMEOUT
Q761_Portugal protocol supports release with external cause 14 (mapped internally to Query On Release
failure) - 164.
Table B-17 describes the mapping between internal cause codes and transmitted Q.767 cause codes. For
definitions of the Q.761 cause code values see Q.850, section 2.2.7.
Note If there is no transmitted Q.761 cause code value mapped to the internal cause code, the PGW transmits
the Q.761 cause code value NormalUnspecified (31).
Colombian
Other ETSI
ANSI Ibn7
ANSI SS7
Bell 1268
Spanish
Russian
ATT PRI
BTNUP
Italian
ETSI 2
Value
Value
Colombian
Other ETSI
ANSI Ibn7
ANSI SS7
Bell 1268
Spanish
Russian
ATT PRI
BTNUP
Italian
ETSI 2
Value
Value
Transmitted Q.767 Cause
Internal Cause Code Code
IC_CH_UNACCEPTABLE 11 Temporary failure 41 x
IC_DEST_OUT_OF_ORDER 12 Destination out of order 27 x
IC_ELEM_TYPE_NOT_IMP 13 Protocol error, unspecified 11 x
1
IC_FACILITY_REJECTED 14 Address incomplete 28 x
IC_INCOMPATIBLE_DEST 15 Incompatible destination 88 x
IC_INTERWORK_UNSPEC 16 Interworking, unspecified 12 x
7
IC_INVALID_CALL_REFER 17 Temporary failure 41 x x
ENCE_VALU
IC_INVALID_ELEM_CONT 18 Protocol error, unspecified 11 x
ENTS 1
IC_INVALID_MSG_UNSPE 19 Invalid message, unspecified 95 x
C
IC_INVALID_NUMBER_FO 20 Address incomplete 28 x x
RMAT
IC_INVALID_TNS 21 No route to destination 2 x
IC_INVALID_TNS 21 Invalid message, unspecified 95 x
IC_MANDATORY_ELEMEN 22 Protocol error, unspecified 11 x x
T_MISSING 1
IC_MSG_IN_WRONG_STAT 23 Protocol error, unspecified 11 x x
E 1
IC_MSG_TYPE_NOT_IMP 24 Protocol error, unspecified 11 x
1
IC_MSG_TYPE_NOT_IMP_ 25 Protocol error, unspecified 11 x
OR_WRONG_STATE 1
IC_NETWORK_OUT_OF_O 26 Network out of order 38 x x
RDER
IC_NO_CALL_SUSPENDED 27 Temporary failure 41 x
IC_NO_ANSWER_ALERTE 28 User alerting no answer 19 x
D_USER
IC_NO_CIRCUIT_AVAILAB 29 No circuit available 34 x
LE
Colombian
Other ETSI
ANSI Ibn7
ANSI SS7
Bell 1268
Spanish
Russian
ATT PRI
BTNUP
Italian
ETSI 2
Value
Value
Transmitted Q.767 Cause
Internal Cause Code Code
IC_NON_SELECTED_USER 30 Normal, unspecified 31 x
_CLEARING
IC_NORMAL_CLEARING 31 Normal call clearing 16 x
IC_NORMAL_UNSPECIFIE 32 Normal, unspecified 31 x x
D
IC_NO_ROUTE_TO_DEST 33 No route to destination 2 x
IC_NO_ROUTE_TO_TNS 34 No route to destination 2 x x
IC_NO_USER_RESPONDIN 35 No user responding 18 x
G
IC_NUMBER_CHANGED 36 Number changed 22 x
IC_ONLY_RESTRICT_DIG_ 37 Bearer capability not 58 x
INFO_BEARER presently available
IC_ONLY_RESTRICT_DIG_ 37 Service/option not 79 x
INFO_BEARER implemented, unspecified
IC_PROTOCOL_ERROR_U 38 Message does not exist 97 x
NSPEC
IC_PROTOCOL_ERROR_U 38 Protocol error, not used 97 x x
NSPEC
IC_PROTOCOL_ERROR_U 38 Element unrecognized, 99 x x
NSPEC discarded
IC_PROTOCOL_ERROR_U 38 Parameter unrecognized, 10 x
NSPEC passed 3
IC_PROTOCOL_ERROR_U 38 Protocol error, unspecified 11 x x x
NSPEC 1
IC_QUALITY_UNAVAIL 39 Normal, unspecified 31 x
IC_RECOVERY_ON_TIMER 40 Recovery on timer expiry 10 x
_EXPIRY 2
IC_REQ_CIRCUIT_UNAVAI 41 Q.931 (requested channel 44 x x
L not available)
IC_REQ_FACILITY_NOT_I 42 Service/option not 79 x
MP implemented, unspecified
IC_REQ_FACILITY_NOT_S 43 Required facility not 50 x
UBSCR subscribed
Colombian
Other ETSI
ANSI Ibn7
ANSI SS7
Bell 1268
Spanish
Russian
ATT PRI
BTNUP
Italian
ETSI 2
Value
Value
Transmitted Q.767 Cause
Internal Cause Code Code
IC_REQ_FACILITY_NOT_S 43 Service/option not available, 63 x
UBSCR unspecified
IC_RESOURCES_UNAVAIL 44 Resource unavailable, 47 x
_UNSPEC unspecified.
IC_RESPONSE_TO_STATU 45 Normal, unspecified 31 x
S_ENQUIRY
IC_SERVICE_OR_OPTION_ 46 Service/option not 79 x
NOT_IMP_UNSPEC implemented, unspecified
IC_SERVICE_OR_OPTION_ 47 Service/option not available, 63 x
NOT_AVAIL unspecified
IC_SUSPEND_EXIST_BUT_ 48 Temporary failure 41 x
NOT_THIS_ID
IC_SWITCHING_EQUIP_C 49 Switching equipment 42 x
ONGESTION congestion
IC_TEMPORARY_FAILURE 50 Temporary failure 41 x
IC_UNALLOCATED_NUMB 51 Unallocated Number 1 x
ER
IC_USER_BUSY 52 User busy 17 x
IC_ACCESS_BARRED 54 Call rejected 21 x
IC_ACKNOWLEDGEMENT 55 Normal call clearing 16 x
IC_ADDRESS_INCOMPLET 56 Address incomplete 28 x
E
IC_BUSY 57 User busy 17 x
IC_CHANNEL_OUT_OF_SE 58 Network out of order 38 x
RVICE
IC_DTE_CONTROLLED_N 59 Normal, unspecified 31 x x
OT_READY
IC_CONGESTION 60 Switching equipment 42 x
congestion
IC_CALL_TERMINATION 61 Normal call clearing 16 x
IC_FACILITY_NOT_REGIS 62 Address incomplete 28 x
TERED
Colombian
Other ETSI
ANSI Ibn7
ANSI SS7
Bell 1268
Spanish
Russian
ATT PRI
BTNUP
Italian
ETSI 2
Value
Value
Transmitted Q.767 Cause
Internal Cause Code Code
IC_INCOMING_CALLS_BA 63 Call rejected 21 x
RRED
IC_SERVICE_INCOMPATIB 64 Service/option not available, 63 x
LE unspecified
IC_MESSAGE_NOT_UNDE 65 Protocol error, unspecified 11 x
RSTOOD 1
IC_NETWORK_ADDRESS_ 66 Normal, unspecified 31 x
EXTENSION_ERROR
IC_NETWORK_TERMINATI 67 Normal, unspecified 31 x
ON
IC_NUMBER_UNOBTAINA 68 Unallocated Number 1 x
BLE
IC_PRIORITY_FORCED_R 69 Normal, unspecified 31 x
ELEASE
IC_REJECT 70 Address incomplete 28 x
IC_ROUTE_OUT_OF_SERV 71 Network out of order 38 x x
ICE
IC_SUBSCRIBER_INCOMP 72 Incompatible destination 88 x
ATIBLE
IC_SIGNAL_NOT_UNDERS 73 Protocol error, unspecified 11 x
TOOD 1
IC_SIGNAL_NOT_VALID 74 Protocol error, unspecified 11 x x
1
IC_SUBSCRIBER_OUT_OF 75 Destination out of order 27 x
_SERVICE
IC_SIGNALLING_SYSTEM 76 Interworking, unspecified 12 x
_INCOMPATIBLE 7
IC_SERVICE_TEMPORARI 77 Service/option not available, 63 x
LY_UNAVAILABLE unspecified
IC_SERVICE_UNAVAILAB 78 Service/option not available, 63 x
LE unspecified
IC_DTE_UNCONTROLLED 79 Normal, unspecified 31 x
_NOT_READY
Colombian
Other ETSI
ANSI Ibn7
ANSI SS7
Bell 1268
Spanish
Russian
ATT PRI
BTNUP
Italian
ETSI 2
Value
Value
Transmitted Q.767 Cause
Internal Cause Code Code
IC_INCOMING_CALLS_BA 81 Incoming calls barred within 55 x
RRED_IN_CUG CUG
IC_SPECIAL_INFORMATIO 82 Send special information 4 x
N_TONE tone
IC_USER_NOT_MEMBER_ 83 User not member of CUG 87 x
OF_CUG
IC_MISDIALLED_TK_PRE 84 Unallocated Number 1 x x
FIX
IC_MISDIALLED_TK_PRE 84 Normal, unspecified 31 x
FIX
IC_PARAM_UNREC_PASSE 85 Protocol error, unspecified 11 x
D 1
IC_PROPRIETARY 86 Normal, unspecified 31 x
IC_PREEMPTION 87 Normal, unspecified 31 x x
IC_PREEMPTION_CCT_UN 88 No circuit available 34 x
AVAILABLE
IC_UNREC_ELEM_PASSED 90 Invalid message, unspecified 95 x x
_ON
IC_SUB_ABSCENT 91 No user responding 18 x x
IC_SUB_ABSCENT 91 Sub Absent 20 x
IC_UNDEFINED_BG 92 Unallocated Number 1 x
IC_ROUTING_ERROR 93 No route to destination 2 x
IC_PRECEDENCE_BLOCK 94 No route to destination 2 x
ED
IC_CALL_TYPE_INCOMPA 95 Interworking, unspecified 12 x
TIBLE 7
IC_GROUP_RESTRICIONS 96 Normal, unspecified 31 x
IC_CALLING_PARTY_OFF 97 Normal, unspecified 31 x
_HOLD
IC_CALLING_DROPPED_ 98 Normal, unspecified 31 x
WHILE_ON_HOLD
IC_NEW_DESTINATION 99 Normal, unspecified 31 x
Colombian
Other ETSI
ANSI Ibn7
ANSI SS7
Bell 1268
Spanish
Russian
ATT PRI
BTNUP
Italian
ETSI 2
Value
Value
Transmitted Q.767 Cause
Internal Cause Code Code
IC_SUB_CONTROLLED_IC 10 Call rejected 21 x
B 1
IC_CALL_REJECT_CALL_ 10 Call rejected 21 x
GAPPING 2
IC_REJECTED_DIVERTED 10 Call rejected 21 x
_CALL 3
IC_SELECTIVE_CALL_BA 10 Call rejected 21 x
RRING 4
IC_REMOTE_PROC_ERRO 10 Interworking, unspecified 12 x
R 5 7
IC_TEMPORARY_OOS 10 Unallocated Number 1 x
6
IC_OPERATOR_PRIORITY_ 10 Normal, unspecified 31 x
ACCESS 7
IC_CUG_ACCESS_BARRE 10 User not member of CUG 87 x
D 8
IC_SUBSCRIBER_CALL_T 10 Normal call clearing 16 x
ERMINATE 9
IC_FLOW_CONTROLLED_ 11 Switching equipment 42 x
CONGESTION 0 congestion
IC_OUT_OF_CATCHMENT 11 Normal, unspecified 31 x
_AREA 1
IC_TRANSLATION_OOS 11 Normal, unspecified 31 x
2
IC_PERMANENT_ICB 11 Call rejected 21 x
3
IC_SUBSCRIBER_MOVED 11 Normal, unspecified 31 x
4
IC_SUB_NOT_FOUND_DL 11 Normal, unspecified 31 x
E 5
IC_ANONYMOUS_CALL_R 11 Call rejected 21 x
EJECTION 6
IC_TERMINAL_CONGESTI 11 Switching equipment 42 x
ON 7 congestion
Colombian
Other ETSI
ANSI Ibn7
ANSI SS7
Bell 1268
Spanish
Russian
ATT PRI
BTNUP
Italian
ETSI 2
Value
Value
Transmitted Q.767 Cause
Internal Cause Code Code
IC_REPEAT_ATTEMPT 11 Switching equipment 42 x
8 congestion
IC_VACANT_CODE 11 Unallocated Number 1 x
9
IC_PREFIX_0_DIALLED_I 12 Unallocated Number 1 x
N_ERROR 0
IC_PREFIX_1_NOT_DIALL 12 Unallocated Number 1 x
ED 2
IC_EXCESSIVE_DIG_CALL 12 Normal, unspecified 31 x
_PROCEEDING 3
IC_PROT_ERR_THRESHOL 12 Protocol error, unspecified 11 x
D_EXCEEDED 4 1
IC_OUTGOING_CALLS_BA 12 Call rejected 21 x
RRED_IN_CUG 5
IC_INCON_OUTGOING_AC 12 Normal, unspecified 31 x
C_AND_SUB_CLASS 6
IC_NON_EXISTENT_CUG 12 User not member of CUG 87 x
7
IC_CAUSE_VAL_005 14 Normal event not used 5 x
6
IC_NP_QOR_NUM_NOT_F 16 Disconnect 14 x x
OUND 4
IC_BAD_REQUEST 17 Interworking, unspecified 12 x
7 7
IC_UNAUTHORIZED 17 Interworking, unspecified 12 x
8 7
IC_PAYMENT_REQUIRED 17 Interworking, unspecified 12 x
9 7
IC_FORBIDDEN 18 Interworking, unspecified 12 x
0 7
IC_METHOD_NOT_ALLO 18 Interworking, unspecified 12 x
WED 1 7
IC_PROXY_AUTHEN_REQ 18 Interworking, unspecified 12 x
UIRED 3 7
Colombian
Other ETSI
ANSI Ibn7
ANSI SS7
Bell 1268
Spanish
Russian
ATT PRI
BTNUP
Italian
ETSI 2
Value
Value
Transmitted Q.767 Cause
Internal Cause Code Code
IC_REQUEST_TIMEOUT 18 Interworking, unspecified 12 x
4 7
IC_CONFLICT 18 Interworking, unspecified 12 x
5 7
IC_LENGTH_REQUIRED 18 Interworking, unspecified 12 x
6 7
IC_ENTITY_TOO_LONG 18 Interworking, unspecified 12 x
7 7
IC_URI_TOO_LONG 18 Interworking, unspecified 12 x
8 7
IC_UNSUPPORTED_MEDI 18 Interworking, unspecified 12 x
A_TYPE 9 7
IC_UNSUPPORTED_URI_S 19 Interworking, unspecified 12 x
CHEME 0 7
IC_BAD_EXTENSION 19 Interworking, unspecified 12 x
1 7
IC_EXTENSION_REQUIRE 19 Interworking, unspecified 12 x
D 2 7
IC_SESSION_INTERVAL_T 19 Interworking, unspecified 12 x
OO_SMALL 3 7
IC_INTERVAL_TOO_BRIEF 19 Interworking, unspecified 12 x
4 7
IC_ANONYMITY_DISALL 19 Interworking, unspecified 12 x
OWED 5 7
IC_TEMP_NOT_AVAILABL 19 Sub absent 20 x
E 6
IC_LEG_OR_TRANSACTIO 19 Interworking, unspecified 12 x
N_NOT_EXIST 7 7
IC_LOOP_DETECTED 19 Interworking, unspecified 12 x
8 7
IC_TOO_MANY_HOPS 19 Interworking, unspecified 12 x
9 7
IC_AMBIGUOUS 20 Interworking, unspecified 12 x
0 7
Colombian
Other ETSI
ANSI Ibn7
ANSI SS7
Bell 1268
Spanish
Russian
ATT PRI
BTNUP
Italian
ETSI 2
Value
Value
Transmitted Q.767 Cause
Internal Cause Code Code
IC_REQUEST_TERMINATE 20 Interworking, unspecified 12 x
D 1 7
IC_NOT_ACCEPT_HERE 20 Interworking, unspecified 12 x
2 7
IC_BAD_EVENT 20 Interworking, unspecified 12 x
3 7
IC_REQUEST_PENDING 20 Interworking, unspecified 12 x
4 7
IC_UNDECIPHERABLE 20 Interworking, unspecified 12 x
5 7
IC_SERVER_INTERNAL_E 20 Interworking, unspecified 12 x
RROR 6 7
IC_NOT_IMPLEMENTED 20 Interworking, unspecified 12 x
7 7
IC_BAD_GATEWAY 20 Interworking, unspecified 12 x
8 7
IC_SERVICE_UNAVAIL 20 Interworking, unspecified 12 x
9 7
IC_SERVER_TIMEOUT 21 Interworking, unspecified 12 x
0 7
IC_VERSION_NOT_SUPPO 21 Interworking, unspecified 12 x
RT 1 7
IC_MSG_TOO_LARGE 21 Interworking, unspecified 12 x
2 7
IC_PRECONDITION_FAILU 21 Interworking, unspecified 12 x
RE 3 7
IC_DECLINE 21 Call rejected 21 x
4
IC_NOT_EXIST_ANYWHE 21 Unallocated number 1 x
RE 5
IC_NOT_ACCEPTABLE_60 21 Interworking, unspecified 12 x
6 6 7
IC_MULTIPLE_CHOICES 21 Normal, unspecified 31 x
7
Colombian
Other ETSI
ANSI Ibn7
ANSI SS7
Bell 1268
Spanish
Russian
ATT PRI
BTNUP
Italian
ETSI 2
Value
Value
Transmitted Q.767 Cause
Internal Cause Code Code
IC_MOVED_PERMANENTL 21 Normal, unspecified 31 x
Y 8
IC_USE_PROXY 21 Normal, unspecified 31 x
9
IC_ALTERNATIVE_SERVIC 22 Normal, unspecified 31 x
E 0
IC_SIP_CALL_SETUP_TIM 22 No user responding 18 x
EOUT 1
Table B-19 Received ANSI SS7 Cause Code to Internal Cause Code Mappings
Received ANSI SS7 Cause Code Value Internal Cause Code Value
UNALLOCATED_NUM 1 IC_UNALLOCATED_NUMBER 51
NO_ROUTE_TO_TRANSIT 2 IC_NO_ROUTE_TO_TNS 34
NO_ROUTE_TO_DEST 3 IC_NO_ROUTE_TO_DEST 33
SEND_SIT 4 IC_SPECIAL_INFORMATION_TONE 81
MISDIALLED_TRUNK_PREFIX 5 IC_NORMAL_UNSPECIFIED 32
PREEMPTION 8 IC_PREEMPTION 86
NORMAL_REL 16 IC_NORMAL_CLEARING 31
USER_BUSY 17 IC_USER_BUSY 52
NO_RESPONSE 18 IC_NO_USER_RESPONDING 35
NO_ANSWER 19 IC_NO_ANSWER_ALERTED_USER 28
Table B-19 Received ANSI SS7 Cause Code to Internal Cause Code Mappings (continued)
Received ANSI SS7 Cause Code Value Internal Cause Code Value
SUB_ABSCENT 20 IC_SUB_ABSCENT 90
CALL_REJECTED 21 IC_CALL_REJECTED 8
NUMBER_CHANGED 22 IC_NUMBER_CHANGED 36
DEST_OOO 27 IC_DEST_OUT_OF_ORDER 12
ADDRESS_INCOMP 28 IC_ADDRESS_INCOMPLETE 55
FAC_REJECTED 29 IC_FACILITY_REJECTED 14
NORMAL_UNSPEC 31 IC_NORMAL_UNSPECIFIED 32
NO_CIRCUIT 34 IC_NO_CIRCUIT_AVAILABLE 29
NETWORK_OOO 38 IC_NETWORK_OUT_OF_ORDER 26
TEMP_FAILURE 41 IC_TEMPORARY_FAILURE 50
SWITCH_CONG 42 IC_SWITCHING_EQUIP_CONGESTION 49
ACCESS_INFO_DISCARD 43 IC_ACCESS_INFO_DISCARDED 1
CHAN_NOT_AVAIL 44 IC_REQ_CIRCUIT_UNAVAIL 41
PRECEDENCE_BLOCKED 46 IC_PRECEDENCE_BLOCKED 93
RES_UNAVAIL 47 IC_RESOURCES_UNAVAIL_UNSPEC 44
FACILITY_NOT_SUBSC 50 IC_REQ_FACILITY_NOT_SUBSCR 43
OUT_CALLS_BARRED 53 IC_SERVICE_OR_OPTION_NOT_AVAIL 47
IN_CALLS_BARRED 55 IC_SERVICE_OR_OPTION_NOT_AVAIL 47
BC_NOT_AUTH 57 IC_BEARCAP_NOT_AUTHORIZED 2
BC_NOT_AVAIL 58 IC_BEARCAP_NOT_AVAIL 3
SERV_NOT_AVAIL 63 IC_SERVICE_OR_OPTION_NOT_AVAIL 47
BC_NOT_IMP 65 IC_BEARCAP_NOT_IMP 4
FAC_NOT_IMP 69 IC_REQ_FACILITY_NOT_IMP 42
RES_DIG_BEARCAP_ONLY 70 IC_ONLY_RESTRICT_DIG_INFO_BEARER 37
SERV_NOT_IMP 79 IC_SERVICE_OR_OPTION_NOT_IMP_UNSPEC 46
NOT_MEMBER_CUG 87 IC_INVALID_MSG_UNSPEC 19
INCOMP_DEST 88 IC_INCOMPATIBLE_DEST 15
NON_EXISTENT_CUG 90 IC_INVALID_MSG_UNSPEC 19
INVALID_TNS 91 IC_INVALID_TNS 21
INVALID_MESSAGE 95 IC_INVALID_MSG_UNSPEC 19
MSG_NOT_EXIST 97 IC_MSG_TYPE_NOT_IMP 24
ELEM_UNREC_DISCARDED 99 IC_ELEM_TYPE_NOT_IMP 13
PARAM_WITH_INVALID_CODING 100 IC_INVALID_ELEM_CONTENTS 18
RECOVERY_ONTIMER 102 IC_RECOVERY_ON_TIMER_EXPIRY 40
PARAM_UNREC_PASSED 103 IC_UNREC_ELEM_PASSED_ON 89
MSG_UNREC_PARAM_DISC 110 IC_INVALID_ELEM_CONTENTS 18
Table B-19 Received ANSI SS7 Cause Code to Internal Cause Code Mappings (continued)
Received ANSI SS7 Cause Code Value Internal Cause Code Value
PROT_ERROR_UNSP 111 IC_PROTOCOL_ERROR_UNSPEC 38
INTERWORK_UNSP 127 IC_INTERWORK_UNSPEC 16
Table B-20 Internal Cause Code to Transmitted ANSI SS7 Cause Code Mappings
Internal Cause Code Value Transmitted ANSI SS7 Cause Code Value
IC_ACCESS_INFO_DISCARDED 1 ACCESS_INFO_DISCARD 43
IC_BEARCAP_NOT_AUTHORIZED 2 BC_NOT_AUTH 57
IC_BEARCAP_NOT_AVAIL 3 BC_NOT_AVAIL 58
IC_BEARCAP_NOT_IMP 4 BC_NOT_IMP 65
IC_CALL_AWARDED_DELIVERED_EST_CH 5 TEMP_FAILURE 41
IC_CALL_ID_HAS_BEEN_CLEARED 6 TEMP_FAILURE 41
IC_CALL_ID_IN_USE 7 TEMP_FAILURE 41
IC_CALL_REJECTED 8 CALL_REJECTED 21
IC_CH_ID_NOT_EXIST 9 INTERWORK_UNSP 127
IC_CH_TYPE_NOT_IMP 10 INTERWORK_UNSP 127
IC_CH_UNACCEPTABLE 11 TEMP_FAILURE 41
IC_DEST_OUT_OF_ORDER 12 DEST_OOO 27
IC_ELEM_TYPE_NOT_IMP 13 ELEM_UNREC_DISCARDED 99
IC_FACILITY_REJECTED 14 FAC_REJECTED 29
IC_INCOMPATIBLE_DEST 15 INCOMP_DEST 88
IC_INTERWORK_UNSPEC 16 INTERWORK_UNSP 127
IC_INVALID_CALL_REFERENCE_VALUE 17 TEMP_FAILURE 41
IC_INVALID_ELEM_CONTENTS 18 MSG_UNREC_PARAM_DISCARDED 110
IC_INVALID_MSG_UNSPEC 19 INVALID_MESSAGE 95
IC_INVALID_NUMBER_FORMAT 20 ADDRESS_INCOMPLETE 28
IC_INVALID_TNS 21 INVALID_TNS 91
IC_MANDATORY_ELEMENT_MISSING 22 PROT_ERROR_UNSPEC 111
IC_MSG_IN_WRONG_STATE 23 PROT_ERROR_UNSPEC 111
IC_MSG_TYPE_NOT_IMP 24 MSG_NOT_EXIST 97
IC_MSG_TYPE_NOT_IMP_OR_WRONG_STATE 25 PROT_ERROR_UNSPEC 111
IC_NETWORK_OUT_OF_ORDER 26 NETWORK_OOO 38
IC_NO_CALL_SUSPENDED 27 TEMP_FAILURE 41
Table B-20 Internal Cause Code to Transmitted ANSI SS7 Cause Code Mappings (continued)
Internal Cause Code Value Transmitted ANSI SS7 Cause Code Value
IC_NO_ANSWER_ALERTED_USER 28 NO_ANSWER 19
IC_NO_CIRCUIT_AVAILABLE 29 NO_CIRCUIT 34
IC_NON_SELECTED_USER_CLEARING 30 NORMAL_UNSPEC 31
IC_NORMAL_CLEARING 31 NORMAL_REL 16
IC_NORMAL_UNSPECIFIED 32 NORMAL_UNSPEC 31
IC_NO_ROUTE_TO_DEST 33 NO_ROUTE_TO_DEST 3
IC_NO_ROUTE_TO_TNS 34 NO_ROUTE_TO_TRANSIT 2
IC_NO_USER_RESPONDING 35 NO_RESPONSE 18
IC_NUMBER_CHANGED 36 NUMBER_CHANGED 22
IC_ONLY_RESTRICT_DIG_INFO_BEARER 37 RES_DIG_BEARCAP_ONLY 70
IC_PROTOCOL_ERROR_UNSPEC 38 PROT_ERROR_UNSP 111
IC_QUALITY_UNAVAIL 39 NORMAL_UNSPEC 31
IC_RECOVERY_ON_TIMER_EXPIRY 40 RECOVERY_ONTIMER 102
IC_REQ_CIRCUIT_UNAVAIL 41 CHAN_NOT_AVAIL 44
IC_REQ_FACILITY_NOT_IMP 42 FAC_NOT_IMP 69
IC_REQ_FACILITY_NOT_SUBSCR 43 FACILITY_NOT_SUBSC 50
IC_RESOURCES_UNAVAIL_UNSPEC 44 RES_UNAVAIL 47
IC_RESPONSE_TO_STATUS_ENQUIRY 45 NORMAL_UNSPEC 31
IC_SERVICE_OR_OPTION_NOT_IMP_UNSPEC 46 SERV_NOT_IMP 79
IC_SERVICE_OR_OPTION_NOT_AVAIL 47 SERV_NOT_AVAIL 63
IC_SUSPEND_EXIST_BUT_NOT_THIS_ID 48 TEMP_FAILURE 41
IC_SWITCHING_EQUIP_CONGESTION 49 SWITCH_CONG 42
IC_TEMPORARY_FAILURE 50 TEMP_FAILURE 41
IC_UNALLOCATED_NUMBER 51 UNALLOCATED_NUM 1
IC_USER_BUSY 52 USER_BUSY 17
IC_INTERCEPTED_SUBSCRIBER 53 (No cause code listed.)
IC_ACCESS_BARRED 54 NORMAL_REL 16
IC_ACKNOWLEDGEMENT 55 NORMAL_REL 16
IC_ADDRESS_INCOMPLETE 56 ADDRESS_INCOMP 28
IC_BUSY 57 USER_BUSY 17
IC_CHANNEL_OUT_OF_SERVICE 58 NETWORK_OOO 38
IC_DTE_CONTROLLED_NOT_READY 59 NORMAL_UNSPEC 31
IC_CONGESTION 60 SWITCH_CONG 42
IC_CALL_TERMINATION 61 NORMAL_REL 16
IC_FACILITY_NOT_REGISTERED 62 FAC_REJECTED 29
IC_INCOMING_CALLS_BARRED 63 NORMAL_REL 16
Table B-20 Internal Cause Code to Transmitted ANSI SS7 Cause Code Mappings (continued)
Internal Cause Code Value Transmitted ANSI SS7 Cause Code Value
IC_SERVICE_INCOMPATIBLE 64 SERV_NOT_AVAIL 63
IC_MESSAGE_NOT_UNDERSTOOD 65 PROT_ERROR_UNSPEC 111
IC_NETWORK_ADDRESS_EXTENSION_ERROR 66 NORMAL_UNSPEC 31
IC_NETWORK_TERMINATION 67 NORMAL_UNSPEC 31
IC_NUMBER_UNOBTAINABLE 68 UNALLOCATED_NUM 1
IC_PRIORITY_FORCED_RELEASE 69 NORMAL_UNSPEC 31
IC_REJECT 70 NORMAL_UNSPEC 31
IC_ROUTE_OUT_OF_SERVICE 71 NETWORK_OOO 38
IC_SUBSCRIBER_INCOMPATIBLE 72 NORMAL_UNSPEC 31
IC_SIGNAL_NOT_UNDERSTOOD 73 PROT_ERROR_UNSPEC 111
IC_SIGNAL_NOT_VALID 74 PROT_ERROR_UNSPEC 111
IC_SUBSCRIBER_OUT_OF_SERVICE 75 NORMAL_UNSPEC 31
IC_SIGNALLING_SYSTEM_INCOMPATIBLE 76 INTERWORK_UNSPEC 127
IC_SERVICE_TEMPORARILY_UNAVAILABLE 77 SERV_NOT_AVAIL 63
IC_SERVICE_UNAVAILABLE 78 SERV_NOT_AVAIL 63
IC_DTE_UNCONTROLLED_NOT_READY 79 NORMAL_UNSPEC 31
IC_TRANSFERRED 80 NORMAL_UNSPEC 31
IC_INCOMING_CALLS_BARRED_IN_CUG 81 NORMAL_UNSPEC 31
IC_SPECIAL_INFORMATION_TONE 82 SEND_SIT 4
IC_USER_NOT_MEMBER_OF_CUG 83 NORMAL_UNSPEC 31
IC_MISDIALLED_TK_PREFIX 84 MISDIALLED_TRUNK_PREFIX 5
IC_PARAM_UNREC_PASSED 85 NORMAL_UNSPEC 31
IC_PROPRIETARY 86 NORMAL_UNSPEC 31
IC_PREEMPTION 87 PREEMPTION 8
IC_PREEMPTION_CCT_UNAVAILABLE 88 NORMAL_UNSPEC 31
IC_UNALLOCATED_DEST_NUMBER 89 UNALLOCATED_NUM 1
IC_UNREC_ELEM_PASSED_ON 90 PARAM_UNREC_PASSED 103
IC_SUB_ABSCENT 91 SUB_ABSCENT 20
IC_UNDEFINED_BG 92 UNDEFIND_BG 24
IC_ROUTING_ERROR 93 ROUTING_ERROR 25
IC_PRECEDENCE_BLOCKED 94 PRECEDENCE_BLOCKED 46
IC_CALL_TYPE_INCOMPATIBLE 95 CALL_TYPE_INCOMP 51
IC_GROUP_RESTRICTIONS 96 GROUP_RESTRICT 54
IC_CALLING_PARTY_OFF_HOLD 97 NORMAL_UNSPEC 31
IC_CALLING_DROPPED_WHILE_ON_HOLD 98 NORMAL_UNSPEC 31
IC_NEW_DESTINATION 99 NORMAL_UNSPEC 31
Table B-20 Internal Cause Code to Transmitted ANSI SS7 Cause Code Mappings (continued)
Internal Cause Code Value Transmitted ANSI SS7 Cause Code Value
IC_OUTGOING_CALLS_BARRED 100 NORMAL_UNSPEC 31
IC_SUB_CONTROLLED_ICB 101 NORMAL_UNSPEC 31
IC_CALL_REJECT_CALL_GAPPING 102 NORMAL_UNSPEC 31
IC_REJECTED_DIVERTED_CALL 103 NORMAL_UNSPEC 31
IC_SELECTIVE_CALL_BARRING 104 NORMAL_UNSPEC 31
IC_REMOTE_PROC_ERROR 105 NORMAL_UNSPEC 31
IC_TEMPORARY_OOS 106 NORMAL_UNSPEC 31
IC_OPERATOR_PRIORITY_ACCESS 107 NORMAL_UNSPEC 31
IC_CUG_ACCESS_BARRED 108 NORMAL_UNSPEC 31
IC_SUBSCRIBER_CALL_TERMINATE 109 NORMAL_UNSPEC 31
IC_FLOW_CONTROLLED_CONGESTION 110 NORMAL_UNSPEC 31
IC_OUT_OF_CATCHMENT_AREA 111 NORMAL_UNSPEC 31
IC_TRANSLATION_OOS 112 NORMAL_UNSPEC 31
IC_PERMANENT_ICB 113 NORMAL_UNSPEC 31
IC_SUBSCRIBER_MOVED 114 NORMAL_UNSPEC 31
IC_SUB_NOT_FOUND_DLE 115 NORMAL_UNSPEC 31
IC_ANONYMOUS_CALL_REJECTION 116 NORMAL_UNSPEC 31
IC_TERMINAL_CONGESTION 117 NORMAL_UNSPEC 31
IC_REPEAT_ATTEMPT 118 NORMAL_UNSPEC 31
IC_VACENT_CODE 119 NORMAL_UNSPEC 31
IC_PREFIX_0_DIALLED_IN_ERROR 120 NORMAL_UNSPEC 31
IC_PREFIX_1_DIALLED_IN_ERROR 121 NORMAL_UNSPEC 31
IC_PREFIX_1_NOT_DIALLED 122 NORMAL_UNSPEC 31
IC_EXCESSIVE_DIG_CALL_PROCEEDING 123 NORMAL_UNSPEC 31
IC_PROT_ERR_THRESHOLD_EXCEEDED 124 NORMAL_UNSPEC 31
IC_OUTGOING_CALLS_BARRED_IN_CUG 125 NORMAL_UNSPEC 31
IC_INCON_OUTGOING_ACC_AND_SUB_CLASS 126 NORMAL_UNSPEC 31
IC_NON_EXISTENT_CUG 127 NORMAL_UNSPEC 31
IC_MESG_WITH_UNREC_ELEM_DISCARDED 128 NORMAL_UNSPEC 31
IC_PREEMPTION_CCT_RES 129 NORMAL_UNSPEC 31
IC_PERMANENT_FRAME_MODE_OOS 130 NORMAL_UNSPEC 31
IC_PERMANENT_FRAME_MODE_OPERATIONAL 131 NORMAL_UNSPEC 31
IC_BLACKLIST_NO_CLI 132 NORMAL_UNSPEC 31
IC_BLACKLIST_CLI_LENGTH_INVALID 133 NORMAL_UNSPEC 31
IC_BLACKLIST_CLI_MATCHED 134 NORMAL_UNSPEC 31
IC_BLACKLIST_CPC_RESTRICTED 135 NORMAL_UNSPEC 31
Table B-20 Internal Cause Code to Transmitted ANSI SS7 Cause Code Mappings (continued)
Internal Cause Code Value Transmitted ANSI SS7 Cause Code Value
IC_BLACKLIST_NOA_RESTRICTED 136 NORMAL_UNSPEC 31
IC_BLACKLIST_BNUMBER_MATCHED 137 NORMAL_UNSPEC 31
IC_WHITELIST_CLI_NOT_MATCHED 138 NORMAL_UNSPEC 31
IC_PORTED_NUMBER 139 NORMAL_UNSPEC 31
IC_REDIRECTION_TO_NEW_DEST 140 NORMAL_UNSPEC 31
IC_COT_FAILURE 141 NORMAL_UNSPEC 31
IC_MISROUTED_CALL_PORTED_NUM 142 NORMAL_UNSPEC 31
IC_INVALID_CALL_REF 143 NORMAL_UNSPEC 31
IC_UNKNOWN 147 NORMAL_UNSPEC 31
IC_RE_ANALYSIS_REQUESTED 145 NORMAL_UNSPEC 31
IC_CALL_LICENSE_REJ 174 NORMAL_UNSPEC 31
IC_BAD_REQUEST 177 TEMP_FAILURE 41
IC_UNAUTHORIZED 178 CALL_REJECTED 21
IC_PAYMENT_REQUIRED 179 CALL_REJECTED 21
IC_FORBIDDEN 180 CALL_REJECTED 21
IC_METHOD_NOT_ALLOWED 181 SERV_NOT_AVAIL 63
IC_NOT_ACCEPTABLE 182 SERV_NOT_IMP 79
IC_PROXY_AUTHEN_REQUIRED 183 CALL_REJECTED 21
IC_REQUEST_TIMEOUT 184 RECOVERY_ONTIMER 102
IC_CONFLICT 185 TEMP_FAILURE 41
IC_LENGTH_REQUIRED 186 INTERWORK_UNSPEC 127
IC_ENTITY_TOO_LONG 187 INTERWORK_UNSPEC 127
IC_URI_TOO_LONG 188 INTERWORK_UNSPEC 127
IC_UNSUPPORTED_MEDIA_TYPE 189 SERV_NOT_IMP 79
IC_UNSUPPORTED_URI_SCHEME 190 INTERWORK_UNSPEC 127
IC_BAD_EXTENSION 191 INTERWORK_UNSPEC 127
IC_EXTENSION_REQUIRED 192 INTERWORK_UNSPEC 127
IC_SESSION_INTERVAL_TOO_SMALL 193 INTERWORK_UNSPEC 127
IC_INTERVAL_TOO_BRIEF 194 INTERWORK_UNSPEC 127
IC_ANONYMITY_DISALLOWED 195 NORMAL_UNSPEC 31
IC_TEMP_NOT_AVAILABLE 196 NO_RESPONSE 18
IC_LEG_OR_TRANSACTION_NOT_EXIST 197 TEMP_FAILURE 41
IC_LOOP_DETECTED 198 ROUTING_ERROR 25
IC_TOO_MANY_HOPS 199 ROUTING_ERROR 25
IC_AMBIGUOUS 200 UNALLOCATED_NUM 1
IC_REQUEST_TERMINATED 201 NORMAL_REL 16
Table B-20 Internal Cause Code to Transmitted ANSI SS7 Cause Code Mappings (continued)
Internal Cause Code Value Transmitted ANSI SS7 Cause Code Value
IC_NOT_ACCEPT_HERE 202 NORMAL_UNSPEC 31
IC_BAD_EVENT 203 NORMAL_UNSPEC 31
IC_REQUEST_PENDING 204 NORMAL_UNSPEC 31
IC_UNDECIPHERABLE 205 NORMAL_UNSPEC 31
IC_SERVER_INTERNAL_ERROR 206 TEMP_FAILURE 41
IC_NOT_IMPLEMENTED 207 SERV_NOT_IMP 79
IC_BAD_GATEWAY 208 NETWORK_OOO 38
IC_SERVICE_UNAVAIL 209 SERV_NOT_AVAIL 63
IC_SERVER_TIMEOUT 210 RECOVERY_ONTIMER 102
IC_VERSION_NOT_SUPPORT 211 INTERWORK_UNSPEC 127
IC_MSG_TOO_LARGE 212 INTERWORK_UNSPEC 127
IC_PRECONDITION_FAILURE 213 TEMP_FAILURE 41
IC_DECLINE 214 CALL_REJECTED 21
IC_NOT_EXIST_ANYWHERE 215 UNALLOCATED_NUM 1
IC_NOT_ACCEPTABLE_606 216 NORMAL_UNSPEC 31
IC_MULTIPLE_CHOICES 217 NORMAL_UNSPEC 31
IC_MOVED_PERMANENTLY 218 NORMAL_UNSPEC 31
IC_USE_PROXY 219 UNALLOCATED_NUM 1
IC_ALTERNATIVE_SERVICE 220 SERV_NOT_AVAIL 63
IC_SIP_CALL_SETUP_TIMEOUT 221 NO_RESPONSE 18
SIP Internal
SIP Status Code Values Cause Value DPNSS External Cause Code
Bad request 400 177 ‘07’H
Unauthorized 401 178 ‘30’H
Payment required 402 179 ‘30’H
Forbidden 403 180 ‘30’H
Not found 404 51 ‘00’H
Method not allowed 405 181 ‘03’H
Not acceptable 406 182 ‘30’H
Proxy authentication required 407 183 ‘30’H
Table B-21 SIP Status Code to DPNSS External Cause Code Mappings (continued)
SIP Internal
SIP Status Code Values Cause Value DPNSS External Cause Code
Request timeout 408 184 ‘02’H
Conflict 409 185 ‘07’H
Gone 410 36 ‘00’H
Length required 411 186 ‘30’H
Request entity too long 413 187 ‘30’H
Request URI too long 414 188 ‘30’H
Unsupported media type 415 189 ‘30’H
Unsupported URI scheme 416 190 ‘30’H
Bad extension 420 191 ‘30’H
Extension required 421 192 ‘30’H
Session interval too small 422 193 ‘30’H
Interval too brief 423 194 ‘30’H
Anonymity disallowed 433 195 ‘30’H
Temporarily not available 480 196 ‘02’H
Call leg/transaction does not exist 481 197 ‘07’H
Loop detected 482 198 ‘00’H
Too many hops 483 199 ‘00’H
Address incomplete 484 56 ‘01’H
Ambiguous 485 200 ‘00’H
Busy here 486 52 ‘08’H
Request terminated 487 201 ‘30’H
Not acceptable here 488 202 ‘30’H
Bad event 489 203 ‘30’H
Request pending 491 204 ‘30’H
Undecipherable 493 205 ‘30’H
Server internal error 500 206 ‘07’H
Not implemented 501 207 ‘30’H
Bad gateway 502 208 ‘1C’H
Service unavailable 503 209 ‘03’H
Server time-out 504 210 ‘02’H
Version not supported 505 211 ‘30’H
Message too large 513 212 ‘30’H
Precondition failure 580 213 ‘07’H
Busy everywhere 600 57 ‘08’H
Decline 603 214 ‘30’H
Table B-21 SIP Status Code to DPNSS External Cause Code Mappings (continued)
SIP Internal
SIP Status Code Values Cause Value DPNSS External Cause Code
Does not exist anywhere 604 215 ‘00’H
Not acceptable 606 216 ‘30’H
Multiple choices 300 217 ‘30’H
Moved permanently 301 218 ‘30’H
Moved temporarily 302 145 ‘30’H
Use proxy 305 219 ‘00’H
Alternative service 380 220 ‘03’H
Table B-22 SIP Status Code to QSIG External Cause Code Mappings
SIP Internal
Cause
SIP Status Code Values Values QSIG External Cause Code
Bad request 400 177 41
Unauthorized 401 178 21
Payment required 402 179 21
Forbidden 403 180 21
Not found 404 51 1
Method not allowed 405 181 63
Not acceptable 406 182 79
Proxy authentication required 407 183 21
Request timeout 408 184 102
Conflict 409 185 41
Gone 410 36 22
Length required 411 186 127
Request entity too long 413 187 127
Request URI too long 414 188 127
Unsupported media type 415 189 79
Unsupported URI scheme 416 190 127
Bad extension 420 191 127
Extension required 421 192 127
Session interval too small 422 193 31
Interval too brief 423 194 127
Table B-22 SIP Status Code to QSIG External Cause Code Mappings (continued)
SIP Internal
Cause
SIP Status Code Values Values QSIG External Cause Code
Anonymity disallowed 433 195 31
Temporarily not available 480 196 18
Call leg/transaction does not exist 481 197 41
Loop detected 482 198 31
Too many hoops 483 199 31
Address incomplete 484 56 28
Ambiguous 485 200 1
Busy here 486 52 17
Request terminated 487 201 16
Not acceptable here 488 202 31
Bad event 489 203 31
Request pending 491 204 31
Undecipherable 493 205 31
Server internal error 500 206 41
Not implemented 501 207 79
Bad gateway 502 208 38
Service unavailable 503 209 16
Server time-out 504 210 102
Version not supported 505 211 127
Message too large 513 212 127
Precondition failure 580 213 41
Busy everywhere 600 57 17
Decline 603 214 21
Does not exist anywhere 604 215 1
Not acceptable 606 216 31
Multiple choices 300 217 31
Moved permanently 301 218 31
Moved temporarily 302 145 31
Use proxy 305 219 1
Alternative service 380 220 31
Table B-23 SIP Status Code to ANSI External Cause Code Mappings
SIP Internal
Cause
SIP Status Code Values Values ANSI External Cause Code
Bad request 400 177 41
Unauthorized 401 178 21
Payment required 402 179 21
Forbidden 403 180 21
Not found 404 51 1
Method not allowed 405 181 63
Not acceptable 406 182 79
Proxy authentication required 407 183 21
Request timeout 408 184 102
Conflict 409 185 41
Gone 410 36 22
Length required 411 186 127
Request entity too long 413 187 127
Request URI too long 414 188 127
Unsupported media type 415 189 79
Unsupported URI scheme 416 190 127
Bad extension 420 191 127
Extension required 421 192 127
Session interval too small 422 193 127
Interval too brief 423 194 127
Anonymity disallowed 433 195 31
Temporarily not available 480 196 18
Call leg/transaction does not exist 481 197 41
Loop detected 482 198 25
Too many hoops 483 199 25
Address incomplete 484 56 28
Ambiguous 485 200 1
Busy here 486 52 17
Request terminated 487 201 16
Not acceptable here 488 202 31
Bad event 489 203 31
Table B-23 SIP Status Code to ANSI External Cause Code Mappings (continued)
SIP Internal
Cause
SIP Status Code Values Values ANSI External Cause Code
Request pending 491 204 31
Undecipherable 493 205 31
Server internal error 500 206 41
Not implemented 501 207 79
Bad gateway 502 208 38
Service unavailable 503 209 63
Server time-out 504 210 102
Version not supported 505 211 127
Message too large 513 212 127
Precondition failure 580 213 41
Busy everywhere 600 57 17
Decline 603 214 21
Does not exist anywhere 604 215 1
Not acceptable 606 216 31
Multiple choices 300 217 31
Moved permanently 301 218 31
Moved temporarily 302 145 31
Use proxy 305 219 1
Alternative service 380 220 63
Table B-24 SIP Status Code to H.323 External Cause Code Mappings
SIP Internal
Cause
SIP Status Code Values Values H.323 External Cause Code
Bad request 400 177 127
Unauthorized 401 178 127
Payment required 402 179 127
Forbidden 403 180 127
Not found 404 51 1 Unallocated number
Method not allowed 405 181 127 Interworking unspecified
Not acceptable 406 182 127 Interworking unspecified
Table B-24 SIP Status Code to H.323 External Cause Code Mappings (continued)
SIP Internal
Cause
SIP Status Code Values Values H.323 External Cause Code
Proxy authentication required 407 183 127 Interworking unspecified
Request timeout 408 184 127 Interworking unspecified
Conflict 409 185 127 Interworking unspecified
Gone 410 36 22 Number changed
Length required 411 186 127 Interworking unspecified
Request entity too long 413 187 127 Interworking unspecified
Request URI too long 414 188 127 Interworking unspecified
Unsupported media type 415 189 127 Interworking unspecified
Unsupported URI scheme 416 190 127 Interworking unspecified
Bad extension 420 191 127 Interworking unspecified
Extension required 421 192 127 Interworking unspecified
Session interval too small 422 193 127 Interworking unspecified
Interval too brief 423 194 127 Interworking unspecified
Anonymity disallowed 433 195 24 Call rejected due to ACR
supplementary service
Temporarily not available 480 196 20 Subscriber absent
Call leg/transaction does not exist 481 197 127 Interworking unspecified
Loop detected 482 198 127 Interworking unspecified
Too many hoops 483 199 127 Interworking unspecified
Address incomplete 484 56 28 Invalid number format
Ambiguous 485 200 127 Interworking unspecified
Busy here 486 52 17 User busy
Request terminated 487 201 127 Interworking unspecified
Not acceptable here 488 202 127 Interworking unspecified
Bad event 489 203 127 Interworking unspecified
Request pending 491 204 127 Interworking unspecified
Undecipherable 493 205 127 Interworking unspecified
Server internal error 500 206 127 Interworking unspecified
Not implemented 501 207 127 Interworking unspecified
Bad gateway 502 208 127 Interworking unspecified
Service unavailable 503 209 127 Interworking unspecified
Server time-out 504 210 127 Interworking unspecified
Version not supported 505 211 127 Interworking unspecified
Message too large 513 212 127 Interworking unspecified
Precondition failure 580 213 127 Interworking unspecified
Table B-24 SIP Status Code to H.323 External Cause Code Mappings (continued)
SIP Internal
Cause
SIP Status Code Values Values H.323 External Cause Code
Busy everywhere 600 57 17 User busy
Decline 603 214 21 Call rejected
Does not exist anywhere 604 215 1 Unallocated number
Not acceptable 606 216 127 Interworking unspecified
Multiple choices 300 217 23 Redirection to new destination
Moved permanently 301 218 23 Redirection to new destination
Moved temporarily 302 145 23 Redirection to new destination
Use proxy 305 219 31 Normal, unspecified
Alternative service 380 220 31 Normal, unspecified
Table B-25 ISUP Cause Code to SIP Status Code Mapping (continued)
Table B-25 ISUP Cause Code to SIP Status Code Mapping (continued)
Table B-25 ISUP Cause Code to SIP Status Code Mapping (continued)
Table B-25 ISUP Cause Code to SIP Status Code Mapping (continued)
Table B-26 ISUP Cause Code to SIP Status Code Non-Mapped Values
Table B-29 SIP Status Code to ISDN Cause Code Mapping (continued)
Table B-29 SIP Status Code to ISDN Cause Code Mapping (continued)
SIP
Intern
al
Cause
Internal Cause Code Value SIP Status Code Value
IC_NUMBER_CHANGED 36 Gone 410
IC_UNALLOCATED NUMBER 51 Not found 404
IC_USER_BUSY 52 Busy here 486
IC_ADDRESS_INCOMPLETE 56 Address incomplete 484
IC_BUSY 57 Busy everywhere 600
Table B-30 Internal Cause Code to SIP Status Code Mappings (continued)
SIP
Intern
al
Cause
Internal Cause Code Value SIP Status Code Value
IC_RE_ANALYSIS_REQUESTED 145 Moved temporarily 302
IC_CALL_LICENSE_REJ 174 Forbidden 403
IC_BAD_REQUEST 177 Bad request 400
IC_UNAUTHORIZED 178 Unauthorized 401
IC_PAYMENT_REQUIRED 179 Payment required 402
IC_FORBIDDEN 180 Forbidden 403
IC_METHOD_NOT_ALLOWED 181 Method not allowed 405
IC_NOT_ACCEPTABLE 182 Not acceptable 406
IC_PROXY_AUTHEN_REQUIRED 183 Proxy authentication required 407
IC_REQUEST_TIMEOUT 184 Request timeout 408
IC_CONFLICT 185 Conflict 409
IC_LENGTH_REQUIRED 186 Length required 411
IC_ENTITY_TOO_LONG 187 Request entity too long 413
IC_URI_TOO_LONG 188 Request URI too long 414
IC_UNSUPPORTED_MEDIA_TYPE 189 Unsupported media type 415
IC_UNSUPPORTED_URI_SCHEME 190 Unsupported URI scheme 416
IC_BAD_EXTENSION 191 Bad extension 420
IC_EXTENSION_REQUIRED 192 Extension required 421
IC_SESSION_INTERVAL_TOO_SMALL 193 Session interval too small 422
IC_INTERVAL_TOO_BRIEF 194 Interval too brief 423
IC_ANONYMITY_DISALLOWED 195 Anonymity disallowed 433
IC_TEMP_NOT_AVAILABLE 196 Temporarily not available 480
IC_LEG_OR_TRANSACTION_NOT_EXIST 197 Call leg/transaction does not exist 481
IC_LOOP_DETECTED 198 Loop detected 482
IC_TOO_MANY_HOOPS 199 Too many hoops 483
IC_AMBIGUOUS 200 Ambiguous 485
IC_REQUEST_TERMINATED 201 Request terminated 487
IC_NOT_ACCEPT_HERE 202 Not acceptable here 488
IC_BAD_EVENT 203 Bad event 489
IC_REQUEST_PENDING 204 Request pending 491
IC_UNDECIPHERABLE 205 Undecipherable 493
IC_SERVER_INTERNAL_ERROR 206 Server internal error 500
IC_NOT_IMPLEMENTED 207 Not implemented 501
Table B-30 Internal Cause Code to SIP Status Code Mappings (continued)
SIP
Intern
al
Cause
Internal Cause Code Value SIP Status Code Value
IC_BAD_GATEWAY 208 Bad gateway 502
IC_SERVICE_UNAVAIL 209 Service unavailable 503
IC_SERVER_TIMEOUT 210 Server time-out 504
IC_VERSION_NOT_SUPPORT 211 Version not supported 505
IC_MSG_TOO_LARGE 212 Message too large 513
IC_PRECONDITION_FAILURE 213 Precondition failure 580
IC_DECLINE 214 Decline 603
IC_NOT_EXIST_ANYWHERE 215 Does not exist anywhere 604
IC_NOT_ACCEPTABLE_606 216 Not acceptable 606
IC_MULTIPLE_CHOICES 217 Multiple choices 300
IC_MOVED_PERMANENTLY 218 Moved permanently 301
IC_USE_PROXY 219 Use proxy 305
IC_ALTERNATIVE_SERVICE 220 Alternative service 380
IC_SIP_CALL_SETUP_TIMEOUT 221 Request timeout 408
Table B-31 SIP Status Code to Internal Cause Code Mappings (continued)
Table B-31 SIP Status Code to Internal Cause Code Mappings (continued)
Note If the PGW receives a location value not listed in the table, it maps the value to the following default
values:
• MCI and Sprint: LOCATION_TRANSIT (0011)
• Bellcore: LOCATION_LOCAL_INTERFACE (0110)
Standard
Bellcore
Received
Sprint
Binary
MCI
Value CAUSE LOCATION
0000 LOCATION_USER X X X X
0010 LOCATION_LOCAL_LOCAL X X X X
0110 LOCATION_LOCAL_INTERFACE X X
0001 LOCATION_PRIVATE_LOCAL X X X
0011 LOCATION_TRANSIT DEFAULT X X X
0100 LOCATION_LOCAL_REMOTE X X X
0101 LOCATION_PRIVATE_REMOTE X X X
0110 LOCATION_LOCAL_INTERFACE X X X
0111 LOCATION_INTERNATIONAL X X X
1010 LOCATION_INTERWORKING X X X
Note If the PGW receives a location value not listed in the table, it maps the value to the following default
values:
• Bellcore: Location Local interface (0110)
• ANSI SS7: Location Transit (0011)
Standard
Bellcore
Transmitted
Sprint
Binary
MCI
CAUSE LOCATION Value
LOCATION_USER 0000 X X X X
LOCATION_LOCAL_LOCAL 0010 X X X X
LOCATION_LOCAL_INTERFACE 0110 X X
LOCATION_PRIVATE_LOCAL 0001 X X X
LOCATION_TRANSIT DEFAULT 0011 X X X
LOCATION_LOCAL_REMOTE 0100 X X X
LOCATION_PRIVATE_REMOTE 0101 X X X
LOCATION_LOCAL_INTERFACE 0110 X X X
LOCATION_INTERNATIONAL 0111 X X X
LOCATION_INTERWORKING 1010 X X X
Note If the PGW receives a location value not listed in the table, the value is mapped to the default internal
value LOCATION_INTERWORKING (1010).
Table B-35 Protocol-specific Release Cause Location Values for the Q767 Protocol
Mexican
Swedish
Received
Spanish
Russian
Italian
Note If the PGW receives a value not listed in the table, the value is mapped to the default value 1010
(LOCATION_INTERWORKING).
Table B-36 Internal to Protocol Location Mappings for the Q.767 Protocol
Mexican
Swedish
Transmitted
Spanish
Russian
Italian
Call Context Binary
CAUSE LOCATION Value
LOCATION_USER 0000 X X X X X X X X X
LOCATION_PUBLIC_LOCAL 0010 X X X X
LOCATION_PRIVATE_LOCAL 0001 X X X X
LOCATION_TRANSIT 0011 X X X X X X X X X
LOCATION_PUBLIC_REMOTE 0100 X X X X X X X X X
LOCATION_PRIVATE_REMOTE 0101 X X X X X X X X X
LOCATION_INTERNATIONAL 0111 X X X X X X X X X
LOCATION_INTERWORKING 1010 X X X X X X X X X
Taiwan Q.761
Finnish Q.761
Q.761 Korean
Korean Q.761
Received
Binary Call Context
Value CAUSE LOCATION
0000 LOCATION_USER X X X X X X X X X X X X X X
0010 LOCATION_PUBLIC_LOCAL X X X X X X X X X X X X X
0001 LOCATION_PRIVATE_LOCAL X X X X X X X X X X X X X
0011 LOCATION_TRANSIT X X X X X X X X X X X X X
Table B-37 Protocol-specific Release Cause Location Values for the Q761 Protocol (continued)
ETS_300_356_V3 and UK
Taiwan Q.761
Finnish Q.761
Q.761 Korean
Korean Q.761
Received
Binary Call Context
Value CAUSE LOCATION
0100 LOCATION_PUBLIC_REMOTE X X X X X X X X X X X X X
0101 LOCATION_PRIVATE_REMOTE X X X X X X X X X X X X X
0111 LOCATION_INTERNATIONAL X X X X X X X X X X X X X
1110 LOCATION_PACKET_MANAGER X
1010 LOCATION_INTERWORKING X X X X X X X X X X X X X X
Table B-38 Internal to Protocol Location Mappings for the Q761 Protocol
ETS_300_356_V3 and UK
Taiwan Q.761
Finnish Q.761
Q.761 Korean
Korean Q.761
Transmitted
Call Context Binary
CAUSE LOCATION Value
LOCATION_USER 0000 X X X X X X X X X X X X X X
LOCATION_PUBLIC_LOCAL 0010 X X X X X X X X X X X X X
LOCATION_PRIVATE_LOCAL 0001 X X X X X X X X X X X X X
LOCATION_TRANSIT 0011 X X X X X X X X X X X X X X
LOCATION_PUBLIC_REMOTE 0100 X X X X X X X X X X X X X
LOCATION_PRIVATE_REMOTE 0101 X X X X X X X X X X X X X
LOCATION_INTERNATIONAL 0111 X X X X X X X X X X X X X
LOCATION_PACKET_MANAGER 1110 X
LOCATION_INTERWORKING 1010 X X X X X X X X X X X X X X
Table B-39 Return Codes with Descriptions and Internal Cause Value Mapping
Internal
Cause
Code Description Value Internal Cause
100 Transaction being executed. Completion response to follow.
200 Trans_Executed_Normally
250 Connection_Deleted
400 Trans_Not_Executed_Transient_Error_400 32 IC_NORMAL_UNSPECIFIED
Table B-39 Return Codes with Descriptions and Internal Cause Value Mapping (continued)
Internal
Cause
Code Description Value Internal Cause
405 Trans_Not_Executed_Endpoint_Restarting_405 77 IC_SERVICE_TEMPORARILY_U
NAVAILABLE
Table B-39 Return Codes with Descriptions and Internal Cause Value Mapping (continued)
Internal
Cause
Code Description Value Internal Cause
509 SdpError_509 23 IC_MSG_IN_WRONG_STATE
Table B-39 Return Codes with Descriptions and Internal Cause Value Mapping (continued)
Internal
Cause
Code Description Value Internal Cause
515 Incorrect_Connection_ID_515 17 IC_INVALID_CALL_REFERENCE
_VALUE
Table B-39 Return Codes with Descriptions and Internal Cause Value Mapping (continued)
Internal
Cause
Code Description Value Internal Cause
523 IllegalCombination_Of_Actions_523 47 IC_SERVICE_OR_OPTION_NOT_
AVAIL
Table B-39 Return Codes with Descriptions and Internal Cause Value Mapping (continued)
Internal
Cause
Code Description Value Internal Cause
530 Cas_Signaling_Protocol_Error_530 105 IC_REMOTE_PROC_ERROR
Table B-39 Return Codes with Descriptions and Internal Cause Value Mapping (continued)
Internal
Cause
Code Description Value Internal Cause
539 Invalid_Unsupported_CommandParam_539 47 IC_SERVICE_OR_OPTION_NOT_
AVAIL
1.0 0.1
Return Code Return Code Description
000 NA Response acknowledgement.
100 NA Transaction is being executed. Completion response will follow.
101 NA Transaction has been queued.
200 200 Transaction was executed normally.
250 250 Connection was already deleted.
400 400 Transaction not executed, transient error.
1.0 0.1
Return Code Return Code Description
401 401 Phone is already off hook.
402 402 Phone is already on-hook.
403 400 Endpoint does not have sufficient resources.
404 400 Insufficient Bandwidth.
405 400 Endpoint is restarting.
406 400 Transaction timeout.
407 400 Transaction aborted.
409 400 Internal overload.
410 400 Endpoint not available.
500 500 Endpoint unknown.
501 501 Endpoint is not ready.
502 502 Endpoint does not have sufficient resources.
503 502 All of wildcard is too complicated.
504 510 Unknown or unsupported command.
505 510 Unknown remote connection descriptor.
506 510 Unable to satisfy both local connection option and remote
connection descriptor.
507 510 Unsupported functionality.
508 510 Unknown quarantine handling.
509 510 SDP Error.
510 510 Protocol error.
511 511 Unrecognized extension.
512 512 Gateway not equipped to detect events.
513 513 Gateway not equipped to generate signal.
514 514 Transaction could not be executed because the gateway cannot
send the specified announcement.
515 515 Invalid connection ID.
516 516 Unknown Call ID.
517 517 Unsupported/Invalid mode.
518 518 Unsupported/Invalid package.
519 519 Endpoint does not have a digit map.
520 520 Endpoint restarting.
521 NA Endpoint redirected to another call agent.
522 510 No such signal or event.
523 510 Unknown action or illegal combination of actions.
524 510 Internal inconsistency in LocalConnectionOptions (LCO).
1.0 0.1
Return Code Return Code Description
525 510 Unknown extension in LCO.
526 502 Insufficient bandwidth.
527 510 Missing RemoteConnectionDescriptor.
528 510 Incompatible protocol version.
529 501 Hardware failure.
530 501 CAS signaling protocol error.
531 501 Failure of a grouping of trunks (facility error).
532 510 Unsupported values in LCO.
533 502 Insufficient bandwidth. Response too large.
534 502 Codec negotiation failure.
535 510 Packetization period not supported.
536 510 Unsupported RestartMethod.
537 510 Unknown or unsupported digit map extension, since the gateway
does not have the digit map.
538 512 or 513 Event/Signal parameter error.
540 515 Per endpoint connection limit was exceeded.
596 596 VISM-specific return code indicating VCC failure or VCC could
not be set up.
598 598 Media connection failure.
599 599 VISM-specific return code indicating media connection loss.
Internal
Cause
Code Description Value Internal Cause
801 User Requested 32 IC_NORMAL_UNSPECIFIED
802 Lost carrier 50 IC_TEMPORARY_FAILURE
804 Idle timeout 40 IC_RECOVERY_ON_TIMER_EXPIRY
806 Nas Port ShutDown 50 IC_TEMPORARY_FAILURE
808 Modem Reset 50 IC_TEMPORARY_FAILURE
810 Nas Request 50 IC_TEMPORARY_FAILURE
815 Service Unavailable 50 IC_TEMPORARY_FAILURE
900 Endpoint malfunctioning 50 IC_TEMPORARY_FAILURE
Internal
Cause
Code Description Value Internal Cause
901 Endpoint taken out of service 50 IC_TEMPORARY_FAILURE
902 Loss of lower layer 50 IC_TEMPORARY_FAILURE
connectivity
Internal
Cause
Code Description Value Internal Cause
801 Modems unavailable 44 IC_RESOURCES_UNAVAIL_UNSPEC
803 Pre-auth failure CDN invalid 8 IC_CALL_REJECTED
805 Session timeout (Mapped to 803)
809 NAS Software error (Mapped to 803)
This appendix contains page-size copies of all the worksheets contained in this dial plan guide.
This includes all of the following:
• Table C-1, Trunk Worksheet C-1
• Table C-2, Dial Plan Worksheet C-3
• Table C-3, Result Types Worksheet C-4
• Table C-4, Digit Modification Table Worksheet C-5
• Table C-5, Service Name Table Worksheet C-6
• Table C-6, NOA Table Worksheet C-7
• Table C-7, NPI Table Worksheet C-8
• Table C-8, Cause Table Worksheet C-9
• Table C-9, Location Table Worksheet C-10
termtbl 4-28
G
GN-ACgPN 1-25
GUI 2-3
N
NANP 1-74
nature of address 4-20
I
NIC 1-89
ISDN User Part NOA 1-72
See ISUP 1-3 NPA 1-74
ISUP NPI 1-72
contains A-number and B-number 1-3 numan-ed 4-11
numbering plan indicator table 4-19
L
P
location table 4-22
PI 1-25
PSTN 1-4
M