Outseize Instruction List Configure 0x002A

You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Outseize Instruction List Configure 0x002A

SwitchKit Name

OuseizeInstrListConfig

Type

EXS API and SwitchKit API message

Description

Use several of these messages to preprogram a list of instructions for outseize control on CAS channels. You must send a separate Outseize Instruction List Configure message for each instruction that you add to the list.

Outseize instructions cannot be preprogrammed for ISDN PRI or SS7 channels. You must include all outseize instructions for ISDN PRI and SS7 in the Outseize Control message.

After configuring a channel with an Outseize Instruction List, the Excel platform uses the list to initiate an outseizure on a channel. You set this up by sending an Outseize Control message with a "Use Instruction List" ICB.

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.

Related Messages

• Outseize Control 0x002C (OutseizeControl)

• Call Control Instructions Query 0x0087 (CallControlInstructionQuery)

Sent by

Host

Example Message (Socket Log Output for EXS SwitchKit)

The following socket log output/example message, shows the host sending an Outseize instruction list to the Excel platform to configure span 0x00, channels 0x00 - 0x17.

00 15 00 2A 00 00 ff 01 02 0d 03 00 00 00 0d 03 00 00 17 ff 00 00 00

Clear Instruction list

00 15 00 2A 00 00 ff 01 02 0d 03 00 00 00 0d 03 00 00 17 01 05 01 00

Outpulse stage 1

00 15 00 2A 00 00 ff 01 02 0d 03 00 00 00 0d 03 00 00 17 02 08 00 00

Send host acknowledgement

00 15 00 2A 00 00 ff 01 02 0d 03 00 00 00 0d 03 00 00 17 03 0f 00 00

Wait for host control w/Answer Supervision

SwitchKit Code

Configuration

OutseizeInstrListConfig (

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_OutseizeInstrListConfig;

C++ Class

class XLC_OutseizeInstrListConfig : 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 (0x002A)	3, 4	Message Type (0x002A)
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)
	AIB Address Method 0x00 - Individual AEs	10	Checksum
	Number of AEs to follow
	AE 0x0D Channel (Starting) 0x0D Channel (Ending)
:	Instruction Number You must assign each message an instruction number. The Outseize Control message specifies the first instruction in the list to be used and 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 to 0x00 (Null).
:	Instruction Type 0x00 Null 0x01 Scan For Wink N 0x02 Scan for ANI Request Off-hook 0x03 Scan for Dialtone 0x04 Report Call Processing Event 0x05 Outpulse Stage N Address Data 0x06 Wait for Host Address Data 0x07 Wait for Host Control Message 0x08 Send Host Acknowledgment 0x09 Do Call Progress Analysis 0x0D Cancel R2 Receiver 0x0E Scan for Backward R2 Signal 0x0F Wait for Host Control With Answer Supervision 0x10 Do CPA Without Line Signaling 0x11 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 Scan for Wink N	Wink Number (0x01-0x08)	0x00
0x02 Scan for ANI Request Off-Hook	0x00	0x00
0x03 Scan for Dialtone	0x00	0x00
0x04 Report Call Processing Event	0x01 Off-hook 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 Dialtone Detected 0x0D Backward R2 Signal 0x0E First Digit Detected	0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00
0x05 Outpulse Stage N Address Data	0x01 Stage Number 1 0x02 Stage Number 2 0x03 Stage Number 3 0x04 Stage Number 4	0x00 0x00 0x00 0x00
0x06 Wait for Host Address Data	0x00	0x00
0x07 Wait for Host Control Message	0x00	0x00
0x08 Send Host Acknowledgment	0x00	0x00
0x09 Do Call Progress Analysis	0x00 North American Default 0x01 Dialtone 0x02 CPC Detection 0x03 Energy Detection	0x00 0x00 0x00 0x00
0x0D Cancel R2 Receiver	0x00	0x00
0x0E Scan for Backward R2 Signal	0x00	0x00
0x0F Wait for Host Control with Answer Supervision	0x00	0x00
0x10 Do CPA Without Line Signaling	0x00	0x00
0x11 Delay N Milliseconds	Delay Value, MSB: Values are in units of 10 ms. Max. value is 10 seconds (0x03E8).	Delay Value, LSB:

Default Outseize Instruction Lists

The default instructions for T1 and E1 protocols are as follows:

1. Wait For Host Control Message

1. Outpulse Stage 1 Digits

2. Outpulse Stage 2 Digits

3. Outpulse Stage 3 Digits

4. Outpulse Stage 4 Digits

5. Report Call Processing Event

6. Wait For Host Control Message