PromptAndCollectUserInformation CS2

Introduction

The N-Squared ASN.1 codec for the INAP PromptAndCollectUserInformation CS2 operation supports the following argument attributes for encode/decode.

These attributes are used when variant = ‘cs2’.

Field Type Description
<anon> Object SEQUENCE, UNIVERSAL 16, IMPLICIT, Tag Byte = 30
This element is a sequence which contains one or more of the following elements.
[Required]: This element is required to be present.
.collectedInfo Object CHOICE, CONTEXT 0, Tag Byte = a0
This element is a choice. Specify at most one of the following options.
[Required]: This element is required to be present whenever the containing element is present.
.collectedDigits Object SEQUENCE, CONTEXT 0, IMPLICIT, Tag Byte = a0
This element is a sequence which contains one or more of the following elements.
This element is one of the possible alternatives for the containing CHOICE.
.minimumNbOfDigits 1 - 127 INTEGER, CONTEXT 0, IMPLICIT, Tag Byte = 80
The value is an integer within the indicated range.
[Decode Default]: 1
.maximumNbOfDigits 1 - 127 INTEGER, CONTEXT 1, IMPLICIT, Tag Byte = 81
The value is an integer within the indicated range.
[Required]: This element is required to be present whenever the containing element is present.
.endOfReplyDigit Binary String OCTET STRING, CONTEXT 2, IMPLICIT, Tag Byte = 82
The value is the raw encoded bytes for this element.
.cancelDigit Binary String OCTET STRING, CONTEXT 3, IMPLICIT, Tag Byte = 83
The value is the raw encoded bytes for this element.
.startDigit Binary String OCTET STRING, CONTEXT 4, IMPLICIT, Tag Byte = 84
The value is the raw encoded bytes for this element.
.firstDigitTimeOut 1 - 127 INTEGER, CONTEXT 5, IMPLICIT, Tag Byte = 85
The value is an integer within the indicated range.
.interDigitTimeOut 1 - 127 INTEGER, CONTEXT 6, IMPLICIT, Tag Byte = 86
The value is an integer within the indicated range.
.errorTreatment 0 - 4294967295 ENUMERATED, CONTEXT 7, IMPLICIT, Tag Byte = 87
The value is an integer within the indicated range.
.interruptableAnnInd 0 / 1 BOOLEAN, CONTEXT 8, IMPLICIT, Tag Byte = 88
Values are represented as integer 0 (false) or 1 (true).
[Decode Default]: 1
.voiceInformation 0 / 1 BOOLEAN, CONTEXT 9, IMPLICIT, Tag Byte = 89
Values are represented as integer 0 (false) or 1 (true).
.voiceBack 0 / 1 BOOLEAN, CONTEXT 10, IMPLICIT, Tag Byte = 8a
Values are represented as integer 0 (false) or 1 (true).
.iA5Information 0 / 1 BOOLEAN, CONTEXT 1, IMPLICIT, Tag Byte = 81
Values are represented as integer 0 (false) or 1 (true).
This element is one of the possible alternatives for the containing CHOICE.
.disconnectFromIPForbidden 0 / 1 BOOLEAN, CONTEXT 1, IMPLICIT, Tag Byte = 81
Values are represented as integer 0 (false) or 1 (true).
[Decode Default]: 1
.informationToSend Object CHOICE, CONTEXT 2, Tag Byte = a2
This element is a choice. Specify at most one of the following options.
[Required]: This element is required to be present whenever the containing element is present.
.inbandInfo Object SEQUENCE, CONTEXT 0, IMPLICIT, Tag Byte = a0
This element is a sequence which contains one or more of the following elements.
This element is one of the possible alternatives for the containing CHOICE.
.messageID Object CHOICE, CONTEXT 0, Tag Byte = a0
This element is a choice. Specify at most one of the following options.
[Required]: This element is required to be present whenever the containing element is present.
.elementaryMessageID 0 - 4294967295 INTEGER4, CONTEXT 0, IMPLICIT, Tag Byte = 80
The value is an integer within the indicated range.
This element is one of the possible alternatives for the containing CHOICE.
.text Object SEQUENCE, CONTEXT 1, IMPLICIT, Tag Byte = a1
This element is a sequence which contains one or more of the following elements.
This element is one of the possible alternatives for the containing CHOICE.
.messageContent Binary String IA5String, CONTEXT 0, IMPLICIT, Tag Byte = 80
The value is the raw encoded bytes for this element.
[Required]: This element is required to be present whenever the containing element is present.
.attributes Binary String OCTET STRING, CONTEXT 1, IMPLICIT, Tag Byte = 81
The value is the raw encoded bytes for this element.
.elementaryMessageIDs Array SEQUENCE OF, CONTEXT 29, IMPLICIT, Tag Byte = bd
This element is an array of elements each with the following structure.
This element is one of the possible alternatives for the containing CHOICE.
<anon> 0 - 4294967295 INTEGER4, UNIVERSAL 2, IMPLICIT, Tag Byte = 02
The value is an integer within the indicated range.
[Required]: This element is required to be present whenever the containing element is present.
.variableMessage Object SEQUENCE, CONTEXT 30, IMPLICIT, Tag Byte = be
This element is a sequence which contains one or more of the following elements.
This element is one of the possible alternatives for the containing CHOICE.
.elementaryMessageID 0 - 4294967295 INTEGER4, CONTEXT 0, IMPLICIT, Tag Byte = 80
The value is an integer within the indicated range.
[Required]: This element is required to be present whenever the containing element is present.
.variableParts Array SEQUENCE OF, CONTEXT 1, IMPLICIT, Tag Byte = a1
This element is an array of elements each with the following structure.
The array must contain at least 1 elements, and at most 5 elements.
[Required]: This element is required to be present whenever the containing element is present.
<anon> Object CHOICE
This element is a choice. Specify at most one of the following options.
[Required]: This element is required to be present whenever the containing element is present.
.integer 0 - 4294967295 INTEGER4, CONTEXT 0, IMPLICIT, Tag Byte = 80
The value is an integer within the indicated range.
This element is one of the possible alternatives for the containing CHOICE.
.number Binary String OCTET STRING, CONTEXT 1, IMPLICIT, Tag Byte = 81
The value is the raw encoded bytes for this element.
This field has sub-encoding as per ISUP Generic Digits in Q.763, Figure 24.
This element is one of the possible alternatives for the containing CHOICE.
.number_digits [0-9]+ Digits. Alternate encode source.
Will always be set on decode when source field is present.
.number_scheme 0 - 7 Scheme. Relevant for encode iff number_digits is used.
Will always be set on decode when source field is present.
[Encode Default]: 0 (BCD even) or 1 (BCD odd) as appropriate.
.number_type 0 - 31 Type of Digits. Relevant for encode iff number_digits is used.
Will always be set on decode when source field is present.
[Encode Default]: 0
.time Binary String OCTET STRING, CONTEXT 2, IMPLICIT, Tag Byte = 82
The value is the raw encoded bytes for this element.
This field has sub-encoding as a 2-byte BCD HHMM.
This element is one of the possible alternatives for the containing CHOICE.
.time_hhmm [0-9]{4} Digit String. Alternate encode source.
Specify HHMM as a string of exactly 4 digits.
Will always be set on decode when source field is present.
.date Binary String OCTET STRING, CONTEXT 3, IMPLICIT, Tag Byte = 83
The value is the raw encoded bytes for this element.
This field has sub-encoding as a 3-byte BCD YYMMDD or 4-byte BCD YYYYMMDD.
This element is one of the possible alternatives for the containing CHOICE.
.date_yyyymmdd [0-9]{8} Digit String. Alternate encode source.
Specify YYYYMMDD as a string of exactly 8 digits.
Will always be set on decode when source field is present as 4 bytes.
.date_yymmddhhmmss [0-9]{6} Digit String. Alternate encode source.
Specify YYMMDD as a string of exactly 6 digits.
Will always be set on decode when source field is present as 3 bytes.
.date Binary String OCTET STRING, CONTEXT 3, IMPLICIT, Tag Byte = 83
The value is the raw encoded bytes for this element.
This field has sub-encoding as a 3-byte BCD YYMMDD or 4-byte BCD YYYYMMDD.
This element is one of the possible alternatives for the containing CHOICE.
.date_yyyymmdd [0-9]{8} Digit String. Alternate encode source.
Specify YYYYMMDD as a string of exactly 8 digits.
Will always be set on decode when source field is present as 4 bytes.
.date_yymmddhhmmss [0-9]{6} Digit String. Alternate encode source.
Specify YYMMDD as a string of exactly 6 digits.
Will always be set on decode when source field is present as 3 bytes.
.price Binary String OCTET STRING, CONTEXT 4, IMPLICIT, Tag Byte = 84
The value is the raw encoded bytes for this element.
This field has sub-encoding as a 4-byte BCD DDDDDDCC.
This element is one of the possible alternatives for the containing CHOICE.
.price_price [0-9]{1,8} Digit String. Alternate encode source.
Specify price in DDDDDDCC as a string of between 1 and 8 digits for encoding.
Will always be set on decode (left-padded with 0 to 8 digits) when source field is present.
.numberOfRepetitions 1 - 127 INTEGER, CONTEXT 1, IMPLICIT, Tag Byte = 81
The value is an integer within the indicated range.
.duration 0 - 32767 INTEGER, CONTEXT 2, IMPLICIT, Tag Byte = 82
The value is an integer within the indicated range.
.interval 0 - 32767 INTEGER, CONTEXT 3, IMPLICIT, Tag Byte = 83
The value is an integer within the indicated range.
.tone Object SEQUENCE, CONTEXT 1, IMPLICIT, Tag Byte = a1
This element is a sequence which contains one or more of the following elements.
This element is one of the possible alternatives for the containing CHOICE.
.toneID 0 - 4294967295 INTEGER4, CONTEXT 0, IMPLICIT, Tag Byte = 80
The value is an integer within the indicated range.
[Required]: This element is required to be present whenever the containing element is present.
.duration 0 - 4294967295 INTEGER4, CONTEXT 1, IMPLICIT, Tag Byte = 81
The value is an integer within the indicated range.
.displayInformation Binary String IA5String, CONTEXT 2, IMPLICIT, Tag Byte = 82
The value is the raw encoded bytes for this element.
This element is one of the possible alternatives for the containing CHOICE.
.extensions Array SEQUENCE OF, CONTEXT 3, IMPLICIT, Tag Byte = a3
This element is an array of elements each with the following structure.
<anon> Object SEQUENCE, UNIVERSAL 16, IMPLICIT, Tag Byte = 30
This element is a sequence which contains one or more of the following elements.
[Required]: This element is required to be present whenever the containing element is present.
.type -2147483648 - 2147483647 INTEGER, UNIVERSAL 2, IMPLICIT, Tag Byte = 02
The value is an integer within the indicated range.
[Required]: This element is required to be present whenever the containing element is present.
.criticality 0 - 4294967295 ENUMERATED, UNIVERSAL 10, IMPLICIT, Tag Byte = 0a
The value is an integer within the indicated range.
.value Binary String ANY, CONTEXT 1, Tag Byte = a1
The value is the raw encoded bytes for this element.
This field supports basic UNIVERSAL BOOLEAN, INTEGER, OCTET STRING sub-encoding, also a HEX catch-all.
[Required]: This element is required to be present whenever the containing element is present.
.value_integer Integer Helper mechanism for requesting encoding of a simple ASN.1 UNIVERSAL INTEGER.
Will always be set on decode when source field is present as UNIVERSAL integer.
.value_boolean 0 / 1 Helper mechanism for requesting encoding of a simple ASN.1 UNIVERSAL BOOLEAN.
Will always be set on decode when source field is present as UNIVERSAL boolean.
.value_octet_string Binary String Helper mechanism for requesting encoding of a simple ASN.1 UNIVERSAL OCTET STRING.
The bytes in this binary string are exclusive of the tag and length bytes.
Will always be set on decode when source field is present as UNIVERSAL octet string.
.value_hex [0-9a-fA-F]+ Hex String. Alternate encode source.
The hex string value must always consist of an even number of characters.
The bytes in this hex string include any tag and length bytes which may potentially be present.
For encoding, either [a-f] and [A-F] (upper-case or lower-case) may be used.
Will always be set on decode when source field is present.
.callSegmentID -2147483648 - 2147483647 INTEGER, CONTEXT 4, IMPLICIT, Tag Byte = 84
The value is an integer within the indicated range.