You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > SS7 TUP Message Query 0x0090

SS7 TUP Message Query 0x0090

SwitchKit Name

SS7TUPMessageQuery

Type

EXS API and SwitchKit API message

Description

SS7 TUP Message Query 0x0090

This message reports the configured format of the specified TUP message.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

UBYTE StackID;

UBYTE TUPMessageIndex;

} XL_SS7TUPMessageQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE StackID;

UBYTE TUPMessageIndex;

UBYTE MCTEntry;

UBYTE H0Length;

UBYTE H0Value;

UBYTE H1Length;

UBYTE H1Value;

unsigned short MsgAttributes;

UBYTE Data[213];

} XL_SS7TUPMessageQueryAck;

C++ Class

class XLC_SS7TUPMessageQuery : public XLC_OutboundMessage {

public:

UBYTE getStackID() const;

void setStackID(UBYTE x);

UBYTE getTUPMessageIndex() const;

void setTUPMessageIndex(UBYTE x);

};

C++ Class Response

class XLC_SS7TUPMessageQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getStackID() const;

void setStackID(UBYTE x);

UBYTE getTUPMessageIndex() const;

void setTUPMessageIndex(UBYTE x);

UBYTE getMCTEntry() const;

void setMCTEntry(UBYTE x);

UBYTE getH0Length() const;

void setH0Length(UBYTE x);

UBYTE getH0Value() const;

void setH0Value(UBYTE x);

UBYTE getH1Length() const;

void setH1Length(UBYTE x);

UBYTE getH1Value() const;

void setH1Value(UBYTE x);

unsigned short getMsgAttributes() const;

