You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Busy Out Flag Configure 0x00D3

Busy Out Flag Configure 0x00D3

SwitchKit Name

BusyOutFlagConfig

Type

EXS API and SwitchKit API message

Description

Busy Out Flag Configure 0x00D3

Use this message to enable the busy out feature on a channel or range of channels.

You cannot "busy out" a channel with the Busy Out message if the Flag field in this message is disabled (0x00). Only channels configured with a trunk type of E&M, FXO Loop Start, or FXO Ground Start can be busied out.

Related API Messages

Busy Out 0x0018 (SwitchKit Name: BusyOut)

Sent by

Host

SwitchKit Code

Configuration

BusyOutFlagConfig (

Node = integer,

Range = StartSpan:StartChan - EndSpan:EndChan,

Flag = integer);

C Structure

typedef struct {

unsigned short StartSpan;

UBYTE StartChannel;

unsigned short EndSpan;

UBYTE EndChannel;

UBYTE Flag;

} XL_BusyOutFlagConfig;

C++ Class

class XLC_BusyOutFlagConfig : 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 getFlag() const;

void setFlag(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 (0xNNNN) | 1, 2 | Length (0x0005)
3, 4 | Message Type (0x00D3) | 3, 4 | Message Type (0x00D3)
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
10 | Checksum
Number of AEs to follow
AEs 0x0D Channel (Starting) 0x0D Channel (Ending)
: | Flag 0x00 Busy Out Disabled (Default) 0x01 Busy Out Enabled
: | Checksum

Message delimiter (SS7 bit pattern - 01111110)
Supervisory signaling commonly used to seize a line, for example by taking your phone off hook, forming a –48 VDC loop with the local central office.
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.
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