IN Objects
The IN objects used in common methods each have a number of associated properties.
AccessCode
Identifies the access code of a business group dialing plan. This could be an attendant access code, an access code to the public network, or a feature access code.
-
.nature_of_number
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.numbering_plan
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
1-5 digits in length
AlternateBillingIndicator
Indicates the Automatic Message Accounting (AMA) call type and service feature identifier for the alternate trunk group.
-
.AmaCallType
- Type:
String
- Description:
AMA call type assigned to the alternate trunk group.
- Possible Values:
3 digits in length
-
.ServiceFeatureIdentification
- Type:
String
- Description:
Service associated with the alternate trunk group.
- Possible Values:
3 digits in length
AlternateCarrier
Provides the carrier selection information and the identification of the alternate carrier that a call is routed to.
-
.CarrierSelection
- Type:
Integer
- Description:
How the alternate carrier is to be specified.
- Possible Values:
3 digits in length
-
.NatureOfCarrier
- Type:
Integer
- Description:
Information on type of carrier.
- Possible Values:
AlternateCarrier.NO_INDICATION
AlternateCarrier.PRESUBSCRIBED_AND_NOT_INPUT_BY_CALLING
AlternateCarrier.PRESUBSCRIBED_AND_INPUT_BY_CALLING
AlternateCarrier.PRESUBSCRIBED_AND_NO_INDICATION
AlternateCarrier.NOT_PRESUBSCRIBED_AND_INPUT_BY_CALLING
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
AlternateCarrier.NO_NOC_PROVIDED
AlternateCarrier.LOCAL
AlternateCarrier.INTRA_LATA_TOLL
AlternateCarrier.INTRA_LATA
AlternateCarrier.LOCAL_INTRA_LATA_TOLL_AND_INTER_LATA
AlternateCarrier.LOCAL_AND_INTRALATA_TOLL
AlternateCarrier.INTRA_LATA_TOOL_AND_INTER_LATA
AlternateDialingPlanInd
Provides alternate dialing plan information to be used by the SSP in assigning a dialing plan to override the current dialing plan.
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit A = 0
International - Bit A = 1
No Presentation Restricted - Bit B =0
Presentation Restricted - Bit B=1
- Possible Values:
AlternateDialingPlanInd.UNKNOWN_OR_NOT_APPLICABLE
AlternateDialingPlanInd.UNIQUE_SUBSCRIBER_NUMBER
AlternateDialingPlanInd.UNIQUE_NATIONAL_NUMBER
AlternateDialingPlanInd.UNIQUE_INTERNATIONAL_NUMBER
AlternateDialingPlanInd.NONUNIQUE_SUBSCRIBER_NUMBER_OP_REQ
AlternateDialingPlanInd.NONUNIQUE_NATIONAL_NUMBER_OP_REQ
AlternateDialingPlanInd.NONUNIQUE_INTERNATIONAL_NUMBER_OP_REQ
AlternateDialingPlanInd.TEST_LINE_TEST_CODE
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
-
-
.presentation
- Type:
Integer
- Description:
Presentation indicator associated with the digits.
- Possible Values:
AlternateDialingPlanInd.PRESENTATION_ALLOWED
AlternateDialingPlanInd.PRESENTATION_RESTRICTED
AlternateDialingPlanInd.PRESENTATION_NUMBER_UNAVAILABLE
-
.screening
- Type:
Integer
- Description:
Screening indicator associated with the digits.
- Possible Values:
AlternateDialingPlanInd.USER_PROVIDED_NOT_SCREENED
AlternateDialingPlanInd.USER_PROVIDED_PASSED_SCREENING
AlternateDialingPlanInd.USER_PROVIDED_FAILED_SCREENING
AlternateDialingPlanInd.NETWORK_PROVIDED_NO_SCREENING
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
10 digits in length
AlternateTrunkGroup
Provides an alternate trunk group route index and is sent, along with SecondAlternateTrunkGroup and PrimaryTrunkGroup, when a call is to be routed to a trunk group.
-
.NumToOutpulse
- Type:
Boolean
- Description:
Digits sent to the trunk group.
- Possible Values:
-
-
.SfgInd
- Type:
Boolean
- Description:
Restrictions on the number of simultaneous calls with the public network.
- Possible Values:
-
-
.CallTreatInd
- Type:
Integer
- Description:
Whether the call should overflow to the public network.
- Possible Values:
AlternateTrunkGroup.NOT_USED
AlternateTrunkGroup.NO_OVERFLOW_AND_NO_RETURN
AlternateTrunkGroup.OVERFLOW
AlternateTrunkGroup.OFF_HOOK_NO_OVERFLOW_AND_NO_RETURN
AlternateTrunkGroup.OFF_HOOK_OVERFLOW
AlternateTrunkGroup.RINGBACK_NO_OVERFLOW_AND_NO_RETURN
AlternateTrunkGroup.RINGBACK_OVERFLOW
AlternateTrunkGroup.RETURN
AlternateTrunkGroup.OFF_HOOK_RETURN
AlternateTrunkGroup.RINGBACK_RETURN
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
8 digits in length
AMAAlternateBillingNumber
Identifies an alternate billing number to which the ANI number should be billed.
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit A = 0
International - Bit A = 1
No Presentation Restricted - Bit B =0
Presentation Restricted - Bit B=1
- Possible Values:
AMAAlternateBillingNumber.UNKNOWN_OR_NOT_APPLICABLE
AMAAlternateBillingNumber.ANI_CALLING_SUBSCRIBER
AMAAlternateBillingNumber.ANI_NOT_AVAILABLE
AMAAlternateBillingNumber.ANI_CALLING_NATIONAL
AMAAlternateBillingNumber.ANI_CALLED_SUBSCRIBER
AMAAlternateBillingNumber.ANI_CALLED_NOT_INCLUDED
AMAAlternateBillingNumber.ANI_CALLED_NATIONAL
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
-
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
3-15 digits in length
AMABusinessCustomerID
Identifies the business customer and the type of customer ID.
-
.nature_of_number
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.numbering_plan
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
11 digits in length
AMADigitsDialedWC (SEQ_AMADigitsDialedWC)
Provides any digit string that the customer dialed along with the context ID to indicate the name of the digit string.
-
.nature_of_number
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.numbering_plan
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
3-27 digits in length
SEQ_AMADigitsDialedWC Example
To construct a SEQ_AMADigitsDialedWC parameter suitable for passing into the PAC in the session variable seq_amadigitsdialedWC, the JavaScript will look like the following:
// Construct individual AMADigitsDialedWC elements
var amadd0 = new AMADigitsDialedWC;
amadd0.digits = "6754637287";
var amadd1 = new AMADigitsDialedWC;
amadd1.digits = "9084901432";
// Assign each encoded element to consecutive indexes as an array.
Session.seq_amadigitsdialedWC[0] = amadd0.encode();
Session.seq_amadigitsdialedWC[1] = amadd1.encode();
AMALineNumber (SEQ_AMALineNumber)
Field including information such as the calling party ID, incoming terminating number, or Automatic Number Identification (ANI).
-
.nature_of_number
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.numbering_plan
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
3-15 digits in length
SEQ_AMALineNumber Example
To construct a SEQ_AMALineNumber parameter suitable for passing into the PAC in the session variable seq_amalinenumber, the JavaScript will look like the following:
// Construct individual AMALineNumber elements
var amaln0 = new AMALineNumber;
amaln0.digits = "7895431235";
var amadd1 = new AMALineNumber;
amaln1.digits = "9602348769";
// Assign each encoded element to consecutive indexes as an array.
Session.seq_amalinenumber[0] = amaln0.encode();
Session.seq_amalinenumber[1] = amaln1.encode();
#navbar > div > div.collapse.navbar-collapse.nav-collapse > ul > li.dropdown-sm.open > ul > ul > li > ul > li:nth-child(11) > a > code > span
AmaSlpId
Indicates that the Service Switching Point (SSP) should override normal switch-based recording and invoke Advanced Intelligent Network (AIN) Automatic Message Accounting (AMA) record generation.
-
.digits
- Type:
String
- Description:
Digits that identify a service or a unique subset of service functionality.
- Possible Values:
9 digits in length
AnswerIndicator
Indicates whether the Service Switching Point (SSP) should return answer supervision to the caller when the caller is connected to the announcement during the Send_To_Resource procedures.
-
.value
- Type:
String
- Description:
Whether to disconnect the leg.
- Possible Values:
-
BearerCapability
Identifies the bearer capability of the user, which may be the calling or called party.
-
.value
- Type:
Integer
- Description:
Particular capability of the user.
- Possible Values:
BearerCapablity.SPEECH
BearerCapablity.F_31_KHZ_AUDIO
BearerCapablity.F_7_KHZ_AUDIO
BearerCapablity.B_56_KBPS
BearerCapablity.B_64_KBPS
BearerCapablity.PACKET_MODE_DATA
BearerCapablity.MULTI_RATE
BusyCause
Indicates the reason the call could not be presented to the terminating party.
-
.CauseValue
- Type:
Integer
- Description:
Reason for the busy.
- Possible Values:
BusyCause.NO_USER_RESPONDING
BusyCause.USER_ALERTING_NO_ANSWER
BusyCause.CALL_REJECTED
BusyCause.NUMBER_CHANGED
BusyCause.CALLER_ABANDON
BusyCause.IMPROPER_CALLER_RESPONSE
BusyCause.DESTINATION_OUT_OF_ORDER
BusyCause.ADDRESS_INCOMPLETE
BusyCause.NORMAL_UNSPECIFIED
BusyCause.REDIRECTION_COUNTER_EXCEEDED
BusyCause.NO_CIRCUIT_AVAILABLE
BusyCause.RESERVED_FOR_NETWORK_OUT_OF_ORDER
BusyCause.TEMPORARY_FAILURE
BusyCause.SWITCHING_EQUIPMENT_CONGESTION
BusyCause.ACCESS_INFORMATION_DISCARDED
BusyCause.REQUESTED_CHANNEL_NOT_AVAILIABLE
BusyCause.RESOURCE_UNAVAILABLE_UNSPECIFIED
BusyCause.BEARER_CAPABILITY_NOT_AUTHORIZED
BusyCause.BEARER_CAPABILITY_NOT_PRESENTLY_AVAIL
BusyCause.SERVICE_NOT_AVAILABLE_UNSPECIFIED
BusyCause.BEARER_CAPABILITY_NOT_IMPLEMENTED
BusyCause.SERVICE_NOT_IMPLEMENTED_UNSPECIFIED
BusyCause.INVALID_MESSAGE_UNSPECIFIED
BusyCause.MESSAGE_TYPE_NOT_IMPLMENTED
BusyCause.PARAMETER_NOT_IMPLEMENTED_ACCEPTED
BusyCause.PARAMETER_WITH_INVALID_CODING
BusyCause.PARAMETER_NOT_IMPLEMENTED_DISCARDED
BusyCause.PROTOCOL_ERROR_UNSPECIFIED
BusyCause.INTERWORKING_UNSPECIFIED
BusyCause.UNALLOCATED_NUMBER
BusyCause.NO_ROUTE_TO_SPECIFIED_TRANSIT_NETWORK
BusyCause.NO_ROUTE_TO_DESTINATION
BusyCause.NORMAL_CLEARING
BusyCause.USER_BUSY
-
.GeneralLocation
- Type:
Integer
- Description:
Location of the call.
- Possible Values:
BusyCause.USER
BusyCause.PRIVATE_NETWORK_SERVING_LOCAL_USER
BusyCause.PUBLIC_NETWORK_SERVING_LOCAL_USER
BusyCause.TRANSIT_NETWORK
BusyCause.PUBLIC_NETWORK_SERVING_REMOTE_USER
BusyCause.PRIVATE_NETWORK_SERVING_REMOTE_USER
BusyCause.LOCAL_INTERFACE_CONTROLLED_BY_THIS_LINK
BusyCause.INTERNATIONAL_NETWORK
BusyCause.UNKNOWN
-
.CodingStandard
- Type:
Integer
- Description:
Whether the coding is CCIT or network-specific.
- Possible Values:
-
-
.DiagnosticInclude
- Type:
Integer
- Description:
Whether diagnostic information is included after octet 2.
- Possible Values:
-
-
.DiagnosticValue
- Type:
Integer
- Description:
Value generated by diagnostics.
- Possible Values:
0-255
CalledPartyID
Provides the Directory Number (DN) associated with the called party.
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit A = 0
International - Bit A = 1
No Presentation Restricted - Bit B =0
Presentation Restricted - Bit B=1
- Possible Values:
CalledPartyID.UNKNOWN_OR_NOT_APPLICABLE
CalledPartyID.SUBSCRIBER_NUMBER
CalledPartyID.NATIONAL_SPARE
CalledPartyID.NATIONAL_NUMBER
CalledPartyID.INTERNATIONAL_NUMBER
CalledPartyID.SUBSCRIBER_NUMBER_OP_REQ
CalledPartyID.NATIONAL_NUMBER_OP_REQ
CalledPartyID.INTERNATIONAL_NUMBER_OP_REQ
CalledPartyID.NO_ADDRESS_PRESENT_OP_REQ
CalledPartyID.NO_ADDRESS_PRESENT_CUT_THROUGH
CalledPartyID.LOCAL_EXCHANGE_OR_HOTEL_950
CalledPartyID.TEST_LINE_TEST_CODE
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
-
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
0-15 digits in length
CallingPartyID
Provides the Directory Number (DN) associated with the calling party.
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit A = 0
International - Bit A = 1
No Presentation Restricted - Bit B =0
Presentation Restricted - Bit B=1
- Possible Values:
CallingPartyID.UNKNOWN_OR_NOT_APPLICABLE
CallingPartyID.UNIQUE_SUBSCRIBER_NUMBER
CallingPartyID.UNIQUE_NATIONAL_NUMBER
CallingPartyID.UNIQUE_INTERNATIONAL_NUMBER
CallingPartyID.NONUNIQUE_SUBSCRIBER_NUMBER_OP_REQ
CallingPartyID.NONUNIQUE_NATIONAL_NUMBER_OP_REQ
CallingPartyID.NONUNIQUE_INTERNATIONAL_NUMBER_OP_REQ
CallingPartyID.TEST_LINE_TEST_CODE
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
-
-
.presentation
- Type:
Integer
- Description:
Presentation indicator associated with the digits.
- Possible Values:
CallingPartyID.PRESENTATION_ALLOWED
CallingPartyID.PRESENTATION_RESTRICTED
CallingPartyID.PRESENTATION_NUMBER_UNAVAILABLE
-
.screening
- Type:
Integer
- Description:
Screening indicator associated with the digits.
- Possible Values:
CallingPartyID.USER_PROVIDED_NOT_SCREENED
CallingPartyID.USER_PROVIDED_PASSED_SCREENING
CallingPartyID.USER_PROVIDED_FAILED_SCREENING
CallingPartyID.NETWORK_PROVIDED_NO_SCREENING
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
3-15 digits in length
Carrier
Provides the carrier selection information and the identification of the primary carrier that a call was routed to.
-
.CarrierSelection
- Type:
Integer
- Description:
Carrier selected for the call.
- Possible Values:
Carrier.NO_INDICATION
Carrier.PRESUBSCRIBED_AND_NOT_INPUT_BY_CALLING
Carrier.PRESUBSCRIBED_AND_INPUT_BY_CALLING
Carrier.PRESUBSCRIBED_AND_NO_INDICATION
Carrier.NOT_PRESUBSCRIBED_AND_INPUT_BY_CALLING
-
.NatureOfCarrier
- Type:
Integer
- Description:
Type of carrier that has been selected.
- Possible Values:
Carrier.NO_NOC_PROVIDED
Carrier.LOCAL
Carrier.INTRA_LATA_TOLL
Carrier.INTRA_LATA
Carrier.LOCAL_INTRA_LATA_TOLL_AND_INTER_LATA
Carrier.LOCAL_AND_INTRA_LATA_TOLL
Carrier.INTRA_LATA_TOLL_AND_INTER_LATA
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
4 digits in length
ChargeNumber
Provides the Automatic Number Identification (ANI) of the calling party.
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit A = 0
International - Bit A = 1
No Presentation Restricted - Bit B =0
Presentation Restricted - Bit B=1
- Possible Values:
ChargeNumber.UNKNOWN_OR_NOT_APPLICABLE
ChargeNumber.ANI_CALLING_SUBSCRIBER
ChargeNumber.ANI_NOT_AVAILABLE
ChargeNumber.ANI_CALLING_NATIONAL
ChargeNumber.ANI_CALLED_SUBSCRIBER
ChargeNumber.ANI_CALLED_NOT_INCLUDED
ChargeNumber.ANI_CALLED_NATIONAL
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
-
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
0-10 digits in length
ChargePartyStationType
Indicates the calling station type (based on the Originating Line Information Integrated Services Digital Network User Part (ISDNUP) parameter).
-
.value
- Type:
Integer
- Description:
Cause of the resource termination.
- Possible Values:
ChargePartyStationType.IDENTIFIED_LINE_NO_SPECIAL_TREATMENT
ChargePartyStationType.ONI_MULTIPARTY
ChargePartyStationType.ANI_FAILURE
ChargePartyStationType.HOTEL_WITHOUT_ROOM_ID
ChargePartyStationType.COINLESS_HOSPITAL_INMATE
ChargePartyStationType.INTERLATA_RESTRICTED
ChargePartyStationType.AIOD_LISTED_DN_SENT
ChargePartyStationType.IDENTIFIED_LINE_COIN_OR_NO_COIN
ChargePartyStationType.COIN_CALL
ChargePartyStationType.AIN
ChargePartyStationType.INTERLATA_RESTRICTED_HOTEL
ChargePartyStationType.INTERLATA_RESTRICTED_COINLESS
ChargePartyStationType.TEST_CALL
ClearCause
Indicates why a connection between a user and a resource was terminated.
-
.value
- Type:
Integer
- Description:
Cause of the resource termination.
- Possible Values:
ClearCause.NORMAL
ClearCause.TIMEOUT
ClearCause.RESOURCE_CANCELLED
ClearCause.UNANSWERED_LEG
ClearCause.INVALID_LEG
ClearCause.USER_ABANDON
ClearCause.INVALID_CODE
ClearCause.FAILURE
ClearCause.CALLED_PARTY_ANSWERED
ClearCause.RESOURCE_NOT_AVAILABLE
ClearCause.ISDN_TIMEOUT
ClearCause.RESOURCE_TYPE_NOT_SUPPORTED
ClearCause.TASK_REFUSED
ClearCause.INVALID_CALLER_RESPONSE
ClearCause.CAPABLITY_FAILURE
ClearCause.PROTOCOL_ERROR
ClearCause.ABORT
ClearCause.SUPP_SERVICE_INVOKED
ClearCause.STR_CANCELLED
ClearCause.TEMPORARY_FAILURE
ClearCause.IP_TIMEOUT
ClearCause.ORIGINATE_CALL
ClearCause.SPLIT_LEG
ClearCause.MOVE_LEG
ClearCause.MERGE_CALL
ClearCause.DISCONNECT_LEG
ClearCause.SUCCESS
ClearCause.RECONNECT
ClearCause.E_DPS_COMPLETED
ClearCause.CTR_CANCELLED
ClearCause.CALLED_PARTY_RECONNECT
ClearCause.UNEXPECTED_VALUE
ClearCause.DN_NOT_ACTIVE
ClearCause.MULTIPLE_ACTIVE_CALLS
CloseCause
Indicates the specific reason why a Close message is sent to end a Transaction Capabilities Application Part (TCAP) transaction between the Service Switching Point (SSP) and the Service Control Point (SCP)/Adjunct.
-
.value
- Type:
Integer
- Description:
Type of failure.
- Possible Values:
CloseCause.CALL_TERMINATED
CloseCause.E_DPS_COMPLETED
CloseCause.UNEXPECTED_COMMUNICATION
CloseCause.CALLED_PARTY_ANSWERED
CloseCause.CALL_FORWARDED_EDPS_COMPLETED
CloseCause.NEW_REQUESTED_EVENT
CNAM_ErrorCode
Indicates the reason why the requested operation failed.
-
.value
- Type:
Integer
- Description:
Reason the requested operation failed.
- Possible Values:
The unexpected data value.
CNAM_GenericName
Based on the ISDNUP Generic Name (GN) parameter.
Note
For more information, see GR-1188-CORE, LSSGR: CLASSSM Feature: Calling Name Delivery Generic Requirements.
-
.presentation
- Type:
Integer
- Description:
Presentation indicator associated with the generic name.
- Possible Values:
CNAM_GenericName.PRESENTATION_ALLOWED
CNAM_GenericName.PRESENTATION_RESTRICTED
CNAM_GenericName.PRESENTATION_BLOCKING_TOGGLE
CNAM_GenericName.PRESENTATION_NO_INDICATION
-
.Availability
- Type:
Integer
- Description:
Whether the name is available or unavailable.
- Possible Values:
-
-
.TypeOfName
- Type:
Integer
- Description:
Type of generic name which is the calling_name.
- Possible Values:
-
-
.name
- Type:
String
- Description:
Name of the calling party.
- Possible Values:
0-15 characters in length
CNAM_ServiceKey
Supports sending a 10-digit “calling directory number” in a query and/or sending a 6-digit controlled code for Automatic Call Gap (ACG) in a response message. In both instances, the format of the object is the same.
-
.TypeOfDigits
- Type:
Integer
- Description:
Type of digits to be sent.
- Possible Values:
CNAM_ServiceKey.NOT_USED
CNAM_ServiceKey.CALLED_PARTY_NUM_DIALED
CNAM_ServiceKey.CALLING_PARTY_NUM_ANI
CNAM_ServiceKey.CALLER_INTERACTION
CNAM_ServiceKey.ROUTING_NUMBER
CNAM_ServiceKey.BILLING_NUMBER
CNAM_ServiceKey.DESTINATION_NUMBER
CNAM_ServiceKey.LATA
CNAM_ServiceKey.CARRIER
CNAM_ServiceKey.LAST_CALLING_PARTY
CNAM_ServiceKey.LAST_PARTY_CALLED
CNAM_ServiceKey.CALLING_DIRECTORY_NUMBER
CNAM_ServiceKey.VMSR_IDENTIFIER
CNAM_ServiceKey.ORIGINAL_CALLED_NUMBER
CNAM_ServiceKey.REDIRECTING_NUMBER
CNAM_ServiceKey.CONNECTED_NUMBER
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit 1 = 0
International - Bit 1 = 1
Presentation Allowed - Bit 2 = 0
Presentation Restricted - Bit 2 = 1
- Possible Values:
CNAM_ServiceKey.NATIONAL_NUM_PRES_ALLOWED
CNAM_ServiceKey.INTERNATIONAL_NUM_PRES_ALLOWED
CNAM_ServiceKey.NATIONAL_NUM_PRES_RESTRICTED
CNAM_ServiceKey.INTERNATIONAL_NUM_PRES_RESTRICTED
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
CNAM_ServiceKey.UNKNOWN_NOT_APPLICABLE
CNAM_ServiceKey.ISDN_NUMBERING_PLAN
CNAM_ServiceKey.TELEPHONY_NUMBERING_PLAN
CNAM_ServiceKey.DATA_NUMBERING_PLAN
CNAM_ServiceKey.TELEX_NUMBERING_PLAN
CNAM_ServiceKey.MARITIME_MOBILE_NUMBERING_PLAN
CNAM_ServiceKey.LAND_MOBILE_NUMBERING_PLAN
CNAM_ServiceKey.PRIVATE_NUMBERING_PLAN
-
.EncodingScheme
- Type:
Integer
- Description:
Type of encoding used for the digits property.
- Possible Values:
CNAM_ServiceKey.BCD
CNAM_ServiceKey.IA5
-
.digits
- Type:
String
- Description:
Digits of the calling directory number or of the ACG controlled value.
- Possible Values:
6 or 10 digits in length
CollectedAddressInfo
Provides the address information collected from the user.
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit A = 0
International - Bit A = 1
No Presentation Restricted - Bit B =0
Presentation Restricted - Bit B=1
- Possible Values:
CollectedAddressInfo.UNKNOWN_OR_NOT_APPLICABLE
CollectedAddressInfo.SUBSCRIBER_NUMBER
CollectedAddressInfo.NATIONAL_SPARE
CollectedAddressInfo.NATIONAL_NUMBER
CollectedAddressInfo.INTERNATIONAL_NUMBER
CollectedAddressInfo.SUBSCRIBER_NUMBER_OP_REQ
CollectedAddressInfo.NATIONAL_NUMBER_OP_REQ
CollectedAddressInfo.INTERNATIONAL_NUMBER_OP_REQ
CollectedAddressInfo.NO_ADDRESS_PRESENT_OP_REQ
CollectedAddressInfo.NO_ADDRESS_PRESENT_CUT_THROUGH
CollectedAddressInfo.LOCAL_EXCHANGE_OR_HOTEL_950
CollectedAddressInfo.TEST_LINE_TEST_CODE
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
-
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
0-15 digits in length
CollectedDigits
Provides the digits collected from a user, which do not necessarily correspond to an address.
-
.nature_of_number
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.numbering_plan
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
0-32 digits in length
ConnectTime
Indicates the time elapsed between the answer and disconnect.
-
.minutes
- Type:
Integer
- Description:
Minutes from answer to disconnect.
- Possible Values:
0-99999
-
.seconds
- Type:
Integer
- Description:
Seconds from answer to disconnect.
- Possible Values:
0-99
-
.tenths
- Type:
Integer
- Description:
Tenths of seconds from answer to disconnect.
- Possible Values:
0-9
DestinationAddress
Provides the Directory Number (DN) of an intelligent peripheral.
-
.nature_of_number
- Type:
Integer
- Description:
Default value is national (significant) number, which is the only valid value according to AIN specification GR 1299.
-
.numbering_plan
- Type:
Integer
- Description:
Default value is ISDN (telephony) Numbering Plan, which is the only valid value according to AIN specification GR 1299.
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
10 digits in length
DisconnectFlag
Indicates whether the SSP must disconnect a leg after a Send_To_Resource interaction is completed.
-
.value
- Type:
String
- Description:
Whether to disconnect the leg.
- Possible Values:
-
DisplayInformation (DisplayText)
Encodes the individual elements of a DisplayText parameter in the type property. DisplayInformation is an implicit sequence of DisplayText parameters.
-
.value
- Type:
String
- Description:
Whether to disconnect the leg.
- Possible Values:
DisplayInformation.TYPE_BLANK
DisplayInformation.TYPE_SKIP
DisplayInformation.TYPE_CONTINUATION
DisplayInformation.TYPE_CALLED_ADDRESS
DisplayInformation.TYPE_CAUSE
DisplayInformation.TYPE_PROGRESS_INDICATOR
DisplayInformation.TYPE_NOTIFICATION_INDICATOR
DisplayInformation.TYPE_PROMPT
DisplayInformation.TYPE_ACCUMULATED_DIGITS
DisplayInformation.TYPE_STATUS
DisplayInformation.TYPE_INBAND
DisplayInformation.TYPE_CALLING_ADDRESS
DisplayInformation.TYPE_REASON
DisplayInformation.TYPE_CALLING_PARTY_NAME
DisplayInformation.TYPE_CALLED_PARTY_NAME
DisplayInformation.TYPE_ORIGINAL_CALLED_NAME
DisplayInformation.TYPE_REDIRECTING_NAME
DisplayInformation.TYPE_CONNECTED_NAME
DisplayInformation.TYPE_ORIG_RESTRICTIONS
DisplayInformation.TYPE_DATE_TIME_OF_DAY
DisplayInformation.TYPE_CALL_APPEARANCE_ID
DisplayInformation.TYPE_FEATURE_ADDRESS
DisplayInformation.TYPE_REDIRECTION_NAME
DisplayInformation.TYPE_REDIRECTION_NUMBER
DisplayInformation.TYPE_REDIRECTING_NUMBER
DisplayInformation.TYPE_ORIGINAL_CALLED_NUMBER
DisplayInformation.TYPE_CONNECTED_NUMBER
DisplayInformation.TYPE_TEXT
DisplayInformation.TYPE_REDIRECTING_REASON
-
.value
- Type:
String
- Description:
Displayed value.
- Possible Values:
1-20 characters in length
DTMFDigitsDetected
Indicates how many DTMF digits were collected.
-
.nature_of_number
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.numbering_plan
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
4 digits in length
ExtendedRinging
Indicates whether the SSP should continue to alert the called party in a manner appropriate to the terminating interface when the caller is connected to the announcement during the Send_To_Resource procedures.
-
.value
- Type:
Integer
- Description:
Whether to continue to alert the called party.
- Possible Values:
-
FailureCause
Indicates that the received operation could not be performed due to the unavailability of a hardware or software resource, causing a failure to occur.
-
.value
- Type:
Integer
- Description:
Type of failure.
- Possible Values:
FailureCause.RATE_TO_HIGH
FailureCause.UNAVAILABLE_RESOURCES
FailureCause.AP_TIMEOUT
FailureCause.AP_BUSY
FailureCause.CHANNELS_BUSY
FailureCause.ABORT
FailureCause.RESOURCE_LIMITATION
FailureCause.APPLICATION_ERROR
FailureCause.SECURITY_ERROR
FailureCause.PROTOCOL_ERROR
FailureCause.TIMER_EXPIRED
FailureCause.TEMPORARY_FAILURE
FailureCause.MSRID_DOES_NOT_MATCH_USER_PROFILE
FailureCause.SEGMENTATION_ERROR
FailureCause.NCAS_DISALLOWED
FailureCause.CONTROL_ENCOUNTERED
FailureCause.IMPROPER_CODING
FailureCause.INAPPROPRIATE_CONDITION
FailureCause.INAPPROPRIATE_USER_INTERFACE
FailureCause.INAPPROPRIATE_LEG_MANIPULATION
FailureCause.CALLING_INTERFACE_BUSY
FailureCause.UPDATE_FAILURE
GenericAddressList (GenericAddress)
Encodes the individual elements of a GenericAddress parameter in the type property. GenericAddressList is an implicit sequence of GenericAddress parameters.
-
.type_of_address
- Type:
Integer
- Description:
Type of calling address.
- Possible Values:
GenericAddress.DIALED_NUMBER
GenericAddress.DESTINATION_NUMBER
GenericAddress.SUPP_USER_CALLING_ADDR_FAILED_SCREENING
GenericAddress.SUPP_USER_CALLING_ADDR_NOT_SCREENED
GenericAddress.COMPLETION_NUMBER
GenericAddress.PORTED_DIALED_NUMBER
-
.nature_of_address
- Type:
Integer
- Description:
Additional information about the calling address.
- Possible Values:
GenericAddress.UNIQUE_SUBSCRIBER_NUMBER
GenericAddress.UNIQUE_NATIONAL_NUMBER
GenericAddress.UNIQUE_INTERNATIONAL_NUMBER
GenericAddress.NONUNIQUE_SUBSCRIBER_NUMBER
GenericAddress.NONUNIQUE_NATIONAL_NUMBER
GenericAddress.NONUNIQUE_INTERNATIONAL_NUMBER
GenericAddress.TEST_LINE_TEST_CODE
GenericAddress.SUBSCRIBER_NUMBER
GenericAddress.NATIONAL_NUMBER
GenericAddress.INTERNATIONAL_NUMBER
GenericAddress.ABBREVIATED_NUMBER
-
.test_indicator
- Type:
Integer
- Description:
Whether this is a test call.
- Possible Values:
-
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
-
-
.presentation
- Type:
Integer
- Description:
Presentation indicator associated with the digits.
- Possible Values:
-
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
1-16 digits in length
GenericAddress Example
To construct a GenericAddress parameter suitable for passing into the PAC in the session variable genericaddress, the JavaScript will look like the following:
// Construct individual GenericAddressList elements
var GA0 = new GenericAddressList;
GA0.type_of_address = GenericAddressList.DIALED_NUMBER;
GA0.nature_of_address = GenericAddressList.UNIQUE_SUBSCRIBER_NUMBER;
GA0.test_indicator = GenericAddressList.NOT_A_TEST_CALL;
GA0.numbering_plan = GenericAddressList.ISDN_NUMBERING_PLAN;
GA0.presentation = GenericAddressList.PRESENTAION_ALLOWED;
GA0.digits = "2225551212"
var GA1 = new GenericAddressList;
GA1.type_of_address = GenericAddressList.DESTINATION_NUMBER;
GA1.nature_of_address = GenericAddressList.NONUNIQUE_SUBSCRIBER_NUMBER;
GA1.test_indicator = GenericAddressList.NOT_A_TEST_CALL;
GA1.numbering_plan = GenericAddressList.PRIVATE_NUMBERING_PLAN;
GA1.presentation = GenericAddressList.PRESENTAION_RESTRICTED;
GA1.digits = "7896789999"
// Assign each encoded element to consecutive indexes as an array.
Session.genericaddress[0] = GA0.encode();
Session.genericaddress[1] = GA1.encode();
Lata
Identifies the Local Access and Transport Area (LATA).
-
.nature_of_number
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.numbering_plan
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
3 digits in length
NS800_BillingIndicator
Provides the Automatic Message Accounting (AMA) call type and service feature identifier for the primary trunk group and for services when the primary trunk group is not provided.
-
.AmaCallType
- Type:
String
- Description:
Type of call to be billed.
- Possible Values:
3 digits in length
-
.ServiceFeatureIdentification
- Type:
String
- Description:
Service feature to be billed.
- Possible Values:
3 digits in length
NS800_CarrierID
Supports sending a 10-digit “calling directory number” in a query and/or sending a 6-digit controlled code for Automatic Call Gap (ACG) in a response message. In both instances, the format of the object is the same.
-
.TypeOfDigits
- Type:
Integer
- Description:
Type of digits to be sent.
- Possible Values:
NS800_CarrierID.NOT_USED
NS800_CarrierID.CALLED_PARTY_NUM_DIALED
NS800_CarrierID.CALLING_PARTY_NUM_ANI
NS800_CarrierID.CALLER_INTERACTION
NS800_CarrierID.ROUTING_NUMBER
NS800_CarrierID.BILLING_NUMBER
NS800_CarrierID.DESTINATION_NUMBER
NS800_CarrierID.LATA
NS800_CarrierID.CARRIER
NS800_CarrierID.LAST_CALLING_PARTY
NS800_CarrierID.LAST_PARTY_CALLED
NS800_CarrierID.CALLING_DIRECTORY_NUMBER
NS800_CarrierID.VMSR_IDENTIFIER
NS800_CarrierID.ORIGINAL_CALLED_NUMBER
NS800_CarrierID.REDIRECTING_NUMBER
NS800_CarrierID.CONNECTED_NUMBER
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit 1 = 0
International - Bit 1 = 1
Presentation Allowed - Bit 2 = 0
Presentation Restricted - Bit 2 = 1
- Possible Values:
NS800_CarrierID.NATIONAL_NUM_PRES_ALLOWED
NS800_CarrierID.INTERNATIONAL_NUM_PRES_ALLOWED
NS800_CarrierID.NATIONAL_NUM_PRES_RESTRICTED
NS800_CarrierID.INTERNATIONAL_NUM_PRES_RESTRICTED
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
NS800_CarrierID.UNKNOWN_NOT_APPLICABLE
NS800_CarrierID.ISDN_NUMBERING_PLAN
NS800_CarrierID.TELEPHONY_NUMBERING_PLAN
NS800_CarrierID.DATA_NUMBERING_PLAN
NS800_CarrierID.TELEX_NUMBERING_PLAN
NS800_CarrierID.MARITIME_MOBILE_NUMBERING_PLAN
NS800_CarrierID.LAND_MOBILE_NUMBERING_PLAN
NS800_CarrierID.PRIVATE_NUMBERING_PLAN
-
.EncodingScheme
- Type:
Integer
- Description:
Type of encoding used for the digits property.
- Possible Values:
NS800_CarrierID.BCD
NS800_CarrierID.IA5
-
.digits
- Type:
String
- Description:
Digits of the calling directory number or of the ACG controlled value.
- Possible Values:
6 or 10 digits in length
NS800_CallingPartyNumber
Supports sending a 10-digit “calling directory number” in a query and/or sending a 6-digit controlled code for Automatic Call Gap (ACG) in a response message. In both instances, the format of the object is the same.
-
.TypeOfDigits
- Type:
Integer
- Description:
Type of digits to be sent.
- Possible Values:
-
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
NS800_CallingPartyID.UNKNOWN_NOT_APPLICABLE
NS800_CallingPartyID.ISDN_NUMBERING_PLAN
NS800_CallingPartyID.TELEPHONY_NUMBERING_PLAN
NS800_CallingPartyID.DATA_NUMBERING_PLAN
NS800_CallingPartyID.TELEX_NUMBERING_PLAN
NS800_CallingPartyID.MARITIME_MOBILE_NUMBERING_PLAN
NS800_CallingPartyID.LAND_MOBILE_NUMBERING_PLAN
NS800_CallingPartyID.PRIVATE_NUMBERING_PLAN
-
.EncodingScheme
- Type:
Integer
- Description:
Type of encoding used for the digits property.
- Possible Values:
NS800_CallingPartyID.BCD
NS800_CallingPartyID.IA5
-
.digits
- Type:
String
- Description:
Digits of the calling directory number or of the Automatic Call Gap (ACG) controlled value.
- Possible Values:
6 or 10 digits in length
NS800_Lata
Supports sending a 10-digit “calling directory number” in a query and/or sending a 6-digit controlled code for Automatic Call Gap (ACG) in a response message. In both instances, the format of the object is the same.
-
.TypeOfDigits
- Type:
Integer
- Description:
Type of digits to be sent.
- Possible Values:
-
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit 1 = 0
International - Bit 1 = 1
Presentation Allowed - Bit 2 = 0
Presentation Restricted - Bit 2 = 1
- Possible Values:
NS800_Lata.NATIONAL_NUM_PRES_ALLOWED
NS800_Lata.INTERNATIONAL_NUM_PRES_ALLOWED
NS800_Lata.NATIONAL_NUM_PRES_RESTRICTED
NS800_Lata.INTERNATIONAL_NUM_PRES_RESTRICTED
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
NS800_Lata.UNKNOWN_NOT_APPLICABLE
NS800_Lata.ISDN_NUMBERING_PLAN
NS800_Lata.TELEPHONY_NUMBERING_PLAN
NS800_Lata.DATA_NUMBERING_PLAN
NS800_Lata.TELEX_NUMBERING_PLAN
NS800_Lata.MARITIME_MOBILE_NUMBERING_PLAN
NS800_Lata.LAND_MOBILE_NUMBERING_PLAN
NS800_Lata.PRIVATE_NUMBERING_PLAN
-
.EncodingScheme
- Type:
Integer
- Description:
Type of encoding used for the digits property.
- Possible Values:
NS800_Lata.BCD
NS800_Lata.IA5
-
.digits
- Type:
String
- Description:
Digits of the calling directory number or of the Automatic Call Gap (ACG) controlled value.
- Possible Values:
6 or 10 digits in length
NS800_OriginatingStationType
Provides the binary equivalent of the ANI II digits and identifies characteristics of the calling line.
-
.value
- Type:
Integer
- Description:
Existing ANI II values can be found in the Local Exchange Routing Guide (LERG).
NS800_RoutingNumber
Supports sending a 10-digit “calling directory number” in a query and/or sending a 6-digit controlled code for Automatic Call Gap (ACG) in a response message. In both instances, the format of the object is the same.
-
.TypeOfDigits
- Type:
Integer
- Description:
Type of digits to be sent.
- Possible Values:
-
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit 1 = 0
International - Bit 1 = 1
Presentation Allowed - Bit 2 = 0
Presentation Restricted - Bit 2 = 1
- Possible Values:
NS800_RoutingNumber.NATIONAL_NUM_PRES_ALLOWED
NS800_RoutingNumber.INTERNATIONAL_NUM_PRES_ALLOWED
NS800_RoutingNumber.NATIONAL_NUM_PRES_RESTRICTED
NS800_RoutingNumber.INTERNATIONAL_NUM_PRES_RESTRICTED
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
NS800_RoutingNumber.UNKNOWN_NOT_APPLICABLE
NS800_RoutingNumber.ISDN_NUMBERING_PLAN
NS800_RoutingNumber.TELEPHONY_NUMBERING_PLAN
NS800_RoutingNumber.DATA_NUMBERING_PLAN
NS800_RoutingNumber.TELEX_NUMBERING_PLAN
NS800_RoutingNumber.MARITIME_MOBILE_NUMBERING_PLAN
NS800_RoutingNumber.LAND_MOBILE_NUMBERING_PLAN
NS800_RoutingNumber.PRIVATE_NUMBERING_PLAN
-
.EncodingScheme
- Type:
Integer
- Description:
Type of encoding used for the digits property.
- Possible Values:
NS800_RoutingNumber.BCD
NS800_RoutingNumber.IA5
-
.digits
- Type:
String
- Description:
Digits of the calling directory number or of the Automatic Call Gap (ACG) controlled value.
- Possible Values:
6 or 10 digits in length
NS800_ServiceKey
Supports sending a 10-digit “calling directory number” in a query and/or sending a 6-digit controlled code for Automatic Call Gap (ACG) in a response message. In both instances, the format of the object is the same.
-
.TypeOfDigits
- Type:
Integer
- Description:
Type of digits to be sent.
- Possible Values:
NS800_ServiceKey.NOT_USED
NS800_ServiceKey.CALLED_PARTY_NUM_DIALED
NS800_ServiceKey.CALLING_PARTY_NUM_ANI
NS800_ServiceKey.CALLER_INTERACTION
NS800_ServiceKey.ROUTING_NUMBER
NS800_ServiceKey.BILLING_NUMBER
NS800_ServiceKey.DESTINATION_NUMBER
NS800_ServiceKey.LATA
NS800_ServiceKey.CARRIER
NS800_ServiceKey.LAST_CALLING_PARTY
NS800_ServiceKey.LAST_PARTY_CALLED
NS800_ServiceKey.CALLING_DIRECTORY_NUMBER
NS800_ServiceKey.VMSR_IDENTIFIER
NS800_ServiceKey.ORIGINAL_CALLED_NUMBER
NS800_ServiceKey.REDIRECTING_NUMBER
NS800_ServiceKey.CONNECTED_NUMBER
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit 1 = 0
International - Bit 1 = 1
Presentation Allowed - Bit 2 = 0
Presentation Restricted - Bit 2 = 1
- Possible Values:
NS800_ServiceKey.NATIONAL_NUM_PRES_ALLOWED
NS800_ServiceKey.INTERNATIONAL_NUM_PRES_ALLOWED
NS800_ServiceKey.NATIONAL_NUM_PRES_RESTRICTED
NS800_ServiceKey.INTERNATIONAL_NUM_PRES_RESTRICTED
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
NS800_ServiceKey.UNKNOWN_NOT_APPLICABLE
NS800_ServiceKey.ISDN_NUMBERING_PLAN
NS800_ServiceKey.TELEPHONY_NUMBERING_PLAN
NS800_ServiceKey.DATA_NUMBERING_PLAN
NS800_ServiceKey.TELEX_NUMBERING_PLAN
NS800_ServiceKey.MARITIME_MOBILE_NUMBERING_PLAN
NS800_ServiceKey.LAND_MOBILE_NUMBERING_PLAN
NS800_ServiceKey.PRIVATE_NUMBERING_PLAN
-
.EncodingScheme
- Type:
Integer
- Description:
Type of encoding used for the digits property.
- Possible Values:
NS800_ServiceKey.BCD
NS800_ServiceKey.IA5
-
.digits
- Type:
String
- Description:
Digits of the calling directory number or of the Automatic Call Gap (ACG) controlled value.
- Possible Values:
6 or 10 digits in length
ODTMFDigitsString
Indicates the digit sequence to be detected.
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit A = 0
International - Bit A = 1
No Presentation Restricted - Bit B =0
Presentation Restricted - Bit B=1
- Possible Values:
ODTMFDigitsString.UNKNOWN_OR_NOT_APPLICABLE
ODTMFDigitsString.UNIQUE_SUBSCRIBER_NUMBER
ODTMFDigitsString.UNIQUE_NATIONAL_NUMBER
ODTMFDigitsString.UNIQUE_INTERNATIONAL_NUMBER
ODTMFDigitsString.NONUNIQUE_SUBSCRIBER_NUMBER_OP_REQ
ODTMFDigitsString.NONUNIQUE_NATIONAL_NUMBER_OP_REQ
ODTMFDigitsString.NONUNIQUE_INTERNATIONAL_NUMBER_OP_REQ
ODTMFDigitsString.TEST_LINE_TEST_CODE
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
-
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
Integer
- Description:
Telephone number of the party.
- Possible Values:
1-4 digits in length
OriginalCalledPartyID
Provides the Directory Number (DN) of the original called, or first redirecting, party.
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit A = 0
International - Bit A = 1
No Presentation Restricted - Bit B =0
Presentation Restricted - Bit B=1
- Possible Values:
OriginalCalledPartyID.UNKNOWN_OR_NOT_APPLICABLE
OriginalCalledPartyID.UNIQUE_SUBSCRIBER_NUMBER
OriginalCalledPartyID.UNIQUE_NATIONAL_NUMBER
OriginalCalledPartyID.UNIQUE_INTERNATIONAL_NUMBER
OriginalCalledPartyID.NONUNIQUE_SUBSCRIBER_NUMBER_OP_REQ
OriginalCalledPartyID.NONUNIQUE_NATIONAL_NUMBER_OP_REQ
OriginalCalledPartyID.NONUNIQUE_INTERNATIONAL_NUMBER_OP_REQ
OriginalCalledPartyID.TEST_LINE_TEST_CODE
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
-
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
3-15 digits in length
OutpulseNumber
Provides the outpulse number for routing over private facilities.
-
.nature_of_number
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.numbering_plan
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
15 digits in length
PartyOnHold
Indicates that a party is to be placed on hold when a Send_To_Resource is received by the switch. The calling or called party is placed on hold based on the value of the PartyID in the same Send_To_Resource message.
A PartyID value of callingParty or no PartyID value causes the called party to be placed on hold. A PartyID value of calledParty causes the calling party to be placed on hold. A PartyID of allParties causes no party to be placed on hold because the Send_To_Resource message was directed toward all parties.
-
.value
- Type:
String
- Description:
Whether to place the party on hold.
- Possible Values:
-
PrimaryBillingIndicator
Provides the Automatic Message Accounting (AMA) call type and service feature identifier for the primary trunk group and for services when the primary trunk group is not provided. This object can also be used for the OverflowBillingIndicator.
-
.AmaCallType
- Type:
String
- Description:
Type of call to be billed.
- Possible Values:
3 digits in length
-
.ServiceFeatureIdentification
- Type:
String
- Description:
Service feature to be billed.
- Possible Values:
3 digits in length
PrimaryTrunkGroup
Provides a primary trunk group route index and is sent, along with AlternateTrunkGroup and SecondAlternateTrunkGroup, when a call is to be routed to a trunk group.
-
.NumToOutpulse
- Type:
Boolean
- Description:
Digits sent to the trunk group.
- Possible Values:
-
-
.SfgInd
- Type:
Boolean
- Description:
Restrictions on the number of simultaneous calls with the public network.
- Possible Values:
-
-
.CallTreatInd
- Type:
Integer
- Description:
Whether the call should overflow to the public network.
- Possible Values:
PrimaryTrunkGroup.NOT_USED
PrimaryTrunkGroup.NO_OVERFLOW_AND_NO_RETURN
PrimaryTrunkGroup.OVERFLOW
PrimaryTrunkGroup.OFF_HOOK_NO_OVERFLOW_AND_NO_RETURN
PrimaryTrunkGroup.OFF_HOOK_OVERFLOW
PrimaryTrunkGroup.RINGBACK_NO_OVERFLOW_AND_NO_RETURN
PrimaryTrunkGroup.RINGBACK_OVERFLOW
PrimaryTrunkGroup.RETURN
PrimaryTrunkGroup.OFF_HOOK_RETURN
PrimaryTrunkGroup.RINGBACK_RETURN
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
8 digits in length
RedirectingPartyID
Provides the Directory Number (DN) of the last redirecting party.
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit A = 0
International - Bit A = 1
No Presentation Restricted - Bit B =0
Presentation Restricted - Bit B=1
- Possible Values:
RedirectingPartyID.UNKNOWN_OR_NOT_APPLICABLE
RedirectingPartyID.UNIQUE_SUBSCRIBER_NUMBER
RedirectingPartyID.UNIQUE_NATIONAL_NUMBER
RedirectingPartyID.UNIQUE_INTERNATIONAL_NUMBER
RedirectingPartyID.NONUNIQUE_SUBSCRIBER_NUMBER_OP_REQ
RedirectingPartyID.NONUNIQUE_NATIONAL_NUMBER_OP_REQ
RedirectingPartyID.NONUNIQUE_INTERNATIONAL_NUMBER_OP_REQ
RedirectingPartyID.TEST_LINE_TEST_CODE
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
-
-
.presentation
- Type:
Integer
- Description:
Presentation indicator associated with the digits.
- Possible Values:
RedirectingPartyID.PRESENTATION_ALLOWED
RedirectingPartyID.PRESENTATION_RESTRICTED
RedirectingPartyID.PRESENTATION_NUMBER_UNAVAILABLE
-
.screening
- Type:
Integer
- Description:
Screening indicator associated with the digits.
- Possible Values:
RedirectingPartyID.USER_PROVIDED_NOT_SCREENED
RedirectingPartyID.USER_PROVIDED_PASSED_SCREENING
RedirectingPartyID.USER_PROVIDED_FAILED_SCREENING
RedirectingPartyID.NETWORK_PROVIDED_NO_SCREENING
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
3-15 digits in length
ResourceType
Indicates the type of resource to which a user is to be connected.
-
.value
- Type:
Integer
- Description:
Resource to connect a user to.
- Possible Values:
ResourceType.PLAY_ANNOUNCEMENTS
ResourceType.PLAY_ANNOUNCEMENTS_AND_COLLECT_DIGITS
ResourceType.TEXT_TO_SPEECH
ResourceType.TEXT_TO_SPEECH_AND_COLLECT_DIGITS
ResourceType.FLEX_PARAMETER_BLOCK
RTPReroutingNumber
Provides a new destination address to the Service Switching Point (SSP) when the call is destined for an SSP other than itself.
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit A = 0
International - Bit A = 1
No Presentation Restricted - Bit B =0
Presentation Restricted - Bit B=1
- Possible Values:
RTPReroutingNumber.UNKNOWN_OR_NOT_APPLICABLE
RTPReroutingNumber.UNIQUE_SUBSCRIBER_NUMBER
RTPReroutingNumber.UNIQUE_NATIONAL_NUMBER
RTPReroutingNumber.UNIQUE_INTERNATIONAL_NUMBER
RTPReroutingNumber.NONUNIQUE_SUBSCRIBER_NUMBER_OP_REQ
RTPReroutingNumber.NONUNIQUE_NATIONAL_NUMBER_OP_REQ
RTPReroutingNumber.NONUNIQUE_INTERNATIONAL_NUMBER_OP_REQ
RTPReroutingNumber.TEST_LINE_TEST_CODE
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
-
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
3-15 digits in length
SecondAlternateBillingIndicator
Provides the Automatic Message Accounting (AMA) call type and service feature identifier for the second alternate trunk group.
-
.AmaCallType
- Type:
String
- Description:
AMA call type assigned to the alternate trunk group.
- Possible Values:
3 digits in length
-
.ServiceFeatureIdentification
- Type:
String
- Description:
Service associated with the alternate trunk group.
- Possible Values:
3 digits in length
SecondAlternateCarrier
Provides the second alternate carrier selection information and that carrier’s identification code.
-
.CarrierSelection
- Type:
Integer
- Description:
How the alternate carrier is to be specified.
- Possible Values:
SecondAlternateCarrier.NO_INDICATION
SecondAlternateCarrier.PRESUBSCRIBED_AND_NOT_INPUT_BY_CALLING
SecondAlternateCarrier.PRESUBSCRIBED_AND_INPUT_BY_CALLING
SecondAlternateCarrier.PRESUBSCRIBED_AND_NO_INDICATION
SecondAlternateCarrier.NOT_PRESUBSCRIBED_AND_INPUT_BY_CALLING
-
.NatureOfCarrier
- Type:
Integer
- Description:
Type of alternate carrier.
- Possible Values:
SecondAlternateCarrier.NO_NOC_PROVIDED
SecondAlternateCarrier.LOCAL
SecondAlternateCarrier.INTRA_LATA_TOLL
SecondAlternateCarrier.INTRA_LATA
SecondAlternateCarrier.LOCAL_INTRA_LATA_TOLL_AND_INTER_LATA
SecondAlternateCarrier.LOCAL_AND_INTRA_LATA_TOLL
SecondAlternateCarrier.INTRA_LATA_TOLL_AND_INTER_LATA
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
4 digits in length
SecondAlternateTrunkGroup
Provides a second alternate trunk group route index and is sent, along with AlternateTrunkGroup and PrimaryTrunkGroup, when a call is to be routed to a trunk group.
-
.NumToOutpulse
- Type:
Boolean
- Description:
Digits sent to the trunk group.
- Possible Values:
-
-
.SfgInd
- Type:
Boolean
- Description:
Restrictions on the number of simultaneous calls with the public network.
- Possible Values:
-
-
.CallTreatInd
- Type:
Integer
- Description:
Whether the call should overflow to the public network.
- Possible Values:
SecondAlternateTrunkGroup.NOT_USED
SecondAlternateTrunkGroup.NO_OVERFLOW_AND_NO_RETURN
SecondAlternateTrunkGroup.OVERFLOW
SecondAlternateTrunkGroup.OFF_HOOK_NO_OVERFLOW_AND_NO_RETURN
SecondAlternateTrunkGroup.OFF_HOOK_OVERFLOW
SecondAlternateTrunkGroup.RINGBACK_NO_OVERFLOW_AND_NO_RETURN
SecondAlternateTrunkGroup.RINGBACK_OVERFLOW
SecondAlternateTrunkGroup.RETURN
SecondAlternateTrunkGroup.OFF_HOOK_RETURN
SecondAlternateTrunkGroup.RINGBACK_RETURN
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
8 digits in length
StrParameterBlock
Provides the information that a Service Switching Point (SSP) or IP needs for the capability specified.
-
.MaximumDigits
- Type:
Integer
- Description:
Maximum number of digits in the parameter block.
- Possible Values:
0-255
-
.UninterAnnounceBlock
- Type:
String
- Description:
Array of AnnounceElement objects.
- Possible Values:
0-10 AnnounceElement arrays
-
.InterAnnounceBlock
- Type:
String
- Description:
Array of AnnounceElement objects.
- Possible Values:
0-10 AnnounceElement arrays
-
.type
- Type:
Integer
- Description:
Type of parameter block.
- Possible Values:
StrParameterBlock.TYPE_ANNOUNCEMENT
StrParameterBlock.TYPE_ANNOUNCEMENT_COLLECT
StrParameterBlock.TYPE_FLEX_PARAM
AnnounceElement
Note
There are no encode and decode methods for AnnounceElement because it is only used as an element in the arrays for StrParameterBlock.
-
.AnnouncementID
- Type:
Integer
- Description:
Announcement to be made.
- Possible Values:
4 digits in length
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
0-255 digits in length
TcapDigits
Supports sending a 10-digit “calling directory number” in a query and/or sending a 6-digit controlled code for Automatic Call Gap (ACG) in a response message. In both instances, the format of the object is the same.
-
.TypeOfDigits
- Type:
Integer
- Description:
Type of digits to be sent.
- Possible Values:
TcapDigits.NOT_USED
TcapDigits.CALLED_PARTY_NUM_DIALED
TcapDigits.CALLING_PARTY_NUM_ANI
TcapDigits.CALLER_INTERACTION
TcapDigits.ROUTING_NUMBER
TcapDigits.BILLING_NUMBER
TcapDigits.DESTINATION_NUMBER
TcapDigits.LATA
TcapDigits.CARRIER
TcapDigits.LAST_CALLING_PARTY
TcapDigits.LAST_PARTY_CALLED
TcapDigits.CALLING_DIRECTORY_NUMBER
TcapDigits.VMSR_IDENTIFIER
TcapDigits.ORIGINAL_CALLED_NUMBER
TcapDigits.REDIRECTING_NUMBER
TcapDigits.CONNECTED_NUMBER
-
.nature_of_number
- Type:
Integer
- Description:
Additional information on the type of digits, coded as a bitmap.
National - Bit 1 = 0
International - Bit 1 = 1
Presentation Allowed - Bit 2 = 0
Presentation Restricted - Bit 2 = 1
- Possible Values:
TcapDigits.NATIONAL_NUM_PRES_ALLOWED
TcapDigits.INTERNATIONAL_NUM_PRES_ALLOWED
TcapDigits.NATIONAL_NUM_PRES_RESTRICTED
TcapDigits.INTERNATIONAL_NUM_PRES_RESTRICTED
-
.numbering_plan
- Type:
Integer
- Description:
Numbering plan associated with the digits.
1 HGFE/0000 - Unknown or Not Applicable
2 HGFE/0001 - ISDN Numbering Plan (CCITT Recommendation E.164)
3 HGFE/0010 - Telephony Numbering Plan (CCITT Recommendation E.164)
4 HGFE/0011 - Data Numbering Plan (CCITT Recommendation X.121)
5 HGFE/0100 - Telex Numbering Plan (CCITT Recommendation F.69)
6 HGFE/0101 - Maritime Mobile Numbering Plan (CCITT Recommendation E.210, 211)
7 HGFE/0110 - Land Mobile Numbering Plan (CCITT Recommendation E.212, 213)
8 HGFE/0111 - Private Numbering Plan (Service Provider Defined)
- Possible Values:
TcapDigits.UNKNOWN_NOT_APPLICABLE
TcapDigits.ISDN_NUMBERING_PLAN
TcapDigits.TELEPHONY_NUMBERING_PLAN
TcapDigits.DATA_NUMBERING_PLAN
TcapDigits.TELEX_NUMBERING_PLAN
TcapDigits.MARITIME_MOBILE_NUMBERING_PLAN
TcapDigits.LAND_MOBILE_NUMBERING_PLAN
TcapDigits.PRIVATE_NUMBERING_PLAN
-
.EncodingScheme
- Type:
Integer
- Description:
Type of encoding used for the digits property.
- Possible Values:
TcapDigits.BCD
TcapDigits.IA5
-
.digits
- Type:
String
- Description:
Digits of the calling directory number or of the Automatic Call Gap (ACG) controlled value.
- Possible Values:
6 or 10 digits in length
Tcm
Provides the Traveling Class Mark (TCM) for the user. Traveling Class Marks allow users in a private network to access features and services based on their Class of Service (COS), Class of Restriction (COR), and Interconnect Number rather than on the features of the incoming trunk.
-
.nature_of_number
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.numbering_plan
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
2 digits in length
TerminationIndicator
Provides a yes or no value for a particular indicator identified in the ASN.1 information.
-
.RerouteInd
- Type:
Boolean
- Description:
Whether the call was rerouted.
- Possible Values:
-
-
.RerouteInd
- Type:
Boolean
- Description:
Whether display text was provided.
- Possible Values:
-
-
.RerouteInd
- Type:
Boolean
- Description:
Whether an exception has occurred.
- Possible Values:
-
-
.DisplayTextInd
- Type:
Boolean
- Description:
Whether an unrelated error has occurred.
- Possible Values:
-
-
.UnrelatedErrorInd
- Type:
Boolean
- Description:
Whether the call could not be presented to the terminating party.
- Possible Values:
-
-
.AnswerInd
- Type:
Boolean
- Description:
Whether the call was answered.
- Possible Values:
-
-
.NMControlListOverflowInd
- Type:
Boolean
- Description:
Whether the call is on the NM Control List Overflow.
- Possible Values:
-
TriggerCriteriaFlag
Indicates whether a trigger should be active or inactive.
-
.type
- Type:
Integer
- Description:
Type of criteria flag.
- Possible Values:
TriggerCriteriaFlag.FEATURE_ACTIVATOR
TriggerCriteriaFlag.VERTICAL_SERVICE_CODE
TriggerCriteriaFlag.CUSTOMIZED_ACCESS
TriggerCriteriaFlag.CUSTOMIZED_INTERCOM
TriggerCriteriaFlag.NPA
TriggerCriteriaFlag.NPA_NXX
TriggerCriteriaFlag.NXX
TriggerCriteriaFlag.NXX_XXXX
TriggerCriteriaFlag.NPA_NXX_XXXX
TriggerCriteriaFlag.COUNTRY_CODE_NPA_NXX_XXXX
TriggerCriteriaFlag.CARRIER_ACCESS
TriggerCriteriaFlag.PREFIXES
TriggerCriteriaFlag.N11
TriggerCriteriaFlag.AFR
TriggerCriteriaFlag.SHARED_INTEROFFICE_TRUNK
TriggerCriteriaFlag.TERMINATION_ATTEMPT
TriggerCriteriaFlag.OFF_HOOK_IMMEDIATE
TriggerCriteriaFlag.OFF_HOOK_DELAYED
TriggerCriteriaFlag.CHANNEL_SETUP_PRI
TriggerCriteriaFlag.NPA_N
TriggerCriteriaFlag.NPA_NX
TriggerCriteriaFlag.NPA_NXXX
TriggerCriteriaFlag.NPA_NXXXX
TriggerCriteriaFlag.NPA_NXXXXX
TriggerCriteriaFlag.NETWORK_BUSY
TriggerCriteriaFlag.T_NO_ANSWER
TriggerCriteriaFlag.T_BUSY
TriggerCriteriaFlag.O_CALLED_PARTY_BUSY
TriggerCriteriaFlag.SPECIFIC_FEATURE_CODE
TriggerCriteriaFlag.O_NO_ANSWER
TriggerCriteriaFlag.PRI_NETWORK_SERVICES
-
.flag
- Type:
Integer
- Description:
Whether to activate the flag.
- Possible Values:
-
TriggerCriteriaType
Indicates the type of event that caused a trigger to occur.
-
.value
- Type:
Integer
- Description:
Type of trigger event.
- Possible Values:
TriggerCriteriaType.FEATURE_ACTIVATOR
TriggerCriteriaType.VERTICAL_SERVICE_CODE
TriggerCriteriaType.CUSTOMIZED_ACCESS
TriggerCriteriaType.CUSTOMIZED_INTERCOM
TriggerCriteriaType.NPA
TriggerCriteriaType.NPA_NXX
TriggerCriteriaType.NXX
TriggerCriteriaType.NXXXXXX
TriggerCriteriaType.NPA_NXXXXXX
TriggerCriteriaType.COUNTRY_CODE_NPA_NXXXXXX
TriggerCriteriaType.CARRIER_ACCESS
TriggerCriteriaType.PREFIXES
TriggerCriteriaType.N11
TriggerCriteriaType.A_FR
TriggerCriteriaType.SHARED_IO_TRUNK
TriggerCriteriaType.TERMINATION_ATTEMPT
TriggerCriteriaType.OFF_HOOK_IMMEDIATE
TriggerCriteriaType.OFF_HOOK_DELAY
TriggerCriteriaType.CHANNEL_SETUP_PRI
TriggerCriteriaType.NPA_N
TriggerCriteriaType.NPA_NX
TriggerCriteriaType.NPA_NXXX
TriggerCriteriaType.NPA_NXXXX
TriggerCriteriaType.NPA_NXXXXX
TriggerCriteriaType.NETWORK_BUSY
TriggerCriteriaType.T_NO_ANSWER
TriggerCriteriaType.PRI_NETWORK_SERVICES
TriggerCriteriaType.O_SWITCH_HOOK_FLASH_IMMEDIATE
TriggerCriteriaType.O_FEATURE_ACTIVATOR
TriggerCriteriaType.O_SWITCH_HOOK_FLASH_SPECIFIED_CODE
TriggerCriteriaType.T_SWITCH_HOOK_FLASH_IMMEDIATE
TriggerCriteriaType.T_FEATURE_ACTIVATOR
TriggerCriteriaType.T_SWITCH_HOOK_SPECIFIED_CODE
TriggerCriteriaType.NUMBER_PORTABILITY
TriggerCriteriaType.ONE_PLUS
TriggerCriteriaType.SPECIFIED_CARRIER
TriggerCriteriaType.INTERNATIONAL
TriggerCriteriaType.ZERO_PLUS
TriggerCriteriaType.ZERO_MINUS
TriggerCriteriaType.LOCAL_NUMBER_PORTABILITY_PORC
TriggerCriteriaType.LOCAL_NUMBER_PORTABILITY_PORC_DONOR
TriggerCriteriaType.TERM_RESOURCE_AVAILABLE
TriggerCriteriaType.OFFICE_PUBLIC_FEATURE_CODE
TriggerCriteriaType.TRUNK_GROUP
TriggerCriteriaType.DEDICATED_TRUNK_GROUP
UserID
Provides an identifier for a user.
-
.type
- Type:
Integer
- Description:
Type of user.
- Possible Values:
-
-
.Dn
- Type:
String
- Description:
Directory number of the user.
- Possible Values:
10 digits in length
-
.Spid
- Type:
String
- Description:
Initialized terminals assigned to the interface.
- Possible Values:
3-20 characters in length
Note
The last two characters are required to be numeric in the range of 00-62.
-
.TrunkGroupID
- Type:
Integer
- Description:
Set of trunks that provide the user with access.
- Possible Values:
0-9999
-
.PrivateFacilityGID
- Type:
Integer
- Description:
Trunk group that is going to provide access to the private facility.
- Possible Values:
0-9999
-
.ADSIcpeID
- Type:
Integer
- Description:
Analog Display Services Interface customer premise equipment identifier.
- Possible Values:
8 digits in length
-
.Ssp
- Type:
String
- Description:
Service switching point for the user.
- Possible Values:
0-8 characters in length
-
.DialingPlan
- Type:
String
- Description:
Sequence of digits dialed to access to specific telephone networks or activate specific telephone system features.
- Possible Values:
0-8 characters in length
VerticalServiceCode
Provides the vertical service code for the information collected from the user.
-
.nature_of_number
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.numbering_plan
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.presentation
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.screening
- Type:
Integer
- Description:
Not used in AIN specification GR 1299. The value defaults to 0.
-
.digits
- Type:
String
- Description:
Telephone number of the party.
- Possible Values:
0-10 digits in length