You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > B Channel Query 0x00CA
SwitchKit Name
BChannelQuery
Type
EXS API and SwitchKit API message
Description
Use this message to query the configuration and current channel state information on an ISDN PRI B Channel, DASS2, or DPNSS B Channel.
The information in the response varies for ISDN and DASS2/DPNSS.
Related API Messages
B Channel Configure 0x00C8 (SwitchKit Name: BChannelConfig)
Sent by
SwitchKit Code
C Structure
typedef struct {
unsigned short Span;
UBYTE Channel;
} XL_BChannelQuery;
C Structure Response
typedef struct {
unsigned short Status;
unsigned short Span;
UBYTE Channel;
UBYTE DChannelID;
UBYTE Facility;
UBYTE BChannel;
UBYTE CurrentState;
UBYTE PriDEnable;
UBYTE PriBEnable;
UBYTE ExternalEnable;
UBYTE HostEnable;
UBYTE ControllingDChannelFlag;
UBYTE NetworkType;
UBYTE CallType;
UBYTE CallingType;
UBYTE CallingNumberPlanID;
UBYTE CallingPresentationInd;
UBYTE CallingScreeningInd;
UBYTE CalledType;
UBYTE CalledNumberPlanID;
UBYTE PCMEncodingFormat;
UBYTE DistantEndReleaseMode;
UBYTE AnswerSupervisionMode;
UBYTE ISDNEventEnable;
UBYTE LocalEndReleaseMode;
UBYTE NetworkBlocked;
} XL_BChannelQueryAck;
C++ Class
class XLC_BChannelQuery : public XLC_OneChannelOutbound {
public:
unsigned short getSpan() const;
void setSpan(unsigned short x);
UBYTE getChannel() const;
void setChannel(UBYTE x);
};
C++ Class Response
class XLC_BChannelQueryAck : public XLC_AcknowledgeMessage {
public:
unsigned short getStatus() const;
void setStatus(unsigned short x);
unsigned short getSpan() const;
void setSpan(unsigned short x);
UBYTE getChannel() const;
void setChannel(UBYTE x);
UBYTE getDChannelID() const;
void setDChannelID(UBYTE x);
UBYTE getFacility() const;
void setFacility(UBYTE x);
UBYTE getBChannel() const;
void setBChannel(UBYTE x);
UBYTE getCurrentState() const
void setCurrentState(UBYTE x);
UBYTE getPriDEnable() const
void setPriDEnable(UBYTE x);
UBYTE getPriBEnable() const;
void setPriBEnable(UBYTE x);
UBYTE getExternalEnable() const;
void setExternalEnable(UBYTE x);
UBYTE getHostEnable() const;
void setHostEnable(UBYTE x);
UBYTE getControllingDChannelFlag() const;
void setControllingDChannelFlag(UBYTE x);
UBYTE getNetworkType() const;
void setNetworkType(UBYTE x);
UBYTE getCallType() const;
void setCallType(UBYTE x);
UBYTE getCallingType() const;
void setCallingType(UBYTE x);
UBYTE getCallingNumberPlanID() const;
void setCallingNumberPlanID(UBYTE x);
UBYTE getCallingPresentationInd() const;
void setCallingPresentationInd(UBYTE x);
UBYTE getCallingScreeningInd() const;
void setCallingScreeningInd(UBYTE x);
UBYTE getCalledType() const;
void setCalledType(UBYTE x);
UBYTE getCalledNumberPlanID() const;
void setCalledNumberPlanID(UBYTE x);
UBYTE getPCMEncodingFormat() const;
void setPCMEncodingFormat(UBYTE x);
UBYTE getDistantEndReleaseMode() const;
void setDistantEndReleaseMode(UBYTE x);
UBYTE getAnswerSupervisionMode() const;
void setAnswerSupervisionMode(UBYTE x);
UBYTE getISDNEventEnable() const;
void setISDNEventEnable(UBYTE x);
UBYTE getLocalEndReleaseMode() const;
void setLocalEndReleaseMode(UBYTE x);
UBYTE getNetworkBlocked() const;
void setNetworkBlocked(UBYTE x);
};
Overview of message
The following two tables provides an overview of this message. The tables following them, provides the detail for each byte.
Overview of ISDN PRI B Channels
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 (0x00CA) |
3, 4 |
Message Type (0x00CA) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
: |
Address Method 0x00 - Individual AEs |
8, 9 |
|
Number of AEs to follow |
|||
: |
Checksum |
: |
AIB Address Method 0x00 - Individual AEs |
Number of AEs to follow |
|||
: |
D Channel ID (Reserved) |
||
|
(Response continued below.) |
||
: |
Facility Number
|
||
: |
B Channel ID (Reserved) |
||
: |
Current State (Reserved) |
||
: |
PRI D Enable (Reserved) |
||
: |
PRI B Enable (Reserved) |
||
: |
External Enable (Reserved) |
||
: |
Host Enable (Reserved) |
||
: |
Controlling D Channel Flag |
||
: |
Network Type |
||
: |
Outgoing Information Transfer Capability |
||
: |
Calling Number Type |
||
: |
Calling Number Plan ID |
||
: |
Calling Presentation Indicator |
||
: |
Calling Screen Indicator |
||
: |
Called Number Type |
||
: |
Called Number Plan ID |
||
: |
PCM Encoding Format |
||
: |
Distant End Release Mode |
||
: |
Answer Supervision Mode |
||
: |
ISDN Event Enable (Reserved) |
||
: |
Local End Release Mode |
||
: |
Network Blocked (Reserved) |
||
: |
Checksum |
Overview of DASS2/DPNSS B Channels
MESSAGE |
RESPONSE |
||
Byte |
Field Description |
Byte |
Field Description |
0 |
Frame (0xFE) |
0 |
Frame (0xFE) |
1 |
Length, MSB |
1 |
Length, MSB |
2 |
Length, LSB (N) |
2 |
Length, LSB (N) |
3 |
Message Type, MSB (0x00) |
3 |
Message Type, MSB (0x00) |
4 |
Message Type, LSB (0xCA) |
4 |
Message Type, LSB (0xCA) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
: |
AIB Address Method 0x00 - Individual AEs |
8,9 |
Status MSB, LSB |
Number of AEs to follow |
|||
: |
Checksum |
: |
AIB Address Method 0x00 - Individual AEs
|
Number of AEs to follow
|
|||
|
|
||
|
(Response continued below.) |
||
: |
D Channel ID (Reserved) |
||
: |
Reserved |
||
: |
B Channel ID (Reserved) |
||
: |
L3P State |
||
: |
L3 State |
||
: |
L2 State |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Controlling D Channel Flag |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Reserved |
||
: |
PCM Encoding Format |
||
: |
Distant End Release Mode |
||
: |
Answer Supervision Mode |
||
: |
Reserved |
||
: |
Local End Release Mode |
||
: |
Reserved |
||
: |
Checksum |
EXS API Hex Format for ISDN PRI B Channels - Detail
NOTE: The reserved fields are used by Excel Technical Support for diagnostic purposes only. Please ignore these fields during normal operation.
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 (0x00CA) |
3, 4 |
Message Type (0x00CA) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
8 |
AIB (Individual AEs) |
8, 9 |
Status MSB, LSB |
: |
Checksum |
10 |
AIB (Individual AEs) |
: |
D Channel ID (Reserved) |
||
|
(Response continued below.) |
||
: |
Facility Number The network-relative facility (or span) number for the associated D channel.
0x00 : For both FAS and NFAS, this value represents the facility in which the controlling
0x01–0x09 : For NFAS, these values represent the other facilities that the D channel controls within the same span. In Non-Facility Associated Signaling (NFAS), one D |
||
: |
B Channel ID (Reserved) |
||
: |
Current State (Reserved) |
||
: |
PRI D Enable (Reserved) The system derives the value from the state as indicated in the Current State field: 0x00 Not Enabled 0x01 Enabled |
||
: |
PRI B Enable (Reserved) The system derives the value from the state as indicated in the Current State field: 0x00 Not Enabled 0x01 Enabled |
||
: |
External Enable (Reserved) The system derives the value from the state as indicated in the Current State field: 0x00 Not Enabled 0x01 Enabled |
||
: |
Host Enable (Reserved) The system derives the value from the state as indicated in the Current State field: 0x00 Not Enabled 0x01 Enabled |
||
: |
Controlling D Channel Flag 0x00 Channel is not a D channel 0x01 Channel is a D channel |
||
: |
Network Type 0x01 Do Not Include Network-Specific Facilities (NSF) IE 0x02 AT&T Software Defined Network 0x03 AT&T Megacom 800 Service 0x04 AT&T Megacom 0x05 AT&T Accunet 0x06 AT&T Long Distance Service 0x07 AT&T International 800 0x08 AT&T Multiquest 0x09 Northern Telecom Private Net 0x0A Northern Telecom Inroads 0x0B Northern Telecom OutWats 0x0C Northern Telecom Foreign Exchange 0x0D Northern Telecom Tie Trunk 0x0E Northern Telecom TRO Call |
||
: |
Outgoing Information Transfer Capability 0x01 Voice 0x02 Modem 0x03 56 Kbps 0x04 64 Kbps 0x05 64 Kbps Restricted |
||
: |
Calling Number Type 0x01 Unknown 0x02 International number 0x03 National number 0x04 Subscriber number 0x05 Abbreviated number |
||
: |
Calling Number Plan ID 0x01 Unknown 0x02 ISDN Numbering Plan/Recommendation E.164/E.163 0x03 Private numbering plan 0x04 Telephony numbering plan |
||
: |
Calling Presentation Indicator 0x01 Presentation is allowed 0x02 Presentation is restricted 0x03 Number not available due to interworking |
||
: |
Calling Screen Indicator 0x01 User provided, not screened 0x02 User provided, verified and passed 0x03 User provided, verified and failed 0x04 Network provided |
||
: |
Called Number Type 0x01 Unknown type of number 0x02 International number 0x03 National number 0x04 Subscriber number 0x05 Abbreviated number |
||
: |
Called Number Plan ID 0x01 Unknown numbering plan 0x02 ISDN numbering plan/Recommendation E.164/E.163 0x03 Private numbering plan 0x04 Telephony numbering plan |
||
: |
PCM Encoding Format 0x01 µ-law Encoding 0x02 A-law Encoding |
||
: |
Distant End Release Mode 0x01 Park 0x02 Release |
||
: |
Answer Supervision Mode 0x00 Propagate Answer to the Distant End 0x01 Notify Host of Answer 0x02 Propagate Answer to the Distant End and Notify Host of Answer 0x03 No Answer Supervision – no propagation of answer or notification |
||
: |
ISDN Event Enable (Reserved) You can send this data to the host using the PPL messages. |
||
: |
Local End Release Mode 0x01 Park 0x02 Release |
||
: |
Network Blocked (Reserved) |
||
: |
Checksum |
EXS API Hex Format for DASS2/DPNSS B Channels - Detail
NOTE: The reserved fields are used by Excel Technical Support for diagnostic purposes only. Please ignore these fields during normal operation.
MESSAGE |
RESPONSE |
||
Byte |
Field Description |
Byte |
Field Description |
0 |
Frame (0xFE) |
0 |
Frame (0xFE) |
1 |
Length, MSB |
1 |
Length, MSB |
2 |
Length, LSB (N) |
2 |
Length, LSB (N) |
3 |
Message Type, MSB (0x00) |
3 |
Message Type, MSB (0x00) |
4 |
Message Type, LSB (0xCA) |
4 |
Message Type, LSB (0xCA) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
8 |
AIB (Individual AEs) |
8, 9 |
Status MSB, LSB |
: |
Checksum |
10 |
AIB (Individual AEs) |
|
(Response continued below.) |
||
: |
D Channel ID (Reserved) |
||
: |
Reserved |
||
: |
B Channel ID (Reserved) |
||
: |
L3P State - Call Control PPL State (0x0D) Indicates the state of the DASS2/DPNSS Call Control PPL component. |
||
: |
L3 State DASS2 States 0x01 Connected 0x02 Dial In (receiving overlap call) 0x03 Dial Out (sending overlap call) 0x04 Idle 0x05 Incoming (received CS) 0x06 Offered (received ICI[C]) 0x07 Offered Incomplete (received ICI[I]) 0x08 Origination (sent ISRM) 0x09 Recovery (Received unexpected message in Idle State) 0x0A Releasing (Waiting for CIM) 0x0B Routing In 0x0C Routing Out
DPNSS States 0x01 Channel Idle 0x02 Spurious Message Received 0x03 Incoming Service Request Incomplete 0x04 Incoming Service Request Complete 0x05 Channel Release Guard 0x06 Channel Release Guard Tell Host 0x07 Setup Complete 0x08 Outgoing Service Request Complete 0x09 Outgoing Service Request Incomplete 0x0A Host Release Wait |
||
: |
L2 State 0x01 Establishing Wait (sent SABMR, waiting for UA) 0x02 Idle (Down) 0x03 Ready (Up) 0x04 Wait Response (Up, waiting for UI[R]) |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Controlling D Channel Flag 0x00 Channel is not a D channel 0x01 Channel is a D channel |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Reserved |
||
: |
Reserved |
||
: |
PCM Encoding Format 0x01 µ-law Encoding 0x02 A-law Encoding |
||
: |
Distant End Release Mode 0x01 Park 0x02 Release |
||
: |
Answer Supervision Mode 0x00 Propagate Answer to the Distant End 0x01 Notify Host of Answer 0x02 Propagate Answer to the Distant End and Notify Host of Answer 0x03 No Answer Supervision – no propagation of answer or notification |
||
: |
Reserved |
||
: |
Local End Release Mode 0x01 Park 0x02 Release |
||
: |
Reserved |
||
: |
Checksum |