You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Inpulsing Parameters Query 0x0089

Inpulsing Parameters Query 0x0089

SwitchKit Name

InpulsingParametersQuery

Type

EXS API and SwitchKit API message

Description

Inpulsing Parameters Query 0x0089

This host uses this message to query the inpulsing parameters configured on the specified channel. The response from the CSP reports four two-string stages, even if there is no configuration for a stage (which is reported as 0x00).

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

unsigned short Span;

UBYTE Channel;

} XL_InpulsingParametersQuery;

C Structure Response

typedef struct {

unsigned short Status;

unsigned short Stage1Timer;

UBYTE Stage1Strings;

UBYTE Reserved1;

UBYTE Stage1String1Type;

UBYTE Stage1String1Method;

UBYTE Stage1String1MethodData;

UBYTE Reserved11;

UBYTE Stage1String2Type;

UBYTE Stage1String2Method;

UBYTE Stage1String2MethodData;

UBYTE Reserved12;

unsigned short Stage2Timer;

UBYTE Stage2Strings;

UBYTE Reserved2;

UBYTE Stage2String1Type;

UBYTE Stage2String1Method;

UBYTE Stage2String1MethodData;

UBYTE Reserved21;

UBYTE Stage2String2Type;

UBYTE Stage2String2Method;

UBYTE Stage2String2MethodData;

UBYTE Reserved22;

unsigned short Stage3Timer;

UBYTE Stage3Strings;

UBYTE Reserved3;

UBYTE Stage3String1Type;

UBYTE Stage3String1Method;

UBYTE Stage3String1MethodData;

UBYTE Reserved31;

UBYTE Stage3String2Type;

UBYTE Stage3String2Method;

UBYTE Stage3String2MethodData;

UBYTE Reserved32;

unsigned short Stage4Timer;

UBYTE Stage4Strings;

UBYTE Reserved4;

UBYTE Stage4String1Type;

UBYTE Stage4String1Method;

UBYTE Stage4String1MethodData;

UBYTE Reserved41;

UBYTE Stage4String2Type;

UBYTE Stage4String2Method;

UBYTE Stage4String2MethodData;

UBYTE Reserved42;

} XL_InpulsingParametersQueryAck;

C++ Class

class XLC_InpulsingParametersQuery : 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_InpulsingParametersQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

unsigned short getStage1Timer() const;

void setStage1Timer(unsigned short x);

UBYTE getStage1Strings() const;

void setStage1Strings(UBYTE x);

UBYTE getReserved1() const;

void setReserved1(UBYTE x);

UBYTE getStage1String1Type() const;

void setStage1String1Type(UBYTE x);

UBYTE getStage1String1Method() const;

void setStage1String1Method(UBYTE x);

UBYTE getStage1String1MethodData() const;

void setStage1String1MethodData(UBYTE x);

UBYTE getReserved11() const;

void setReserved11(UBYTE x);

UBYTE getStage1String2Type() const;

void setStage1String2Type(UBYTE x);

UBYTE getStage1String2Method() const;

void setStage1String2Method(UBYTE x);

UBYTE getStage1String2MethodData() const;

void setStage1String2MethodData(UBYTE x);

UBYTE getReserved12() const;

void setReserved12(UBYTE x);

unsigned short getStage2Timer() const;

void setStage2Timer(unsigned short x);

UBYTE getStage2Strings() const;

void setStage2Strings(UBYTE x);

UBYTE getReserved2() const;

void setReserved2(UBYTE x);

UBYTE getStage2String1Type() const;

void setStage2String1Type(UBYTE x);

UBYTE getStage2String1Method() const;

void setStage2String1Method(UBYTE x);

UBYTE getStage2String1MethodData() const;

void setStage2String1MethodData(UBYTE x);

UBYTE getReserved21() const;

void setReserved21(UBYTE x);

UBYTE getStage2String2Type() const;

void setStage2String2Type(UBYTE x);

UBYTE getStage2String2Method() const;

void setStage2String2Method(UBYTE x);

UBYTE getStage2String2MethodData() const;

void setStage2String2MethodData(UBYTE x);

UBYTE getReserved22() const;

void setReserved22(UBYTE x);

unsigned short getStage3Timer() const;

void setStage3Timer(unsigned short x);

UBYTE getStage3Strings() const;

