You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Inseize Instruction List Configure 0x0029
Inseize Instruction List Configure 0x0029
SwitchKit Name
InseizeInstrListConfig
Type
EXS API and SwitchKit API message
Description
Use several of these messages to form a list of configuration instruction for inseize control. You must send a separate Inseize Instruction List Configure message for each instruction that you add to the list.
After configuring a channel with an inseize instruction list, the Excel platform executes the list upon detecting an inseizure on the channel.
The last instruction in a list should always be "Wait For Host Control" or "Wait for Host Control with Answer Supervision," where the Excel platform waits for further instructions from the host to continue processing.
NOTE: A seize instruction cannot be preprogrammed.
T-ONE Card
When performing Immediate Start on E&M trunks on a T-ONE card, the first inseize instruction must be Generate Inseize ACK.
Related Messages
• Inseize Control 0x002B (InseizeControl)
• Call Control Instructions Query 0x0087 (CallControlInstructionQuery)
Sent by
Host
Example Message
The following example message is sent from the host to the Excel platform to configure an Inseize instruction list on spans 0, 1, 2, 3 - channels 0-23.
00 15 00 29 00 00 ff 01 02 0d 03 00 00 00 0d 03 00 03 17 ff 00 00 00
Clear Instruction List
00 15 00 29 00 00 ff 01 02 0d 03 00 00 00 0d 03 00 03 17 01 07 00 00
Generate Inseize Acknowledgment
00 15 00 29 00 00 ff 01 02 0d 03 00 00 00 0d 03 00 03 17 02 03 01 00
Receive Stage 1 Digits
00 15 00 29 00 00 ff 01 02 0d 03 00 00 00 0d 03 00 03 17 03 02 04 00
Generate Call Processing Event (Wink 2)
00 15 00 29 00 00 ff 01 02 0d 03 00 00 00 0d 03 00 03 17 04 06 00 00
Report Incoming Call With Address Data
00 15 00 29 00 00 ff 01 02 0d 03 00 00 00 0d 03 00 03 17 05 04 00 00
Wait For Host Control
SwitchKit Code
Configuration
InseizeInstrListConfig (
Node = integer,
Range = StartSpan:StartChan - EndSpan:EndChan,
InstrNum = integer,
InstrType = integer,
InstrData1 = integer,
InstrData2 = integer);
C Structure
typedef struct {
unsigned short StartSpan;
UBYTE StartChannel;
unsigned short EndSpan;
UBYTE EndChannel;
UBYTE InstrNum;
UBYTE InstrType;
UBYTE InstrData1;
UBYTE InstrData2;
} XL_InseizeInstrListConfig;
C++ Class
class XLC_InseizeInstrListConfig : 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 getInstrNum() const;
void setInstrNum(UBYTE x);
UBYTE getInstrType() const;
void setInstrType(UBYTE x);
UBYTE getInstrData1() const;
void setInstrData1(UBYTE x);
UBYTE getInstrData2() const;
void setInstrData2(UBYTE x);
};
EXS API Hex Format
MESSAGE (White) |
RESPONSE (Gray) |
||
Byte |
Field Description |
Byte |
Field Description |
0 |
Frame (0xFE) |
0 |
Frame (0xFE) |
1, 2 |
Length (0x00NN) |
1, 2 |
Length (0x0007) |
3, 4 |
Message Type (0x0029) |
3, 4 |
Message Type (0x0029) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
: |
Address Method 0x01 - Range of AEs
|
8, 9 |
|
10 |
Checksum |
||
Number of AEs to follow 0x02 |
|||
AEs 0x0D Channel (Starting) 0x0D Channel (Ending) |
|||
: |
Instruction Number
You must assign each message an instruction number, starting with instruction number 1. The Excel platform executes each message in order, by instruction number until the wait for host control instruction. Valid instruction numbers are 1 - 20.
To clear all instructions from a channel, set the Instruction Number to 0xFF and |
||
: |
Instruction Type 0x00 Null 0x01 Report Call Processing Event 0x02 Generate Call Processing Event 0x03 Receive Stage N Address Data 0x04 Wait for Host Control Message 0x05 Report Incoming Call 0x06 Report Incoming Call with Address Digits 0x07 Generate Inseize Acknowledgment 0x08 Send Host Acknowledgment 0x0A Delay N Milliseconds |
||
: |
Data[0] See Instruction Type Data table below. |
||
: |
Data[1] See Instruction Type Data table below. |
||
: |
Checksum |
Instruction Type Data
Instruction Type |
Data 0 |
Data 1 |
---|---|---|
0x00 Null |
0x00 |
0x00 |
0x01 Report Call Processing Event
|
Call Processing Event 0x00 No Event 0x01 Off-hook 0x02 Digits 0x03 Wink 1 0x04 Wink 2 0x05 Wink 3 0x06 Wink 4 0x07 Wink 5 0x08 Wink 6 0x09 Wink 7 0x0A Wink 8 0x0B Dial Tone
All other events are reserved and must be 0x00. |
* This field is a bit mask. You can report multiple stages at the same time. The following are valid entries for the bits of this field: Bit 0 Stage 1
Bits 4-7 are reserved and must be 0x00. |
0x02 Generate Call Processing Event
|
0x01 ANI Request Off-hook 0x02 Reserved 0x03 Wink 1 0x04 Wink 2 0x05 Wink 3 0x06 Wink 4 0x07 Wink 5 0x08 Wink 6 0x09 Wink 7 0x0A Wink 8 0x0B Backward Pulsed R2 Signal 0x0C Backward Compelled R2 0x0D Backward R2 Signal 0x0F Backward Compelled |
0x00 |
0x03 Receive Stage N Address Data
|
Stage Number |
0x00 |
0x04 Wait for Host Control Message
|
0x00 |
0x00 |
0x05 Report Incoming Call |
0x00 |
0x00 |
0x06 Report Incoming Call with Address Digits |
0x00 |
0x00 |
0x07 Generate Inseize Acknowledgment |
0x00 |
0x00 |
0x08 Send Host Acknowledgment |
0x00 |
0x00 |
0x0A Delay N Milliseconds
|
Delay Value, MSB: Values are in units of 10 ms. Maximum value is 10 seconds (0x03E8). |
Delay Value, LSB:
|