You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > B Channel Configure 0x00C8
SwitchKit Name
BChannelConfig
Type
EXS API and SwitchKit API message
Description
Use this message to configure the following information contained in ISDN PRI messages associated with outgoing B channel calls:
• Network Type (network-specific facilities)
• Outgoing Information Transfer Capability
• Calling Number Type
• Calling Number Plan ID
• Calling Presence Indicator
• Calling Screening Indicated
• Called Number Type
• Called Number Plan ID
• Outgoing Response Enable Values
Related API Messages
• B Channel Query 0x00CA (SwitchKit Name: BChannelQuery)
Sent by
Overview of message
The following table provides an overview of this message. The table following it, provides the detail for each byte.
|
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 (0x00C8) |
3, 4 |
Message Type (0x00C8) |
|
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
|
6 |
Sequence Number |
6 |
Same Sequence Number |
|
7 |
Logical Node ID |
7 |
Logical Node ID |
|
: |
AIB (Starting with Byte 0) |
8, 9 |
|
|
10 |
Checksum |
||
|
: |
Entity (B Channel Characteristic)
|
||
|
: |
Configuration Option (Value) |
||
|
: |
Checksum |
||
SwitchKit Code
Configuration
BChannelConfig (
Node = integer,
Range = StartSpan:StartChan - EndSpan:EndChan,
Entity = integer,
Value = integer);
C Structure
typedef struct {
unsigned short StartSpan;
UBYTE StartChannel;
unsigned short EndSpan;
UBYTE EndChannel;
UBYTE Entity;
UBYTE Value;
} XL_BChannelConfig;
C++ Class
class XLC_BChannelConfig : public XLC_ChanRangeMessage {
public:
unsigned short getStartSpan() const;
void setStartSpan(unsigned short x);
UBYTE getStartChannel() const;
void setStartChannel(UBYTE x);
unsigned short getEndSpan() const;
void setEndSpan(unsigned short x);
UBYTE getEndChannel() const;
void setEndChannel(UBYTE x);
UBYTE getEntity() const;
void setEntity(UBYTE x);
UBYTE getValue() const;
void setValue(UBYTE x);
};
EXS API Hex Format - Detail
|
MESSAGE (White) |
RESPONSE (Gray) |
||
|
Byte |
Field Description |
Byte |
Field Description |
|
0 |
Frame (0xFE) |
0 |
Frame (0xFE) |
|
1 |
Length, MSB Length, LSB (N) |
1 |
Length, MSB (0x00) Length, LSB (0x07) |
|
2 |
2 |
||
|
3 |
Message Type, MSB (0x00) Message Type, LSB (0xC8) |
3 |
Message Type, MSB (0x00) Message Type, LSB (0xC8) |
|
4 |
4 |
||
|
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
|
6 |
Sequence Number |
6 |
Same Sequence Number |
|
7 |
Logical Node ID
|
7 |
Logical Node ID |
|
: |
AIB Address Method 0x01 Range of AEs |
8, 9 |
Status MSB, LSB |
|
10 |
Checksum |
||
|
|
Number of AEs to follow |
||
|
|
AEs |
||
|
: |
Entity (B Channel Characteristic) Enter the value for the B channel characteristic that you are configuring: 0x01 Network Type (network-specific facilities) 0x02 Outgoing Information Transfer Capability 0x03 Calling Number Type 0x04 Calling Number Plan ID 0x05 Calling Presence Indicator 0x06 Calling Screening Indicated 0x07 Called Number Type 0x08 Called Number Plan ID 0x09 Outgoing Response Enable Values |
||
|
: |
Configuration Option (Value) Enter the desired configuration option.
0x01 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 (Default) 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 0x10 NI 2 INWATS 0x11 NI 2 OUTWATS 0x12 NI 2 Foreign Exchange 0x13 NI 2 Tie Trunk
0x02 Outgoing Information Transfer Capability 0x01 Voice (Default) 0x02 Modem (3.1 KHz audio) 0x03 56 KBPS 0x04 64 KBPS 0x05 64 KBPS Restricted 0x06 Ho (Information Transfer Rate 384 Kbps) 0x07 H11 (Information Transfer Rate 1536 Kbps) 0x08 Multi-rate |
||
|
|
0x03 Calling Number Type 0x01 Unknown 0x02 International number 0x03 National number (Default) 0x04 Subscriber number 0x05 Abbreviated number
0x04 Calling Number Plan ID 0x01 Unknown 0x02 ISDN Numbering Plan/Recommendation E.164/E.163 (Default) 0x03 Private numbering plan 0x04 Telephony numbering plan
0x05 Calling Presentation Indicator 0x01 Presentation is allowed (Default) 0x02 Presentation is restricted 0x03 Number not available due to interworking
|
||
|
|
0x06 Calling Screen Indicator 0x01 User provided, not screened (Default) 0x02 User provided, verified and passed 0x03 User provided, verified and failed 0x04 Network provided
|
||
|
|
0x07 Called Number Type 0x01 Unknown type of number 0x02 International number 0x03 National number 0x04 Subscriber number (Default) 0x05 Abbreviated number
0x08 Called Number Plan ID 0x01 Unknown numbering plan (Default) 0x02 ISDN Numbering Plan/Recommendation E.164/E.163 0x03 Private numbering plan 0x04 Telephony numbering plan
0x09 Outgoing Response Enable (This field is reserved for future use) |
||
|
: |
Checksum |
||