void setStage3Strings(UBYTE x);

UBYTE getReserved3() const;

void setReserved3(UBYTE x);

UBYTE getStage3String1Type() const;

void setStage3String1Type(UBYTE x);

UBYTE getStage3String1Method() const;

void setStage3String1Method(UBYTE x);

UBYTE getStage3String1MethodData() const;

void setStage3String1MethodData(UBYTE x);

UBYTE getReserved31() const;

void setReserved31(UBYTE x);

UBYTE getStage3String2Type() const;

void setStage3String2Type(UBYTE x);

UBYTE getStage3String2Method() const;

void setStage3String2Method(UBYTE x);

UBYTE getStage3String2MethodData() const;

void setStage3String2MethodData(UBYTE x);

UBYTE getReserved32() const;

void setReserved32(UBYTE x);

unsigned short getStage4Timer() const;

void setStage4Timer(unsigned short x);

UBYTE getStage4Strings() const;

void setStage4Strings(UBYTE x);

UBYTE getReserved4() const;

void setReserved4(UBYTE x);

UBYTE getStage4String1Type() const ;

void setStage4String1Type(UBYTE x);

UBYTE getStage4String1Method() const;

void setStage4String1Method(UBYTE x);

UBYTE getStage4String1MethodData() const;

void setStage4String1MethodData(UBYTE x);

UBYTE getReserved41() const;

void setReserved41(UBYTE x);

UBYTE getStage4String2Type() const;

void setStage4String2Type(UBYTE x);

UBYTE getStage4String2Method() const;

void setStage4String2Method(UBYTE x);

UBYTE getStage4String2MethodData() const;

void setStage4String2MethodData(UBYTE x);

UBYTE getReserved42() const;

void setReserved42(UBYTE x);

};

EXS API Hex Format

MESSAGE | RESPONSE
--- | ---
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1, 2 | Length (0x0004) | 1, 2 | Length (0x0037)
3, 4 | Message Type (0x0089) | 3, 4 | Message Type (0x0089)
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
AE 0x0D Channel
: | Checksum

| RESPONSE continued below.
10-13 | Stage 1 | Stage Complete Timer, MSB
Stage Complete Timer, LSB
Number of Digit Strings
Reserved (0x00)
14-17 | String 1 | Address Signaling Type 0x01 DTMF 0x02 MFR1 0x03 MFR2 0x05 Dial Pulse NOTE: These values are identical for each field labeled "Address Signaling Type"
Collection Method 0x01 Fixed Number of Digits 0x02 Use Termination Digit 0x03 Use KP_ST Signals, KP and ST digits not reported to host. 0x05 Compelled 0x06 Use KP digit and any ST digit, KP, and ST digits are reported to host. NOTE: These values are identical for each field labeled "Collection Method"
String Collection Data The value of the String Collection Data field depends on the value of the Collection Method field. Fixed Number of Digits: Digit Count Use Termination Digit: Digit Value Use KP_ST 0x0B (ST digit) Compelled Digit Count NOTE: These values are identical for each field labeled "String Collection Data"
Reserved (0x00)
18-21 | String 2 | Address Signaling Type
Collection Method
String Collection Data
Reserved (0x00)
22-25 | Stage 2 | Stage Complete Timer, MSB
Stage Complete Timer, LSB
Number of Digit Strings
Reserved (0x00)
26-29 | String 1 | Address Signaling Type
Collection Method
String Collection Data
Reserved (0x00)
30-33 | String 2 | Address Signaling Type
Collection Method
String Collection Data
Reserved (0x00)
34-37 | Stage 3 | Stage Complete Timer, MSB
Stage Complete Timer, LSB
Number of Digit Strings
Reserved (0x00)
38-41 | String 1 | Address Signaling Type
Collection Method
String Collection Data
Reserved (0x00)
42-45 | String 2 | Address Signaling Type
Collection Method
String Collection Data
Reserved (0x00)
46-49 | Stage 4 | Stage Complete Timer, MSB
Stage Complete Timer, LSB
Number of Digit Strings
Reserved (0x00)
50-53 | String 1 | Address Signaling Type
Collection Method
String Collection Data
Reserved (0x00)
54-57 | String 2 | Address Signaling Type
Collection Method
String Collection Data
Reserved (0x00)
58 | Checksum

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