void setMsgAttributes(unsigned short x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

EXS API Hex Format

NOTE: The fields listed between (Field[m] ID through Subfield[s] Maximum Length, LSB) are repeated for each mandatory field. Likewise, the fields listed between (Field[o] ID through Subfield[s] Maximum Length, LSB) are repeated for each optional field.
Each mandatory and optional field can have a variable number of subfields. For example, Mandatory Field[0] can have 3 subfields, Mandatory Field[1] can have two subfields, and Optional Field[0] can have 4 subfields.

MESSAGE (White) | RESPONSE (Gray)
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1, 2 | Length (0xNNNN) | 1, 2 | Length (0x0007)
3, 4 | Message Type (0x0090) | 3, 4 | Message Type (0x0090)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
8 : | AIB Address Method 0x00 - Individual AEs | 8, 9 | Status MSB, LSB
Number of AEs to follow | 10 | AIB (same as message)
AE 0x08 SS7 Stack |  | TUP Message Index (See information below this table)
: | TUP Message Index | : | MCT Entry Indicates whether the entry in the Message Configuration Table is valid or invalid. 0x00 Invalid (will be ignored) 0x01 Valid (to be handled by TUP)
: | Checksum
| Response continued below.
: | H0 Length (See information below this table)
: | H0 Value (See information below this table)
: | H1 Length (See information below this table)
: | H1 Value (See information below this table)
: | Message Attributes MSB, LSB This field is a bit mask. The meaning of each bit is described below. Bit 0 Group Message Flag 0 Not Group Message 1 Group Message Bits 115 Reserved, must be 0x00
: | Number of Mandatory Fields (M)
: | Field[m] ID (See information below this table)
: | Field[m] Attributes MSB, LSB This field is a bit mask. The meaning of each bit is described below. Bit 0 Range and Status Field Flag 0 Field is not Range and Status Field 1 Field is Range and Status Field Bit 1 Filler Field Flag 0 Field is not Filler Field 1 Field is Filler Field (not reported to or required from the host) Bit 2 Status Subfield Variant 0 Field is not a Range and Status field or is a Range and Status field and the status bits are used to inform TUP as to which CICs are being operated (such as the group blocking messages) 1 Field is a Range and Status field and all CICs in the range are being operated, independent of the status value (such as the GRA message) Bits 3-15 Reserved, must be 0x00
: | Field[m] Number of Subfields [S]
: | Subfield[s] ID
: | Subfield[s] Attributes MSB, LSB This field is a bit mask. The meaning of each bit is described below. Bits 0-2 Number of Units to Add to Subfield if Length Subfield (07) Bits 3-4 Subfield Length Type if Length Subfield 0 Bits 1 Half-Octets 2 Octets Bit 5 Subfield Type Flag 0 Data Subfield (Bits 04 are ignored) 1 Length Subfield (The value of the Subfield indicates the length of the next Data Subfield) Bit 6 Use Filler (Pad subfield to the next octet) Bit 7 Is Filler (Subfield is a filler/does not contain useful data) Bits 815 Reserved, must be 0x00
: | Subfield[s] Minimum Length MSB, LSB
: | Subfield[s] Maximum Length MSB, LSB
: | Optional Part Attributes MSB, LSB This field is a bit mask. The meaning of each bit is described below. Bit 0 Optional Field Use Filler Flag 0 If present in the TUP message, the Optional Field Indicator bitfield will not be octet-padded. 1 If present in the TUP message, the Optional Field Indicator bitfield will be octet-padded. Bits 115 Reserved, must be 0x00
: | Number of Optional Fields (O)
: | Field[0] ID
: | Field[0] Attributes MSB, LSB
: | Field[0] Number of Subfields [S]
: | Subfield[s] ID
: | Subfield[s] Attributes MSB, LSB
: | Subfield[s] Minimum Length MSB, LSB
: | Checksum

TUP Message Index

This field indicates the index into the TUP Message Format table for the specified TUP message. For more information on the TUP Message Format table, refer to the CSP Developers Guide: Common Channel Signaling.

Index | Message |  | Index | Message |  | Index | Message
--- | --- | --- | --- | --- | --- | --- | ---
0x00 | IAM |  | 0x12 | ACC |  | 0x24 | BLO
0x01 | IAI |  | 0x13 | ADI |  | 0x25 | BLA
0x02 | SAM |  | 0x14 | CGC |  | 0x26 | UBL
0x03 | SAO |  | 0x15 | DPN |  | 0x27 | UBA
0x04 | ACM |  | 0x16 | LOS |  | 0x28 | MGB
0x05 | ANC |  | 0x17 | NNC |  | 0x29 | MBA
0x06 | ANN |  | 0x18 | SEC |  | 0x2A | MGU
0x07 | ANU |  | 0x19 | SSB |  | 0x2B | MUA
0x08 | CBK |  | 0x1A | SST |  | 0x2C | HGB
0x09 | CLF |  | 0x1B | MPR |  | 0x2D | HBA
0x0A | RLG |  | 0x1C | EUM |  | 0x2E | HGU
0x0B | GRQ |  | 0x1D | UNN |  | 0x2F | HUA
0x0C | GSM |  | 0x1E | CCR |  | 0x30 | SGB
0x0D | RAN |  | 0x1F | COT |  | 0x31 | SBA
0x0E | FOT |  | 0x20 | CCF |  | 0x32 | SGU
0x0F | CCL |  | 0x21 | GRS |  | 0x33 | SUA
0x10 | CFL |  | 0x22 | GRA |  | 0x340x43 | Reserved for future use
0x11 | ACB |  | 0x23 | RSC |  | 0x440x5B | User-defined Messages

H0/H1 Length

The system uses the H0 and H1 fields as x, y coordinates for the Heading Code Allocations table found in the Q.723 specification.

This field indicates whether length of the H0 Value and H1 Value fields are defined as half-octets or octets (groups of 4 bits or 8 bits, respectively). Valid entries for this field are as follows:

0x01 Half-octets

0x02 Octets

H0/H1 Value

The system uses the H0 and H1 fields as x, y coordinates for the Heading Code Allocations table found in the Q.723 specification.

This field represents the value of the H0 or H1 parameter in the Heading Code Allocations table. To represent the appropriate Heading Code, use the following H0 and H1 values:

Heading | H0 | H1
--- | --- | ---
IAM | 0x01 | 0x01
IAI | 0x01 | 0x02
SAM | 0x01 | 0x03
SAO | 0x01 | 0x04
GSM | 0x02 | 0x01
COT | 0x02 | 0x03
CCF | 0x02 | 0x04
GRQ | 0x03 | 0x01
ACM | 0x04 | 0x01
CHG | 0x04 | 0x02
SEC | 0x05 | 0x01
CGC | 0x05 | 0x02
NNC | 0x05 | 0x03
ADI | 0x05 | 0x04
CFL | 0x05 | 0x05
SSB | 0x05 | 0x06
UNN | 0x05 | 0x07
LOS | 0x05 | 0x08
SST | 0x05 | 0x09
ACB | 0x05 | 0x0A
DPN | 0x05 | 0x0B
MPR | 0x05 | 0x0C
EUM | 0x05 | 0x0F
ANU | 0x06 | 0x00
ANC | 0x06 | 0x01
ANN | 0x06 | 0x02
CBK | 0x06 | 0x03
CLF | 0x06 | 0x04
RAN | 0x06 | 0x05
FOT | 0x06 | 0x06
CCL | 0x06 | 0x07
RLG | 0x07 | 0x01
BLO | 0x07 | 0x02
BLA | 0x07 | 0x03
UBL | 0x07 | 0x04
UBA | 0x07 | 0x05
CCR | 0x07 | 0x06
RSC | 0x07 | 0x07
MGB | 0x08 | 0x01
MBA | 0x08 | 0x02
MGU | 0x08 | 0x03
MUA | 0x08 | 0x04
HGB | 0x08 | 0x05
HBA | 0x08 | 0x06
HGU | 0x08 | 0x07
HUA | 0x08 | 0x08
GRS | 0x08 | 0x09
GRA | 0x08 | 0x0A
SGB | 0x08 | 0x0B
SBA | 0x08 | 0x0C
SGU | 0x08 | 0x0D
SUA | 0x08 | 0x0E
ACC | 0x0A | 0x01

Field ID

The table below shows the Field ID for supported fields.

Field ID | Field Name | TUP Messages Containing Field
--- | --- | ---
0x01 | Calling Party Category | IAM, IAI, GSM
0x02 | Call Setup Message Indicators | IAM, IAI
0x03 | Called Party Address Data | IAM, IAI, SAM
0x04 | IAI National Use Field | IAI
0x05 | Closed User Group Information | IAI
0x06 | Additional Calling Party Information | IAI
0x07 | Additional Routing Information | IAI
0x08 | Calling Line ID | IAI, GSM
0x09 | Original Called Address | IAI, GSM
0x0A | Charging Information | IAI
0x0B | Called Party Address Digit | SAO
0x0C | ACM Message Indicator | ACM
0x0D | Request Type Indicator | GRQ
0x0E | RESERVED | RESERVED
0x0F | Incoming Trunk and Transit Identity | GSM
0x10 | Echo Suppressor Indicator * | GSM
0x11 | Malicious Call Identification * | GSM
0x12 | Hold Indicator * | GSM
0x13 | ACC Message Indicator | ACC
0x14 | EUM Octet Indicator | EUM
0x15 | Signaling Point Code | EUM
0x16 | Range and Status Field | GRA, MGB, MBA, MGU, MUA, HGB, HBA, HGU, HUA, SGB, SBA, SGU, SUA
0x17 | Range Field (w/ no status) | GRS

* These are only flags in the Indicator field and contain no data
(Data Length = 0)

See Signaling System Number Seven.
Telephone User Part
A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
Least Significant Bit
A group of data bits in a specific format, with a flag at each end to indicate the beginning and the end of the frame.
See Address Information Block.
Most Significant Bit
Message delimiter (SS7 bit pattern - 01111110)
CCS. Network architecture using SS7 protocol for the exchange of information between telecommunications nodes and networks on an out-of-band basis.
Blocking Acknowldgment message
Continuity Check Request message (ISUP)
See Recorded Announcements.
ITU-TSS Publication on Formats and Codes (TUP)
A number that addresses a node in a SS7 network.