DO NOT SHARE THESE DOCS WITH CUSTOMERS!
This is an LA release that will only be provided to a select number of PLM-sanctioned customers (PDFs only). Contact PLM for details.
In this section:
Response Fields
The following table defines the response fields returned for policy and trigger requests.
Response Fields
| Response | Description |
|---|---|
| Routes | The number of routes returned. |
| AIN Flags | Optional parameters returned in Send-to-Resource message. |
| AmaBafModule | Automatic Message Accounting modules in Telcordia AMA format. |
| AmaSlpId | Identifies a service or a unique subset of service functionality. |
| BillingData | This is the billing information for this call. Includes information such as carrier origin, cluster ID, trunk ID, and so on. |
| BillingIndicators | Billing indicators are used to pass billing information to the SBC client so it can add the information to the accounting record. |
| BusinessGroupBillingInfo | This is the business group billing information for the call. |
| CalledBusinessGroup | Returns information such as business group ID and line privileges for the called business group. |
| CallInfo | Conveys information that the trigger response belongs to the new leg of the call. |
| CallInformationRequest | This is the call information request for the call. |
| CallingBusinessGroup | Returns information such as business group ID and line privileges for the calling business group. |
| CallingNumberChargeArea | Returns the charge area for the calling number. |
| Category | Similar to OLIP (Originating Line Information Parameter). |
| CallType | The type of call, such as National, International, etc. |
| ConvertOlecCarrierCode | Signal to GSX to convert the OLEC carrier code. |
| DPCInfo | Destination Point Code Information parameter, based on called party number and gateway name. |
| JTIParameters | Specifies customer-specific identification parameters. |
| CountryCode | In the CAS (Channel Associated Signaling) protocol, the country code is transmitted as a separate field. When a country code is present and the signaling protocol is CAS, the country code is passed to the SBC in the Country Code field. |
| ForwardCallIndicators | This specifies how the carrier code was specified for the call. The data for this field is derived from the carrier selection parameter in ISUP signaling. |
| GenericName | The SBC client should send the generic name parameter in the signaling. |
| IngressIPParameters | Returns ingress IP signaling parameters and header extensions. |
| IngressMediaProfile | The SBC Tone and Announcement Profile used in the call. |
| IngressParameterFlags | Attributes associated with the ingress trunk group, such as the ATP Supported attribute. |
| IngressSwitch | The switch on which the call came in. |
| IngressTrunkGroup | The trunk group on which the call came in. |
| Lata | This specifies the local access and transport area of the carrier. |
| LICriteriaInfo | Displays the Lawful Intercept criteria sent back by the SBC. |
| MidCallData | Data containing redirection information related to Policy Mid Call Actions. For calls in GSM networks, the SBC may send Policy Mid Call Actions to its clients during late call forwarding scenarios in which call redirections occur. For details, see the section "Policy Mid Call Action Fields" on page 1-20. |
| MoreRoutesInfo | Specifies more routes availability information. |
| NetworkData | On a per-route basis, includes information specifying whether to generate, propagate, or suppress the Partition ID and Network ID in the egress IAM. |
| NFCI | This parameter, National Forward Call Indicator, contains zoning indicator, charge indicator, and IN call indicator fields. |
| OriginalRedirectingNumberCallType | The call type of the original redirecting number. |
| OriginatingGatewayInfo | The SIP server or H.323 gateway from which the call originated. |
| OverlapDialing | Includes values provisioned on the SBC for overlap dialing, such as the minimum digits for routing a call, the minimum digits for a valid phone number, and the maximum digits for a valid phone number. |
| OwnCarrierInfo | This is a specific ISUP parameter. It includes the originating carrier code of the incoming call. |
| PacketProfile | Indicates the settings in the Packet Service Profile used. |
| PartialCli | The partial CLI is passed down to the SBC client whenever the SBC does not receive a calling number in the policy request. |
| PortabilityInfo | Indicates whether or not number portability information is included in the response (NP Status), and whether the Query on Release (QoR) is received in the ingress message or the local exchange must perform the lookup (NPI Flags). This is for INAP use only. |
| Provider | The partition ID of the carrier or service provider. |
| SBCCongestion | The current SBC CPU congestion level, including the allowed calls per total calls for the level. |
| RedirectBackwardInformation | The redirect backward information for the call. |
| RedirectionInfo | Provides the reason for the redirecting the call. |
| RouteTable | The routing label. |
| ScpCarrierCode | The carrier code returned by the SCP, if available. |
| Script | The script returned for execution on the SBC client. |
| SrcCarrierType | Describes how a carrier was chosen for routing the call. |
| SrcTGConfiguration | Information about the source trunk group. |
| TranslationSourceNumber | The translation source number for the call. |
| Variables | In the policy response, the runtime variables will be populated here. |
| XCorrelationID | A customer-specific parameter for a call involving the SBC SPAS service |
| VisitorMA | The Visitor MA (Message Area) parameter, which is a customer- specific Japan ISUP extension parameter for routing calls in a mobile network. |
Routes Directory Field Descriptions
The following table defines the response fields in a Routes directory.
Routes Directory Field Descriptions
| Field | Description |
|---|---|
| BillingNumber | This specifies the billing number for the call. In ISUP terminology, this is referred to as the charge number. |
| CalledDirectoryNumber | The directory number being called. |
| CalledNumber | The number being called. |
| CalledNumberChargeArea | This field contains the charge area for the called number. |
| CalledUri | This field contains the called URI. |
| CallIndicators | This specifies the charge band information. |
| Category | Similar to OLIP (Originating Line Information Parameter). |
| CallingNumber | The number from which the call originates. |
| CallingUri | This field contains the calling URI for the call. |
| CarrierCode | The carrier code of the carrier from which the call is being routed. When ISUP signaling is used, the Carrier Code field is populated from the Carrier Information Parameter (CIP). |
| CarrierSelection | This specifies how the carrier code was specified for the call. The data for this field is derived from the carrier selection parameter in ISUP signaling. |
| CarrierType | Describes how a carrier was chosen for routing the call. |
| ContractorNumber | This is a Japan-specific ISUP parameter. This parameter includes the telephone number for billing. |
| DestSigAttributes | Indicates the peer address, packet profile, and IP parameters for the egress leg of a call on an IP trunk group. |
| DstTGAttributes | Indicates the direction and bearer capability of the destination trunk group. |
| EgressCarrierInfo | This is a specific ISUP parameter. It includes the destination carrier code of the outgoing call. |
| EgressMediaProfile | The SBC Tone and Announcement Profile selected for the route. |
| EgressParameterFlags | Attributes associated with the egress trunk group, such as the ATP Supported attribute. |
| EgressSwitch | The egress switch on which the call went out. |
| EgressTrunkGroup | The egress trunk group on which the call went out. |
| GatewayAddress | The family, port number, and IP address of the gateway associated with the simulated call's policy request. |
| GatewayName | Name of the gateway associated with the simulated call's policy request. |
| GenericAddress | These fields map to SS7 IAM Generic Address parameters to store information such as original redirecting number and redirecting number. |
| GenericDigits | Used for Switch ID/Trunkgroup ID-based routing. |
| GenericNumber | Used to specify Feature Group D delivery. |
| IPParameters | Returns ingress IP signaling parameters and header extensions. |
| JTIParameters | Contains customer-specific parameters. |
| JurisdictionInfo | Specifies the jurisdiction information parameter. Stores the NPA/ NXX assigned to the trunk or extracted from the calling party number. |
| LocalRingBackTone | This indicates the settings used in the local ring back tone profile. |
| LocationNumber | Used to indicate the geographic position of the calling party. The format is country specific, but is likely to be some longitude/latitude numeric encoding. |
| NatureOfConnection | This is used to specify the following information for the call:
|
| NonStandardParameterStr | Represents any user or network specific ISUP parameter which is not in the standard protocol definition. |
| OriginatingLineInfo | This specifies the originating line type. This field is populated by the SBC client from the Originating Line Information Parameter in ISUP signaling. |
| OriginalRedirectingNumber | This is used to specify the original called number. Signifies information sent in a forward direction when a call is redirected more than once and identifies the original called party. |
| OutpulseDigits | The outpulse digits from an SCP. |
| PacketProfile | Indicates the settings used in the Packet Service Profile. |
| PartialCLI | The partial CLI is passed down to the SBC client whenever the SBC does not receive a calling number in the policy request. |
| PresentationNumber | The presentation number for the call. |
| RedirectForwardInformation | The redirect forward information for the call. |
| RedirectionCapability | The redirection capability for the call. |
| RedirectionNumber | Used to specify information sent in the backward direction indicating the number towards which the call must be rerouted or which has been forwarded. |
| RedirectingNumber | Use to specify the number used instead of the called number to redirect the call. Signifies the information sent in the forward direction indicating the number from which the call was last redirected. |
| RouteType | Identifies the type of route, for example H.323 gateway. |
| SipFromDisplayName | This field contains the SIP From header display name. |
| SipFromHeader | This field contains the contents of the SIP From header. |
| SipToHeader | Identifies the SIP To header, which specifies the desired "logical" recipient of the request, or the address-of-record of the user or resource that is the target of this request. |
| SipPaiSipDisplayName | The SIP P-Asserted-Identity SIP display name. |
| SipPaiSipUri | The SIP P-Asserted-Identity SIP URI. |
| SIP PaiTelDisplayName | The SIP P-Asserted-Identity Tel display name. |
| TrafficControl | Used to specify the type of traffic control applied and congestion level. |
| TransitNetworkSelection | This specifies the transit network selection. |
| Translated | Number of translations on a per-route basis. |
| TrunkGroup | The trunk group from which the call was received on the ingress trunk group. |
| ZoneIndex | This specifies a unique number in which SIP servers and H.323 gateways can reside and retain unique IP addresses. |
| ZZCode | This is used in CAS signaling. |
Policy Mid Call Action Response Fields
The following table describes the Mid Call Action fields.
Mid Call Action Fields
|
|
|---|---|
Present | When checked, indicates the presence of Mid Call Data. |
Redirection Count | Number of redirections encountered by the SBC. |
Mid Call Info Count | Number of elements in the Mid Call Info array. |
Billing Info | Billing data for the call. |
Context | Contains the redirection data the SBC will use to populate the Billing |
Mid Call Info | See the Table 4 for details. |
Mid Call Info Fields
The following table describes the Mid Call Info fields.
Mid Call Info Fields
| Field | Description |
|---|---|
| Present | When checked, indicates the presence of Mid Call Info. |
| Msg Op | Information indicating the type of redirection, which can be IS-41 or GSM. |
| Action | Information indicating how the SBC client should process the Mid Call. For example, drop the egress leg and send a new policy request. |
| Digits | Contains the redirected to number. |
| Carrier | Contains the new Carrier Code. |
| Redirection Info | Contains the redirection reason. |
| Redirecting Number | Contains the redirecting number, which is the number that is forwarding the call. |
Overview
Content Tools