You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Inseize Control 0x002B

Inseize Control 0x002B

SwitchKit Name

InseizeControl

Type

EXS API and SwitchKit API message

Description

Inseize Control 0x002B

Use this message to control incoming call setup during real-time call processing on a specified channel. Instructions and data are passed in this message in the form of Information Control Blocks (ICBs).

You can preprogram a list of instructions using the Inseize Instruction List Configure message and initiate them by sending the Inseize Control message with an ICB of "Use Instruction List".

The system does not replace the default instruction list with the list you specify with the "Use Instruction List" ICB. The system concatenates the list you specify in this message to the default list.

An instruction that is not carried out is reported via a negative acknowledgment. A positive acknowledgment is reported only if you include a "Send Host Acknowledgment" Action ICB in the message.

Related Messages

• Inseize Instruction List Configure 0x0029 (InseizeInstrListConfig)

• Call Control Instructions Query 0x0087 (CallControlInstructionQuery)

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

unsigned short Span;

UBYTE Channel;

UBYTE ICBCount;

UBYTE ICBData[222];

} XL_InseizeControl;

C++ Class

class XLC_InseizeControl : public XLC_OneChannelOutbound {

public:

unsigned short getSpan() const;

void setSpan(unsigned short x);

UBYTE getChannel() const;

void setChannel(UBYTE x);

UBYTE getICBCount() const;

void setICBCount(UBYTE x);

const UBYTE *getICBData() const;

UBYTE *getICBData();

void setICBData(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 (0x002B) | 3, 4 | Message Type (0x002B)
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
: | Number of ICBs to follow (Ignore this field if no ICBs in message.) | 10 | Checksum
: | ICB Valid ICBs for this message are shown below. 0x01 Action 0x00 Null * 0x01 Report Call Processing Event 0x02 Generate Call Processing Event 0x03 Receive Stage N Address Data 0x04 Wait For Host Control * 0x05 Report Incoming Call * 0x06 Report Incoming Call With Address Digits * 0x07 Generate Inseizure Acknowledgment * 0x08 Send Host Acknowledgment * 0x09 Use Instruction List 0x0A Delay N Milliseconds * The ICB has no data, so you will always use 0x00 for the value of the Data Length field.
| Refer to Interworking TLVs if you have enabled interworking from the VoIP Protocol Configure 0x00EE message.
: | Checksum

ICB. A standardized block that allows control data to be inserted in a standard way into API messages.
See Information Control Block.
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.
Setting up, monitoring, and tearing down calls.
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