You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Channel Parameter Query 0x0080

Channel Parameter Query 0x0080

SwitchKit Name

ChannelParameterQuery

Type

EXS API and SwitchKit API message

Description

Channel Parameter Query 0x0080

This message is used to query signaling timers and filters and configuration for Channel Associated Signaling (CAS) channels. The message response is formatted differently depending on the trunk type of the channel.

• PPL Format: E-ONE, T-ONE, SE1LC cards

• Non-PPL: T-ONE or ST1LC card using non-PPL format.

This message handles all DS3 functionality, including enabling and disabling loop back configuration and loop back queries. You must specify the slot number and the DS3 offset. You must take a DS3 span out of service before you can place it into remote loop back.

Do not use this message for Common Channel Signaling (CCS) channels. For ISDN, use the B Channel Query message. For SS7, use the SS7 CIC Query message.

NOTE: The message format to query PPL channels includes a Response Format field. For backward compatibility, if no value is present, the response will be in non-PPL format.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

unsigned short Span;

UBYTE Channel;

} XL_ChannelParameterQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE TrunkType;

UBYTE Data[235];

} XL_ChannelParameterQueryAck;

C++ Class

class XLC_ChannelParameterQuery : 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_ChannelParameterQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getTrunkType() const;

void setTrunkType(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

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 (0x005B)
3, 4 | Message Type (0x0080) | 3, 4 | Message Type (0x0080)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
: | AIB | 8, 9 | Status MSB, LSB
: | Response Format | 10 | Trunk Type
: | Checksum | 11 | Host Service State
| Response continued below.
12 | Reserved
13 | Transmit Idle Signaling
14 | Transmit Out of Service Signaling
15 | Busy Out Enable
16 | Distant End Release Mode
17 | Answer Supervision Mode
18–37 | PPL Protocol Name
38, 39 | R2 Timer 1
40, 41 | R2 Timer 2
42, 43 | R2 Timer 3
44, 45 | R2 Timer 4
46, 47 | DTMF Timer 1
48, 49 | DTMF Timer 2
50, 51 | DTMF Timer 3
52, 53 | DTMF Timer 4
54, 55 | DTMF Timer 5
56, 57 | DTMF Timer 6
58, 59 | MFR1 Timer 1
60, 61 | MFR1 Timer 2
62, 63 | MFR1 Timer 3
64, 65 | MFR1 Timer 4
66, 67 | MFR1 Timer 5
68, 69 | MFR1 Timer 6
70, 71 | MFR1 Timer 7
72, 73 | MFR1 Timer 8
74, 75 | DP Timer 1
76, 77 | DP Timer 2
78, 79 | DP Timer 3
80, 81 | DP Timer 4
82, 83 | DP Timer 5
84, 85 | DP Timer 6
86, 87 | DP Timer 7
88, 89 | DP Timer 8
90, 91 | DP Timer 9
92 | Local End Release Mode
93 | PCM Encoding Format
94 | Checksum

EXS API Hex Format- Detailed

PPL Format

The table below lists the message and response formats to query channels on an E-ONE, SE1LC, or T-ONE card with PPL format.

MESSAGE (White) | RESPONSE (Gray)
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1 | Length, MSB | 1 | Length, MSB (0x00)
2 | Length, LSB (N) | 2 | Length, LSB (0x5B)
3 | Message Type, MSB (0x00) | 3 | Message Type, MSB (0x00)
4 | Message Type, LSB (0x80) | 4 | Message Type, LSB (0x80)
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
AEs 0x0D Channel
: | Response Format The desired format of the response data from the CSP. NOTE: If no value is entered in this field, the response will be in non-PPL format. 0x00 PPL (T-ONE, E-ONE, SE1LC cards) | 10 | Trunk Type 0x09 PPL
: | Checksum | 11 | Host Service State 0x00 Out of Service 0x01 In Service
| Response continued below.
12 | Reserved
13 | Transmit Idle Signaling
14 | Transmit Out of Service Signaling
15 | Busy Out Enable 0x00 Busy Out disabled on this trunk 0x01 Busy Out enabled on this trunk
16 | Distant End Release Mode 0x01 Park 0x02 Release
17 | 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)
18–37 | PPL Protocol Name
38, 39 | R2 Timer 1
40, 41 | R2 Timer 2
42, 43 | R2 Timer 3
44, 45 | R2 Timer 4
46, 47 | DTMF Timer 1
48, 49 | DTMF Timer 2
50, 51 | DTMF Timer 3
52, 53 | DTMF Timer 4
54, 55 | DTMF Timer 5
56, 57 | DTMF Timer 6
58, 59 | MFR1 Timer 1
60, 61 | MFR1 Timer 2
62, 63 | MFR1 Timer 3
64, 65 | MFR1 Timer 4
66, 67 | MFR1 Timer 5
68, 69 | MFR1 Timer 6
70, 71 | MFR1 Timer 7
72, 73 | MFR1 Timer 8
74, 75 | DP Timer 1
76, 77 | DP Timer 2
78, 79 | DP Timer 3
80, 81 | DP Timer 4
82, 83 | DP Timer 5
84, 85 | DP Timer 6
86, 87 | DP Timer 7
88, 89 | DP Timer 8
90, 91 | DP Timer 9
92 | Local End Release Mode 0x01 Park 0x02 Release
93 | PCM Encoding Format 0x01 µ-law Encoding 0x02 A-law Encoding
94 | Checksum

