Navigation :

Optional Parameters

Introduction

The N-Squared codec supports these optional parameters in any ISUP message.

The codec will encode/decode any optional parameter which is present, and does not attempt to apply checking to determine if the parameter is “expected” for this message or not.

Field	Type	Description
`.transmissionMediumRequirement`	`0 - 255`	Transmission Medium Requirement Optional Parameter Tag = `2` (dec) The value is one-octet unsigned integer value. [Default = 0]: The indicated default value will be used on encode if the value is mandatory but not specified. This element is always present on decode. The codec does not currently support explicit encoding/decoding of the individual bit-fields.
`.accessTransport`	Binary String	Access Transport Optional Parameter Tag = `3` (dec) The value is the raw encoded octets for this element. This field has sub-encoding as per `ISUP User Service Information` in Q.763, Figure 5. This is a variable-length field which may contain one or more entries as described in Section 4.5 of Q.931. The codec does not currently support explicit encoding/decoding of the individual sub-elements.
`.accessTransport_hex`	[0-9a-fA-F]+	Hex Digits. Alternate encode source. For encoding, either [a-f] and [A-F] (upper-case or lower-case) may be used. Will always be set (using lower-case) on decode when source field is present.
`.calledPartyNumber`	Binary String	Called Party Number Optional Parameter Tag = `4` (dec) The value is the raw encoded octets for this element. This field has sub-encoding as per `ISUP Called Address` in Q.763, Figure 10.
`.calledPartyNumber_digits`	[0-9a-fA-F]+	Digits. Alternate encode source. For encoding, either [a-f] and [A-F] (upper-case or lower-case) may be used. Will always be set (using lower-case) on decode when source field is present.
`.calledPartyNumber_noa`	`0` - `127`	Nature of Address Indicator. Relevant for encode iff calledPartyNumber_digits is used. Will always be set on decode when source field is present. [Encode Default]: `2` (Unknown)
`.calledPartyNumber_inn`	`0` - `1`	Internal Network Number Indicator. Relevant for encode iff calledPartyNumber_digits is used. Will always be set on decode when source field is present. [Encode Default]: `0` (Allowed)
`.calledPartyNumber_npi`	`0` - `7`	Numbering Plan Indicator. Relevant for encode iff calledPartyNumber_digits is used. Will always be set on decode when source field is present. [Encode Default]: `1` (ITU-T E.164)
`.natureOfConnectionIndicators`	`1 Byte`	Nature of Connection Indicators Optional Parameter Tag = `6` (dec) The value is a binary string of one unsigned octet representing three distinct internal bit-field values. [Default = 0x00]: The indicated default value will be used on encode if the value is mandatory but not specified. This element is always present on decode. The codec does not currently support explicit encoding/decoding of the individual bit-fields.
`.natureOfConnectionIndicators_hex`	[0-9a-fA-F]+	This a hex representation of the octet string. [Required]: This element is always present on decode. It will be used for encode if present.
`.forwardCallIndicators`	`2 Bytes`	Forward Call Indicators Optional Parameter Tag = `7` (dec) The value is a binary string of two unsigned octets representing ten separate internal bit-field values. [Default = 0x02 0x01]: The indicated default value will be used on encode if the value is mandatory but not specified. This element is always present on decode. The codec does not currently support explicit encoding/decoding of the individual bit-fields.
`.forwardCallIndicators_hex`	[0-9a-fA-F]+	This a hex representation of the octet string. [Required]: This element is always present on decode. It will be used for encode if present.
`.callingPartysCategory`	`0 - 255`	Calling Party's Category Optional Parameter Tag = `9` (dec) The value is one-octet unsigned integer value. [Default = 10]: The indicated default value will be used on encode if the value is mandatory but not specified. This element is always present on decode. The codec does not currently support explicit encoding/decoding of the individual bit-fields.
`.callingPartyNumber`	Binary String	Calling Party Number Optional Parameter Tag = `10` (dec) The value is the raw encoded octets for this element. This field has sub-encoding as per `ISUP Calling Party Address` in Q.763, Figure 11.
`.callingPartyNumber_digits`	[0-9a-fA-F]+	Hex Digits. Alternate encode source. For encoding, either [a-f] and [A-F] (upper-case or lower-case) may be used. Will always be set (using lower-case) on decode when source field is present.
`.callingPartyNumber_noa`	`0` - `127`	Nature of Address Indicator. Relevant for encode iff callingPartyNumber_digits is used. Will always be set on decode when source field is present. [Encode Default]: `2` (Unknown)
`.callingPartyNumber_ni`	`0` - `1`	Number Incomplete Indicator. Relevant for encode iff callingPartyNumber_digits is used. Will always be set on decode when source field is present. [Encode Default]: `0` (Number Complete)
`.callingPartyNumber_npi`	`0` - `7`	Numbering Plan Indicator. Relevant for encode iff callingPartyNumber_digits is used. Will always be set on decode when source field is present. [Encode Default]: `1` (ITU-T E.164)
`.callingPartyNumber_pri`	`0` - `3`	Presentation Restricted Indicator. Relevant for encode iff callingPartyNumber_digits is used. Will always be set on decode when source field is present. [Encode Default]: `0` (Allowed)
`.callingPartyNumber_si`	`0` - `3`	Screening Indicator. Relevant for encode iff callingPartyNumber_digits is used. Will always be set on decode when source field is present. [Encode Default]: `1` (User Provided, Verified)
`.backwardCallIndicators`	`2 Octets`	Backward Call Indicators Optional Parameter Tag = `17` (dec) The value is a binary string of two unsigned octets representing eleven separate internal bit-field values. [Default = 0x12 0x04]: The indicated default value will be used on encode if the value is mandatory but not specified. This element is always present on decode. Note that this field name is used for the mandatory (non-tagged) field in CON and ACM, and can also appear as an optional field with tag = `17`.
`.backwardCallIndicators_hex`	[0-9a-fA-F]+	This a hex representation of the octet string. [Required]: This element is always present on decode. It will be used for encode if present.
`.backwardCallIndicators_e2e_mi`	`0` - `3`	End-to-end method indicator (2 bit unsigned integer value). This element is not set on decode. Available for bit-wise encoding of the BCI field. No End-to-end method (0x0), Pass-along method (0x1), SCCP method (0x2), Pass-along and SCCP (0x3) [Default = 0]: The indicated default applies when any other bit-wise BCI field is specified.
`.backwardCallIndicators_cdp_cat`	`0` - `3`	Called party's category indicator (2 bit unsigned integer value). This element is not set on decode. Available for bit-wise encoding of the BCI field. No Indication (0x0), Ordinary Subscriber (0x1), Payphone (0x2) [Default = 1]: The indicated default applies when any other bit-wise BCI field is specified.
`.backwardCallIndicators_cdp_sts`	`0` - `3`	Called party's status indicator (2 bit unsigned integer value). This element is not set on decode. Available for bit-wise encoding of the BCI field. No Indication (0x0), Subscriber Free (0x1), Connect When Free (0x2) [Default = 0]: The indicated default applies when any other bit-wise BCI field is specified.
`.backwardCallIndicators_ci`	`0` - `3`	Charge Indicator (2 bit unsigned integer value). This element is not set on decode. Available for bit-wise encoding of the BCI field. No Indication (0x0), No Charge (0x1), Charge (0x2) [Default = 2]: The indicated default applies when any other bit-wise BCI field is specified.
`.backwardCallIndicators_sccp_method`	`0` - `3`	SCCP method indicator (2 bit unsigned integer value). This element is not set on decode. Available for bit-wise encoding of the BCI field. No indication (0x0), Connectionless (0x1), Connection Oriented (0x2), Connectionless and Connection (0x3) [Default = 0]: The indicated default applies when any other bit-wise BCI field is specified.
`.backwardCallIndicators_echo_cdi`	`0` / `1`	Echo Control Device Indicator (1 bit unsigned integer value). This element is not set on decode. Available for bit-wise encoding of the BCI field. Echo Control Not Included (0x0), Echo Control Included (0x1) [Default = 0]: The indicated default applies when any other bit-wise BCI field is specified.
`.backwardCallIndicators_isdn_access`	`0` / `1`	ISDN access indicator (1 bit unsigned integer value). This element is not set on decode. Available for bit-wise encoding of the BCI field. Terminating access non-ISDN (0x0), Terminating access ISDN (0x1) [Default = 0]: The indicated default applies when any other bit-wise BCI field is specified.
`.backwardCallIndicators_holding`	`0` / `1`	Holding indicator (1 bit unsigned integer value). This element is not set on decode. Available for bit-wise encoding of the BCI field. Holding Not Requested (0x0), Holding Requested (0x1) [Default = 0]: The indicated default applies when any other bit-wise BCI field is specified.
`.backwardCallIndicators_isdn_user`	`0` / `1`	ISDN user part (1 bit unsigned integer value). This element is not set on decode. Available for bit-wise encoding of the BCI field. ISDN user part not used all the way (0x0), ISDN user part used all the way (0x1) [Default = 1]: The indicated default applies when any other bit-wise BCI field is specified.
`.backwardCallIndicators_e2e_ii`	`0` / `1`	End-to-end information indicator (1 bit unsigned integer value). This element is not set on decode. Available for bit-wise encoding of the BCI field. No end-to-end information available (0x0), End-to-end information available (0x1) [Default = 0]: The indicated default applies when any other bit-wise BCI field is specified.
`.backwardCallIndicators_interworking`	`0` / `1`	Interworking indicator (1 bit unsigned integer value). This element is not set on decode. Available for bit-wise encoding of the BCI field. No Interworking (0x0), No Interworking (0x1) [Default = 0]: The indicated default applies when any other bit-wise BCI field is specified.
`.causeIndicators`	Binary String	Cause Indicators Optional Parameter Tag = `18` (dec) The value is a binary string of two or more unsigned octets representing various separate internal bit-field values. [Default = 0x8a 0x90]: The indicated default value will be used on encode if the value is mandatory but not specified. This element is always present on decode. The codec does not currently support explicit encoding/decoding of the individual bit-fields.
`.causeIndicators_hex`	[0-9a-fA-F]+	This a hex representation of the octet string. [Required]: This element is always present on decode. It will be used for encode if present.
`.userServiceInformation`	Binary String	User Service Information Optional Parameter Tag = `29` (dec) The value is the raw encoded octets for this element. This field has sub-encoding as per `ISUP User Service Information` in Q.763, Figure 55. The codec does not currently support explicit encoding/decoding of the individual sub-elements.
`.userServiceInformation_hex`	[0-9a-fA-F]+	Hex Digits. Alternate encode source. For encoding, either [a-f] and [A-F] (upper-case or lower-case) may be used. Will always be set (using lower-case) on decode when source field is present.
`.optionalBackwardCallIndicators`	Binary String	Optional Backward Call Indicators Optional Parameter Tag = `41` (dec) The value is the raw encoded octets for this element. This field has sub-encoding as per `ISUP Optional Backward Call Indicators` in Q.763, Figure 38. This is a single-octet bit-field value, although the length of the field is not enforced by the codec. The codec does not currently support explicit encoding/decoding of the individual sub-elements.
`.optionalBackwardCallIndicators_hex`	[0-9a-fA-F]+	Hex Digits. Alternate encode source. For encoding, either [a-f] and [A-F] (upper-case or lower-case) may be used. Will always be set (using lower-case) on decode when source field is present.
`.accessDeliveryInformation`	Binary String	Access Delivery Information Optional Parameter Tag = `46` (dec) The value is the raw encoded octets for this element. This field has sub-encoding as per `ISUP Optional Backward Call Indicators` in Q.763, Figure 4. This is a single-octet bit-field value, although the length of the field is not enforced by the codec. The codec does not currently support explicit encoding/decoding of the individual sub-elements.
`.accessDeliveryInformation_hex`	[0-9a-fA-F]+	Hex Digits. Alternate encode source. For encoding, either [a-f] and [A-F] (upper-case or lower-case) may be used. Will always be set (using lower-case) on decode when source field is present.
`.propagationDelayCounter`	Integer	Propagation Delay Counter Optional Parameter Tag = `49` (dec) The value is an integer representation of the propagation delay counter (in milliseconds). This field is encoded as a two-octet network order unsigned integer.
`.userTeleserviceInformation`	Binary String	User Teleservice Information Optional Parameter Tag = `52` (dec) The value is the raw encoded octets for this element. This field has sub-encoding as per `ISUP User Service Information` in Q.763, Figure 56. The codec does not currently support explicit encoding/decoding of the individual sub-elements.
`.userTeleserviceInformation_hex`	[0-9a-fA-F]+	Hex Digits. Alternate encode source. For encoding, either [a-f] and [A-F] (upper-case or lower-case) may be used. Will always be set (using lower-case) on decode when source field is present.
`.parameterCompatibilityInformation`	Binary String	Parameter Compatibility Information Optional Parameter Tag = `57` (dec) The value is the raw encoded octets for this element. This field has sub-encoding as per `ISUP User Service Information` in Q.763, Figure 41. The codec does not currently support explicit encoding/decoding of the individual sub-elements.
`.parameterCompatibilityInformation_hex`	[0-9a-fA-F]+	Hex Digits. Alternate encode source. For encoding, either [a-f] and [A-F] (upper-case or lower-case) may be used. Will always be set (using lower-case) on decode when source field is present.
`.tag_[abc]`	Binary String	Any Other Parameter Optional Parameter Tag = `[any]` The variable `abc` is the tag number as a decimal value in the range 1-255. The value is the raw decoded octets for any unknown element found during decode.
`.tag_[abc]_hex`	[0-9a-fA-F]+	Optional Parameter Tag = `[any]` The value is the hex representation of the decoded octets for any unknown element found during decode. The variable `abc` is the tag number as a decimal value in the range 1-255. Will always be set (using lower-case) on decode when source field is present.