Outseize Control 0x002C

SwitchKit Name

OutseizeControl

Type

EXS API and SwitchKit API message

Description

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

You can preprogram a list of instructions using the Outseize Instruction List Configure message and initiate them by sending the Outseize Control message with an ICB of "Use Instruction List." Note the seize instruction cannot be pre-programmed.

An instruction that is not carried out reports a negative Acknowledgment. A positive acknowledgment is reported only if an Action ICB of "Send Host Acknowledgment" is included in the message.

ISDN PRI and SS7

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.

For an SS7 channel, this message results in an IAM being sent to the network. Mandatory parameters must be included in an SS7 Parameters ICB.

Related Messages

Outseize Instruction List Configure 0x002A (OutseizeInstrListConfig)

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

C Structure Response

typedef struct {

unsigned short Span;

UBYTE Channel;

UBYTE reserved20[27];

UBYTE ICBCount;

UBYTE ICBData[222];

} XL_OutseizeControlAck;

 

C++ Class

class XLC_OutseizeControl : 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);

};

C++ Class Response

class XLC_OutseizeControlAck : public

XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

 

Overview of Message

MESSAGE (White)

RESPONSE (Gray)

Byte

Field Description

Byte

Field Description

0

Frame (0xFE)

0

Frame (0xFE)

1, 2

Length (0x00NN)

1, 2

Length (0x0009)

3, 4

Message Type (0x002C)

3, 4

Message Type (0x002C)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

:

AIB (starting with Byte 0)

8, 9

Status (MSB, LSB)

:

ICB

10, 11

State

:

:

:

Checksum

:

Checksum

 

EXS API Hex Format-Detailed

MESSAGE (White)

RESPONSE (Gray)

Byte

Field Description

Byte

Field Description

0

Frame (0xFE)

0

Frame (0xFE)

1, 2

Length (0x00NN)

1, 2

Length

0x0007 Positive Acknowledgement

0x0009 Negative Acknowledgement

3, 4

Message Type (0x002C)

3, 4

Message Type (0x002C)

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)

For SSUTR2, the following NACKs apply:

0x0A Continuity Check resources not available

0x0B Incoming specialized circuit

0x0C Congestion

0x0F Blocked

 

For ISUP, the following NACKs apply:

0x0A Continuity Recheck In Progress

0x0B CIC Hardware Remotely Blocked

0x0C CIC in Outgoing Congestion

0x0D CIC Locally Maintenance Blocked

0x0E CIC Remotely Hardware Blocked

0x0F CIC Remotely Maintenance Blocked

Number of AEs to follow

10, 11

State

If the preceding Status field is a positive acknowledgement, this field does not apply.

AE

0x0D Channel

:

Number of ICBs to follow

:

Number of ICBs to follow

 

ICB Subtype

:

Checksum

:

ICB

NOTE: For an SS7 channel in ANSI ISUP CRM/CRA, the Outseize Control message must include an

SS7 Parameters ICB. This allows a CRM message type to be part of the SS7 Parameter ICB that is sent

in the Outseize Control message. To send an IAM message after an Outseize Control message with

CRM, a separate PPL Event Request for IAM must be made.

 

0x01 Action

0x00 Null*

0x01 Scan For Wink N

0x02 Scan For ANI Request Off-hook*

0x03 Scan For Dial Tone*

0x04 Report Call Processing Event

0x05 Outpulse Stage N Address Data

0x06 Wait For Host Address Data*

0x07 Wait For Host Control*

0x08 Send Host Acknowledgment *

(the ISDN PRI card ignores the Send Host Acknowledgment)

0x09 Do Call Progress Analysis

0x0A Seize (see Note 3)*

0x0B Use Instruction List

0x0C Reserved*

0x0D Cancel R2 Receiver*

0x0E Scan For Backward R2 Signal*

0x0F Wait For Host Control With Answer Supervision (see Note 4)*

0x10 Do Call Progress Analysis Without Line Signaling

0x11 Delay N Milliseconds

 

0x02 Data

0x01 Stage N Address Data

0x02 Stage N Address Data

0x10 ISDN Formatted IEs

0x11 ISDN Raw IEs

0x12 SS7 Parameters

0x15 DASS2/DPNSS Raw Data

0x1C SS7 TUP Formatted Fields

0x1E Generic PPL

0x25 ISDN Segmented Message

0x66 SS7 Address Information

 

0x03 Extended Data

0x0012 SS7 Formatted Parameters

0x0033 NPDI Universal ICB

0x001E Generic PPL

 

* The ICB has no data, so you will always use 0x00 for the value of the Data Length field.

:

Checksum

 

 

Notes:

1. When the system outpulses BCD-encoded digits, a Stage N Address Data ICB must accompany the digits to define the outpulsing parameters. The position of the Data ICB is not critical.

2. The host must have a DSP configured for Call Progress Analysis for a "Do Call Progress Analysis" ICB to be invoked. For more information, refer to the message DSP SIMM Configure (0xC0)

3. A seize instruction, when present, must be the first Action ICB. A seize instruction cannot be included in a preprogrammed outseize instruction list.

4. If Answer Supervision Mode is configured for "Notify" or "Notify and Propagate," the host will be informed with a Call Processing Event message of "Answer." Note that the default Answer Supervision Mode is "Propagate."