EXS API Hex Format - Detailed

Non-PPL Format

The following is the message and response format for non-PPL channels (ST1LC card or T-ONE card using non-PPL channels).

MESSAGE (White) | RESPONSE (Gray)
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1 | Length, MSB | 1 | Length, MSB (0x00)
2 | Length, LSB (N) | 2 | Length, LSB (0xF4)
3 | Message Type, MSB (0x00) | 3 | Message Type, MSB (0x00)
4 | Message Type, LSB (0x80) | 4 | Message Type, LSB (0x80)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
8 | AIB 0x0D Channel | 8, 9 | Status MSB, LSB
: | Checksum
| Response continued below.
10 | Trunk Type 0x01 E&M 0x02 FXO Loop Start 0x03 FXS Loop Start 0x04 FXO Ground Start 0x05 FXS Ground Start 0x06 DPO 0x07 DPT 0x08 Reserved 0x0A DID
11 | Flash Timing Status 0x00 Flash Timing OFF 0x01 Flash Timing ON, propagate to distant end 0x02 Flash Timing ON, inform host 0x03 Flash Timing ON, inform host and propagate
12 | Current Layer 3 State
13 | Host Service State 0x00 Out of Service 0x01 In Service
Signal Scanning Filters
14, 15 | Preseize
16, 17 | Inseize
18, 19 | Modified Incoming Release
20, 21 | Modified Outgoing Release
22, 23 | Normal Incoming Release
24, 25 | Normal Incoming Release with Flash
26, 27 | Normal Outgoing Release
28, 29 | Normal Outgoing Release with Flash
30, 31 | Post Inseize Acknowledge
32, 33 | Outseize Acknowledge
34, 35 | Outseize Answer
36, 37 | Outseize Dial Signal End
38, 39 | First Release
40, 41 | ANI Request Off-hook
Signal Scanning Timers
42, 43 | Inseize Complete
44, 45 | Post Inseize Complete
46, 47 | Start Normal Outgoing Release
48, 49 | Start Normal Incoming Release
50, 51 | Outseize Acknowledge
52, 53 | Outseize Answer
54, 55 | Guard Timeout
56, 57 | Release
58, 59 | Glare Detection
60, 61 | Minimum Flash
62, 63 | Maximum Flash
64, 65 | Start Dial Minimum Wink
66, 67 | Start Dial Maximum Wink
68, 69 | Minimum Delay Dial Signal
70, 71 | Maximum Delay Dial Signal
72, 73 | Post Start Dial Signal Outpulse Delay
74, 75 | Wink 2 Min. Receive Duration
76, 77 | Wink 2 Max. Receive Duration
78, 79 | Wink 2 Min. Post Outpulse Delay
80, 81 | Wink 2 Max. Post Outpulse Delay
82, 83 | Wink 2 Max. Receive Detection
84, 85 | Wink 3 Min. Receive Duration
86, 87 | Wink 3 Max. Receive Duration
88, 89 | Wink 3 Min. Post Outpulse Delay
90, 91 | Wink 3 Max. Post Outpulse Delay
92, 93 | Wink 3 Max. Receive Detection
94, 95 | Wink 4 Min. Receive Duration
96, 97 | Wink 4 Max. Receive Duration
98, 99 | Wink 4 Min. Post Outpulse Delay
100, 101 | Wink 4 Max. Post Outpulse Delay
102, 103 | Wink 4 Max. Receive Detection
104, 105 | Wink 5 Min. Receive Duration
106, 107 | Wink 5 Max. Receive Duration
108, 109 | Wink 5 Min. Post Outpulse Delay
110, 111 | Wink 5 Max. Post Outpulse Delay
112, 113 | Wink 5 Max. Receive Detection
114, 115 | Wink 6 Min. Receive Duration
116, 117 | Wink 6 Max. Receive Duration
118, 119 | Wink 6 Min. Post Outpulse Delay
120, 121 | Wink 6 Max. Post Outpulse Delay
122, 123 | Wink 6 Max. Receive Detection
124, 125 | Wink 7 Min. Receive Duration
126, 127 | Wink 7 Max. Receive Duration
128, 129 | Wink 7 Min. Post Outpulse Delay
130, 131 | Wink 7 Max. Post Outpulse Delay
132, 133 | Wink 7 Max. Receive Detection
134, 135 | Wink 8 Min. Receive Duration
136, 137 | Wink 8 Max. Receive Duration
138, 139 | Wink 8 Min. Post Outpulse Delay
140, 141 | Wink 8 Max. Post Outpulse Delay
142, 143 | Wink 8 Max. Receive Detection
144, 145 | Post ANI Off-Hook Outpulse Delay
146, 147 | Max. Receive ANI Off-Hook Request Detection
148, 149 | Max. Receive Dialtone Detection
150, 151 | MFR1 Min. Receive KP Duration
152, 153 | MFR1 Min. Receive Digit Duration
154, 155 | MFR1 Max. Receive KP Detection
156, 157 | MFR1 Min. Receive Interdigit Duration
158, 159 | MFR1 Max. Receive Interdigit Duration
160, 161 | DTMF Max. Receive 1st Digit Detection
162, 163 | DTMF Min. Receive 1st Digit Detection
164, 165 | DTMF Min. Receive Interdigit Duration
166, 167 | DTMF Max. Receive Interdigit Duration
Transmit Signal Timers
168, 169 | Wink Duration
170, 171 | Flash Duration
172, 173 | Primary Outseize Signaling
174, 175 | Outseize Signaling
176, 177 | Delay Dial Signal Start
178, 179 | Fixed Pause
180, 181 | Timed Answer
182, 183 | Ringing On Duration
184, 185 | Ringing Off Duration
186, 187 | Wink 1 Min. Transmit Delay
188, 189 | Wink 2 Min. Transmit Delay
190, 191 | Wink 2 Max. Transmit Delay
192, 193 | Wink 2 Transmit Duration
194, 195 | Wink 3 Min. Transmit Delay
196, 197 | Wink 3 Max. Transmit Delay
198, 199 | Wink 3 Transmit Duration
200, 201 | Wink 4 Min. Transmit Delay
202, 203 | Wink 4 Max. Transmit Delay
204, 205 | Wink 4 Transmit Duration
206, 207 | Wink 5 Min. Transmit Delay
208, 209 | Wink 5 Max. Transmit Delay
210, 211 | Wink 5 Transmit Duration
212, 213 | Wink 6 Min. Transmit Delay
214, 215 | Wink 6 Max. Transmit Delay
216, 217 | Wink 6 Transmit Duration
218, 219 | Wink 7 Min. Transmit Delay
220, 221 | Wink 7 Max. Transmit Delay
222, 223 | Wink 7 Transmit Duration
224, 225 | Wink 8 Min. Transmit Delay
226, 227 | Wink 8 Max. Transmit Delay
228, 229 | Wink 8 Transmit Duration
230, 231 | MFR1 Transmit KP Duration
232, 233 | MFR1 Transmit Digit Duration
234, 235 | MFR1 Transmit Interdigit Duration
236, 237 | DTMF Transmit Digit Duration
238, 239 | DTMF Transmit Interdigit Duration
Channel Configuration
240 | Incoming Start Dial Type 0x00 Not Configured or Invalid for Trunk Type 0x01 Wink Start 0x02 Delay Dial 0x03 Immediate 0x04 Dial Tone
241 | Outgoing Start Dial Type 0x00 Not Configured or Invalid for Trunk Type 0x01 Wink Start 0x02 Delay Dial 0x03 Fixed Pause 0x04 Dial Tone
242 | Busy Out Flag 0x00 Busy Out disabled on this trunk 0x01 Busy Out enabled on this trunk
243 | Distant End Release Mode 0x01 Park 0x02 Release
244 | 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)
245 | Local End Release Mode 0x01 Park 0x02 Release
246 | PCM Encoding Format 0x01 µ-law Encoding 0x02 A-law Encoding
247 | Checksum

CAS. Signaling in which the signals necessary to switch a given circuit are transmitted via the circuit itself or via a signaling channel permanently associated with it.
See Channel Associated Signaling.
See Programmable Protocol Language.
CCS. Network architecture using SS7 protocol for the exchange of information between telecommunications nodes and networks on an out-of-band basis.
See Common Channel Signaling.
See Integrated Services Digital Network.
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).
See Signaling System Number Seven.
See Circuit Identification Codes.
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.
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.
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
The condition of a component at a given instant. The current "context" of a PPL object, such as Idle, Seizing, Answered. In PPL files, a State is represented by a circle.
See Pulse Code Modulation.
Supervisory signaling commonly used to seize a line, for example by taking your phone off hook, forming a –48 VDC loop with the local central office.
Quick depress and release of the phone plunger of a handset to signal the PBX or Centrex of instructions to follow (e.g., Call Transfer).
Protocol layer of the CSP.
Outgoing call setup during real-time call processing on a specific channel.
See Automatic Number Identification.
Momentary interruption in a single frequency tone indicating the distant switch is ready to receive the digits just dialed.
Message delimiter (SS7 bit pattern - 01111110)