You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > SS7 ISUP Message Query 0x0068
SwitchKit Name
SS7ISUPMessageQuery
Type
EXS API and SwitchKit API message
Description
This message reports the currently configured format of the specified ISUP message.
Sent by
SwitchKit Code
C Structure
typedef struct {
UBYTE StackID;
UBYTE ISUPMessageIndex;
} XL_SS7ISUPMessageQuery;
C Structure Response
typedef struct {
unsigned short Status;
UBYTE StackID;
UBYTE ISUPMessageIndex;
UBYTE ISUPMessageID;
UBYTE ISUPMessagePriority;
UBYTE NumMFPs;
UBYTE Data[217];
} XL_SS7ISUPMessageQueryAck;
C++ Class
class XLC_SS7CICQuery : public XLC_OutboundMessage {
public:
UBYTE getStackID() const;
void setStackID(UBYTE x);
int getDPC() const;
void setDPC(int x);
unsigned short getBaseCIC() const;
void setBaseCIC(unsigned short x);
UBYTE getNumCICs() const;
void setNumCICs(UBYTE x);
UBYTE getCallControlUserPart() const;
void setCallControlUserPart(UBYTE x);
};
C++ Class Response
class XLC_SS7CICQueryAck : public XLC_AcknowledgeMessage {
public:
unsigned short getStatus() const;
void setStatus(unsigned short x);
UBYTE getStackID() const;
void setStackID(UBYTE x);
unsigned short getBaseCICNumber() const;
void setBaseCICNumber(unsigned short x);
unsigned short getBaseCICSpan() const;
void setBaseCICSpan(unsigned short x);
UBYTE getBaseCICChannel() const;
void setBaseCICChannel(UBYTE x);
UBYTE getNumCICs() const;
void setNumCICs(UBYTE x);
int getDPC() const;
void setDPC(int x);
const UBYTE *getData() const;
UBYTE *getData();
void setData(UBYTE *x);
};
EXS API Hex Format
MESSAGE (White) |
RESPONSE (Gray) |
||
Byte |
Field Description |
Byte |
Field Description |
0 |
Frame (0xFE) |
0 |
Frame (0xFE) |
1, 2 |
Length (0xNNNN) |
1, 2 |
Length (0xNNNN) |
3, 4 |
Message Type (0x0068) |
3, 4 |
Message Type (0x0068) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
8 : |
Address Method 0x00 - Individual AEs |
8, 9 |
|
Number of AEs to follow |
10 |
AIB (same as message) |
|
AE |
: |
ISUP Message Index |
|
: |
ISUP Message Index |
: |
ISUP Message ID |
: |
Checksum |
: |
ISUP Message Priority ITU: This value has no meaning.
|
|
Response continued below. |
||
: |
Number of Mandatory Fixed Parameters (MFP) |
||
: |
MFP 1: ID |
||
: |
MFP 1: Length |
||
: |
MFP n: ID |
||
: |
MFP n: Length |
||
: |
Number of Mandatory Variable Parameters (MVP) |
||
: |
MVP 1: ID |
||
: |
MVP 1: Minimum Length |
||
: |
MVP 1: Maximum Length (See Maximum Length at the end of this message description.) |
||
: |
MVP n: ID |
||
: |
MVP n: Minimum Length |
||
: |
MVP n: Maximum Length (See Maximum Length at the end of this message description.) |
||
: |
Optional Parameters Allowed This field informs ISUP whether or not to look for or insert the optional parameters pointer octet into the ISUP message.
Some messages allow optional parameters, even though optional parameters are not
To include optional parameters, set the value of the Optional Parameters Allowed field to
For no optional parameters, set the value of the Optional Parameters Allowed field to 0x00
Refer to Repeatable Optional Parameters/Optional Parameters Allowed. |
||
: |
Number of Optional Parameters
See Repeatable Optional Parameters/Optional Parameters Allowed at the end of this message. |
||
: |
OP 1: ID |
||
: |
OP 1: Minimum Length |
||
: |
OP 1: Maximum Length (See Maximum Length at the end of this message description.) |
||
: |
OP n: ID |
||
: |
OP n: Minimum Length |
||
: |
OP n: Maximum Length (See Maximum Length at the end of this message description.) |
||
: |
Repeatable Optional Parameters |
||
: |
ROP 1: ID ROP n: ID |
||
: |
Number of TLVs |
||
: |
Both TLVs must be sent in the message and must be set to the same value. To remove an ISUP message, set both TLVs to 0x00. To add an ISUP message, set both TLVs to 0x01. |
||
: |
Checksum |
ISUP Message Index
This field specifies an index that is maintained for internal use by the Excel platform into the ISUP Message Format table for the specified ISUP message. The valid entries for this field are in numeric order.
Message |
Index |
|
Message |
Index |
|
Message |
Index |
---|---|---|---|---|---|---|---|
IAM |
0x00 |
|
LPA |
0x14 |
|
CVT |
0x28 |
ACM |
0x01 |
|
CFN |
0x15 |
|
CVR |
0x29 |
ANM |
0x02 |
|
UCIC |
0x16 |
|
CRM |
0x2A |
CON |
0x03 |
|
CQM |
0x17 |
|
CRA |
0x2B |
REL |
0x04 |
|
CQR |
0x18 |
|
UPT |
0x2C |
RLC |
0x05 |
|
FAR |
0x19 |
|
UPA |
0x2D |
CPG |
0x06 |
|
FAA |
0x1A |
|
EXM |
0x2E |
BLO |
0x07 |
|
FRJ |
0x1B |
|
MPM |
0x4F |
0x08 |
|
USR |
0x1C |
|
OPR |
0x50 |
|
UBL |
0x09 |
|
FAC |
0x1D |
|
CCL |
0x51 |
UBA |
0x0A |
|
PAM |
0x1E |
|
DRS |
0x52 |
RSC |
0x0B |
|
NRM |
0x1F |
|
FOT |
0x53 |
CGB |
0x0C |
|
CRG |
0x20 |
|
OLM |
0x54 |
CGBA |
0x0D |
|
IDR |
0x21 |
|
SGM |
0x55 |
CGU |
0x0E |
|
IRS |
0x22 |
|
CMR |
0x56 |
CGUA |
0x0F |
|
INR |
0x23 |
|
CMC |
0x57 |
GRS |
0x10 |
|
INF |
0x24 |
|
CMRJ |
0x58 |
GRA |
0x11 |
|
SUS |
0x25 |
|
LOP |
0x59 |
0x12 |
|
RES |
0x26 |
|
APM |
0x5A |
|
COT |
0x13 |
|
SAM |
0x27 |
|
PRI |
0x5B |
Index values 0x2F-0x4E are user-defined for the ISUP message format table:
Message |
Index |
|
Message |
Index |
|
Message |
Index |
---|---|---|---|---|---|---|---|
Message #1 |
0x2F |
|
Message #14 |
0x3C |
|
Message #27 |
0x49 |
Message #2 |
0x30 |
|
Message #15 |
0x3D |
|
Message #28 |
0x4A |
Message #3 |
0x31 |
|
Message #16 |
0x3E |
|
Message #29 |
0x4B |
Message #4 |
0x32 |
|
Message #17 |
0x3F |
|
Message #30 |
0x4C |
Message #5 |
0x33 |
|
Message #18 |
0x40 |
|
Message #31 |
0x4D |
Message #6 |
0x34 |
|
Message #19 |
0x41 |
|
Message #32 |
0x4E |
Message #7 |
0x35 |
|
Message #20 |
0x42 |
|
|
|
Message #8 |
0x36 |
|
Message #21 |
0x43 |
|
|
|
Message #9 |
0x37 |
|
Message #22 |
0x44 |
|
|
|
Message #10 |
0x38 |
|
Message #23 |
0x45 |
|
|
|
Message #11 |
0x39 |
|
Message #24 |
0x46 |
|
|
|
Message #12 |
0x3A |
|
Message #25 |
0x47 |
|
|
|
Message #13 |
0x3B |
|
Message #26 |
0x48 |
|
|
|
ISUP Message ID
This field specifies the ISUP Message ID for the specified ISUP message from the ISUP Message Format table. Valid entries for this field are listed by ISUP message name:
Message |
ID |
|
Message |
ID |
|
Message |
ID |
---|---|---|---|---|---|---|---|
ACM |
0x06 |
|
CRM |
0xEA |
|
OLM |
0x30 |
ANM |
0x09 |
|
CVR |
0xEB |
|
OPR |
0xFE |
APM |
0x41 |
|
CVT |
0xEC |
|
PAM |
0x28 |
BLA |
0x15 |
|
DRS |
0x27 |
|
PRI |
0x42 |
BLO |
0x13 |
|
EXM |
0xED |
|
REL |
0x0C |
CCL |
0xFC |
|
FAA |
0x20 |
|
RES |
0x0E |
CFN |
0x2F |
|
FAC |
0x33 |
|
RLC |
0x10 |
CGB |
0x18 |
|
FAR |
0x1F |
|
RSC |
0x12 |
CGBA |
0x1A |
|
FOT |
0x08 |
|
SAM |
0x02 |
CGU |
0x19 |
|
FRJ |
0x21 |
|
SGM |
0x38 |
CGUA |
0x1B |
|
GRA |
0x29 |
|
SUS |
0x0D |
CON |
0x07 |
|
GRS |
0x17 |
|
UBA |
0x16 |
CMC |
0x49 |
|
IAM |
0x01 |
|
UBL |
0x14 |
CMRJ |
0x4A |
|
IDR |
0x36 |
|
UCIC |
0x2E |
CMR |
0x4B |
|
INF |
0x04 |
|
UPA |
0x35 |
CPG |
0x2C |
|
INR |
0x03 |
|
UPT |
0x34 |
CQM |
0x2A |
|
IRS |
0x37 |
|
USR |
0x2D |
CQR |
0x2B |
|
LOP |
0x40 |
|
|
|
CRA |
0xE9 |
|
MPM |
0xFD |
|
|
|
CRG |
0x31 |
|
NRM |
0x32 |
|
|
|
Repeatable Optional Parameters/Optional Parameters Allowed
This field informs ISUP whether or not to look for or insert the optional parameters pointer octet in the ISUP message.
Some messages allow optional parameters, even though optional parameters are not defined (for example, the ITU Q.767 Release Complete (RLC) message).
• To include optional parameters, set the value of the Optional Parameters Allowed field to 0x01.
When you set this value to 0x01 and optional parameters are included in the message, the Excel platform automatically inserts the End of Optional Parameters octet.
• For no optional parameters, set the value of the Optional Parameters Allowed field to 0x00 and the value of the Number of Optional Parameters field to 0x00.
• For Repeatable Optional Parameters, set the value of this field to the number of repeated optional parameters.
MSB |
LSB |
||||||
Bits 7-1 Number of Repeatable Optional Parameters Indicator |
Bit 0 Optional Parameters Indicator |
Options for Optional Parameters Allowed Indicator
0 Optional Parameters Not Allowed
1 Optional Parameters Allowed
Options for Number of Repeatable Optional Parameters
0 No Repeatable Optional Parameters
1 -127 Indicate the number Repeatable Optional Parameters
A value of 0x00 for the maximum length fields indicates that no validation is performed for the maximum length of the parameter.