Busy Out 0x0018

SwitchKit Name

BusyOut

Type

EXS API and SwitchKit API message

Description

Use this message to "busy out" a channel or range of channels. This allows the host to control the incoming call rate by busying out a selected group of channels, normally on the front end of a system.

You can busy out channels configured with the following trunk types only:

E&M

FXO Loop Start

FXO Ground Start

Related API Messages

Busy Out Flag Configure 0x00D3 (SwitchKit Name: BusyOutFlagConfig)

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

unsigned short StartSpan;

UBYTE StartChannel;

unsigned short EndSpan;

UBYTE EndChannel;

UBYTE Action;

} XL_BusyOut;

C++ Class

class XLC_BusyOut : 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 getAction() const;

void setAction(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 (0x0018)

3, 4

Message Type (0x0018)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

:

AIB

Address Method

0x01 - Range

8, 9

Status (MSB, LSB)

Number of AEs to follow

0x0D Channel (Starting)
0x0D Channel (Ending)

:

Action

0x01 Busy Out

0x02 Release Busy Out

10

Checksum

:

Checksum