You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > ISDN Query 0x0063

ISDN Query 0x0063

SwitchKit Name

ISDNQuery

Type

EXS API and SwitchKit API message

Description

ISDN Query 0x0063

Use this message to query specific parameters configurable by the ISDN Terminal Configure, ISDN Interface Configure, and PPL Configure messages. Hosts applications should consider that future configuration options will be added to this query message, thus changing the length.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE Type;

UBYTE SubType;

} XL_ISDNQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE Data[251];

} XL_ISDNQueryAck;

C++ Class

class XLC_ISDNQuery : public XLC_OutboundMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getSpan() const;

void setSpan(XBYTE x);

UBYTE getChannel() const;

void setChannel(UBYTE x);

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getType() const;

void setType(UBYTE x);

UBYTE getSubType() const;

void setSubType(UBYTE x);

};

C++ Class Response

class XLC_ISDNQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

EXS API Hex Format

MESSAGE | RESPONSE
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1, 2 | Length (0x00NN) | 1, 2 | Length (0x0007)
3, 4 | Message Type (0x0063) | 3, 4 | Message Type (0x0063)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
: | AIB 0x00 - Individual AEs | 8, 9 | Status (MSB, LSB)
10 | Data[0] (See table below)
: | Checksum
Number of AEs to follow
AE 0x01 Slot 0x0D Channel
: | Query Type 0x01 General Interface Options See ISDN Interface Configure message (0x60) 0x02 Terminal Configuration Data 0x03 Assigned Protocols 0x04 IE Library 0x05 HDLC Statistics 0x06 User Service Order Profile (USOP) Database 0x08 Congestion Data 0x0E Configured D Channels 0x0D Super Rate LAPD
: | Query Subtype The meaning of the Query Subtype field depends on the value of the Query Type field. Valid entries for this field are listed below by Query Type field value. 0x01 General Interface Options 0x00 None 0x02 Terminal Configuration Data 0x00 LAPD Info 0x03 Assigned Protocols 0x00 None 0x04 IE Library Entry Number (User-defined) 0x05 HDLC Statistics 0x00 None 0x08 Congestion Data 0x00 None 0x0E Configured D Channels 0x00 None
: | Checksum

