SS7 Signaling Route Query 0x0066

You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > SS7 Signaling Route Query 0x0066

SwitchKit Name

SS7SignalingRouteQuery

Type

EXS API and SwitchKit API message

Description

This message retrieves the configuration and status of all indicated signaling routes. This message can also be used to query the Destination ID, given the Route ID.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

UBYTE StackID;

unsigned short Destination;

unsigned short RouteID;

} XL_SS7SignalingRouteQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE StackID;

unsigned short Destination;

unsigned short RouteID;

int DPC;

UBYTE LinkSetID;

UBYTE Priority;

UBYTE DestinationStatus;

UBYTE RouteStatus;

} XL_SS7SignalingRouteQueryAck;

C++ Class

class XLC_SS7SignalingRouteQuery : public XLC_OutboundMessage {

public:

UBYTE getStackID() const;

void setStackID(UBYTE x);

unsigned short getDestination() const;

void setDestination(unsigned short x);

unsigned short getRouteID() const;

void setRouteID(unsigned short x);

};

C++ Class Response

class XLC_SS7SignalingRouteQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getStackID() const;

void setStackID(UBYTE x);

unsigned short getDestination() const;

void setDestination(unsigned short x);

unsigned short getRouteID() const;

void setRouteID(unsigned short x);

int getDPC() const;

void setDPC(int x);

UBYTE getLinkSetID() const;

void setLinkSetID(UBYTE x);

UBYTE getPriority() const;

void setPriority(UBYTE x);

UBYTE getDestinationStatus() const;

void setDestinationStatus(UBYTE x);

UBYTE getRouteStatus() const;

void setRouteStatus(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 (0x0066)	3, 4	Message Type (0x0066)
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	0x20 SS7 Destination/Route Stack ID 0x00 - 0x03 If a valid Destination ID was supplied with the query, this field will contain the same stack ID in the response and the one supplied in the query. If the Destination ID supplied in the query was 0xFFFF, this field will contain the correct stack ID for the Route ID supplied in the query (i.e. the stack ID in the response will be the correct one, even though the one in the query may have been incorrect.) 0xFF - If the Destination ID supplied in the query was 0xFFFF, a response stack ID of 0xFF indicates that the Route ID supplied in the query is not configured and does not have an associated Stack ID. Destination ID 0x0000 to 0x003F - The Destination ID associated with the Route ID supplied in the query. 0xFFFF - If the Destination ID supplied in the query was 0xFFFF, a response Destination ID of 0xFFFF indicates that the Route ID supplied in the query is not configured and does not have an associated Destination ID. Route ID 0x0000 - 0x01FF Note: If it is the Destination ID that is being queried, a positive acknowledgment simply indicates that the Route ID is within range. In this case, a positive acknowledgment will be returned whether this Route ID is configured or not.
	AEs 0x20 SS7 Destination/Route Stack ID When you supply a valid Destination ID with the query, this field must contain the associated Stack ID. When the Destination ID supplied is 0xFFFF, the Stack ID can contain any SS7 Stack ID that is configured, as long as the Stack ID indicated exists on the SS7 card being queried. (The application might not know the correct Stack ID for this Route ID.) Destination ID 0x0000 to 0x003F - Valid 0x0040 to 0xFFFE - Invalid. The message gets a NACK of 0xEC, "Invalid Route Mode." Route ID 0x0000 - 0x01FF
:	Checksum
	Response continued below.
:	DPC (four bytes) Every point code in the API messages will always be 4 bytes long with the first byte (MSB) as zero. See the SS7 section of the Developer's Guide: CCS for an explanation of how to convert the 4 bytes into ITU and ANSI point codes. 0x00000000–0x00FFFFFF The DPC must be in this range for signaling stacks using 24-bit point codes (for example, ANSI). 0x0000000–0x00003FFF The DPC must be in this range for signaling stacks using 14-bit point codes (for example, ITU). 0xFFFFFFFF Indicates de-assignment of the specified destination and all routes to the specified destination. This is the only method that can be used to de-assign a destination. If using the BT IUP protocol, the maximum range for a DPC is 14 bits.
:	Link Set ID The Link Set that carries traffic for this route (0x00 – 0x1F). If the DPC field is not 0xFFFFFFFF, a value of 0xFF in this field indicates de-configuration of the specified route.
:	Priority Signaling traffic is routed over available link sets according to the priority established by the host (0x00 is the lowest priority and 0x23 is the highest priority). Link sets with the same priority to a destination load share traffic as a combination link set.
:	Destination Status 0x00 - Inaccessible 0x01 - Accessible
:	Route Status 0x00 - Unavailable 0x01 - Restricted 0x02 - Available
:	Combined Linkset Reference Indicates that the route being queried and the route given in the reference are both part of a combined linkset. LSB of the number of additional routes that are part of this destination/route ID. MSB of the number of additional routes that are part of this destintation/route ID. LSB of Route ID MSB of Route ID Two bytes above repeat for additional Route IDs.
:	Checksum