10 | Data[0] 0x01 General Interface Options Data[0, 1] Connection Type Data[0] 0x00 (Reserved) Data[1] User-Side Variants 0x01* Lucent 4ESS Q.931 PRI 0x02 Lucent 5ESS Q.931 PRI (Custom) 0x03 Northern Telecom DMS-100 Q.931 PRI (Custom) 0x04 Northern Telecom DMS-250 Q.931 PRI (Custom) 0x05 AUSTEL 0x06 JATE (INS 1500) 0x07 Euro-ISDN PRI (Includes French and German Delta) 0x08 Reserved 0x09 NI 2 User Side Connection endpoint variant 0x0A User Side LAPD variant 0x0B Reserved 0x0C UK DPNSS 0x0D* UK DASS 2 (This is the default, if the card is DASS 2/DPNSS.) Network-Side Variants 0x11-0x16 Reserved 0x17 Euro ISDN PRI 0x19 NI 2 Network Side endpoint variant 0x1A Network Side LAPD variant Data[2, 3] Options (bit mask) Data[2] Reserved (0x00) Data[3] This field is a bit mask, where 0=No and 1=Yes: Bit 0 Send Exactly12 Frames to the Host in a Diagnostic Indication message. Bit 1 DASS2 Ignore Receive Sequence Number Bits 27 Reserved (must be 0) Data[4, 5] D Channel Physical Medium Data[4] 0x00 (Reserved) Data[5] 0x01 64 kbps (T1/E1/J1) Data[6, 7] HDLC Bit Polarity Data[6] 0x00 (Reserved) Data[7] 0x00* Normal 0x01 Inverted (typically used with T1 D4 and AMI line coding) Data[8, 9] Network Side Layer 2 Data[8] 0x00 (Reserved) Data[9] 0x00* User Side 0x01 Network Side (C/R Bit Inverted)
| Data[10, 11] B Channel Selection Mode Data[10] 0x00 (Reserved) Data[11] 0x00 Disabled 0x01* Linear Clockwise 0x02 Linear Counter Clockwise 0x03 Circular Clockwise 0x04 Circular Counter Clockwise Data[12, 13] Location Data[12] 0x00 (Reserved) Data[13] 0x00* User 0x01 Private network serving local user 0x02 Public network serving local user 0x03 Transit network 0x04 Public network serving remote user 0x05 Private network serving remote user 0x07 International network 0x0A Network beyond interworking point Data[14, 15] Channel Release Request on ISDN Disconnect Data[14] 0x00 (Reserved) Data[15] 0x00* Do not send Host Channel Release Request on ISDN Disconnect 0x01 Send Host Channel Release Request on ISDN Disconnect NOTE: The host must respond to a Channel Release Request with a Release With Data message within 20 seconds. Data[16, 17] Protocol Discriminator Value for Maintenance Messages Data[0] 0x00 (Reserved) Data[1] 0x03 Data[18, 19] B Channel Encoding for Transmission Data[0] 0x00 (Reserved) Data[1] 0x00* Channel Number 0x01 Slot Map 0x02 Terminal Configuration Data LAPD Info Data[0, 1] Q.921 T200 Data[2, 3] Q.921 T201 Data[4, 5] Q.921 T202 Data[6, 7] Q.921 T203 Data[8, 9] Q.921 N200 Data[10, 11] Q.921 N201 Data[12, 13] Q.921 N202 Data[14, 15] Acknowledge Pending Timeout Data[16, 17] Window Size Data[18, 19] Options (bit mask)
| 0x03 Assigned Protocols Data[0, 1] Protocol ID for component 5 Data[2, 3] Protocol ID for component 6 Data[4, 5] Protocol ID for component 7 Data[6, 7] Protocol ID for component 8 Data[8, 9] Protocol ID for component 9 Data[10, 11] Protocol ID for component 10 Data[12, 13] Protocol ID for component 11 Data[14, 15] Protocol ID for component 12 Data[16, 17] Protocol ID for component 13 Data[18, 19] Protocol ID for component 14 0x04 IE Library Data[0] Entry Number (029) Data[1] IE Type 0x01 Q.931 IEs Include the following data fields only if Data[1] above is 0x01 (Q.931 IE type): Data[2] Total IE Length (128) Data[3. . .] IE Data 0x05 HDLC Statistics Data[0, 1] Long Frames Detected Data[2, 3] Aborts Received Data[4, 5] CRC Errors Data[6, 7] Short Frames (Counters are reset after Query) 0x06 USOP Database Eight blocks of information are reported for each USOP block configured on the D channel. The format of each block is as follows: Data[0-11] USPID Data[12-21] Directory Number Data[22] GSP Index Data[23] Terminal Initialization Method 0x00 Auto FIT 0x01 Fixed NIT 0x02 Fixed FIT 0x80 Auto NIT with DN 0x81 Auto NIT with no Calling Party Number indicated (use default USOP) Data[24] Fixed Terminal Endpoint Identifier (TEI) (063)
| 0x08 Congestion Data Message Responses: Data [0- 3] Level 2 burst threshold Data [4-7] Level 2 average threshold Data [8-11] Abatement threshold Data [12-15] Burst time window Data [16-19] Number or samples in average Data [20-23] Abatement window Data [24-27] Level 1 burst threshold Data [28-31] Level 1 average threshold 0x0E Configured D Channels Message Responses: Data [0, 1] Maximum Number of D-Channels Configurable (MSB, LSB) Data [2, 3] D-Channel 1 - Logical Span ID (MSB, LSB) Data [4] D-Channel 1 - Channel Data [5] Primary Flag (0x00 if Primary, 0x01 if Secondary) : : Data [n -] NOTE: D-channels that are not configured will return a value of 0xFF FF FF FF. 0x0D Super Rate LAPD Data[0,1] D Channel offset (as specified in D Channel Assign 0xC4) Data[2,3] Super Rate base channel (DSO) Data[4,5] Number of DS0s for Super Rate

See Integrated Services Digital Network.
See Programmable Protocol Language.
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.
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
Least Significant Bit
Link Access Protocol (Procedure) D channel (ISDN)
Call signaling protocol for setup and termination of calls.
Japan Approvals Institute for Telecommunications Equipment
Data channel. One of two fundamental components of an ISDN interface, it provides a path (16Kbps for BRI, 64Kbps for PRI) for carrying control signals and call data in a packet-switched mode.
Digital communications link - voice, data, and video at a 1.544 Mbps rate (24 64 Kbps channels)
A digital communications link - voice, data, and video at a 2.048 Mbps rate; 30B/2D or 31B/1D (ISDN); non-North American version of T1.
A bit framing standard for traditional time-division multiplexing, which standard describes user channels multiplexed onto a trunk that has been segmented (framed) into 24 bytes of 8 bits each. Note: The multiplexing function is performed in the D-4 framing structure by interleaving bits of consecutive bytes as they are presented from individual circuits into each D-4 frame.
Bearer channel, 64Kbps (ISDN) The channel that carries the actual payload (as opposed to D-channels, which carry signaling data that helps route the payload).
An H.323 terminal or gateway, or MCU. An endpoint can call and be called. It generates and/or terminates the information stream.
Range of channels provided by T1 or E1 transmission service. A physical span is a group of channels taking up a single physical wire. A logical span is a group of channels taking up less than a single logical wire, or carried over more than one physical wire.
Message delimiter (SS7 bit pattern - 01111110)