Route Control 0x00E8

SwitchKit Name

Route Control

Type

EXS API and SwitchKit API message

Description

Route Control 0x00E8

Use this message to outseize to a channel using the CSP Call Control. If you want to the host application to choose the span/channel, use the Outseize Control message instead of this message.

Contact Cantata Technical Support if you want to send a Route Control message greater than 512 bytes.

Sent by

Host

Protocol-Specific Considerations

This section provides protocol-specific considerations to help you use this message for VoIP calls. Note that these are examples and that there are several other ways to use the Route Control message.

The mandatory TLVs are listed for each ICB, but other protocol specific TLVs are mandatory in order to initiate an outbound call. Moreover, you may include additional optional TLVs as needed.

SIP

For physical SIP calls, the Route Control message must contain the following:

AIB - 0x0029 - Generic Router

Extended ICBs

0x001E Generic PPL ICB

0x0013 Routing Method TLV

Value: 0x0008 Criteria Type

0x000F Router Protocol ID TLV
Value: 0x000B Default Router

0x0008 Criteria Type TLV

Value: 0x0065 Physical VoIP Channel

0x0065 Physical VoIP Channel TLV

Value: 0x0000 (reserved)

0x0033 NPDI Universal ICB

0x277E Remote Side Protocol TLV

Value: 0x08 - SIP

H.323

For H.323 calls, the Route Control message must contain the following:

AIB - 0x0029 - Generic Router

Extended ICBs

0x001E Generic PPL ICB

0x0013 Routing Method TLV

Value: 0x0008 Criteria Type

0x000F Router Protocol ID TLV

Value: 0x000B Default Router

0x0008 Criteria Type TLV

Value: 0x0065 Physical VoIP Channel

0x0065 Physical VoIP Channel TLV

Value: 0x0000 (reserved)

0x0033 NPDI Universal ICB

0x277E Remote Side Protocol TLV

Value: 0x09 H.323

0x27C2 Remote End Signaling IP Address (Q.931) TLV

Value: IP Address

SIP Call Agent

For Call Agent calls, the Route Control message must contain the following:

AIB - 0x0029 - Generic Router

Extended ICBs

0x001E Generic PPL ICB

0x0013 Routing Method TLV

Value: 0x0008 Criteria Type

0x000F Router Protocol ID TLV

Value: 0x000B Default Router

0x0008 Criteria Type TLV

Value: 0x0071 Virtual VoIP Channel

0x0071 Virtual VoIP Channel TLV

Value: 0x0000 (reserved)

0x0033 - NPDI Universal ICB

0x277E Remote Side Protocol TLV

Value: 0x08 SIP

Interworking

For Interworking calls, the Route Control message must contain the following:

AIB - 0x0029 - Generic Router

Extended ICBs

0x001E Generic PPL ICB

0x0013 Routing Method TLV

Value: 0x0008 Criteria Type

0x000F Router Protocol ID TLV

Value: 0x000B Default Router

0x0008 Criteria Type TLV

Value: 0x0065 Physical VoIP Channel

0x0065 Physical VoIP Channel TLV

Value: 0x0000 (reserved)

0x0033 NPDI Universal ICB

0x277E Remote Side Protocol TLV

Value: 0x08 SIP

Clear Channel VoIP

For Clear Channel VoIP calls, the Route Control message must contain the following:

ICBs

0x001E Generic PPL ICB or 0x1E Generic PPL ICB

0x0013 Routing Method TLV

Value: 0x0009 Terminating Channel

0x0009 Terminating Channel TLV

Refer to the Developer’s Guides for examples that include the Route Control message.

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE ICBCount;

UBYTE Data[222];

} XL_RouteControl;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE Data[251];

} XL_RouteControlAck;

C++ Class

class XLC_RouteControl : public XLC_OneChannelOutbound {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getSpan() const;

void setSpan(XBYTE x);

UBYTE getChannel() const;

void setChannel(UBYTE x);

XBYTE getRouterHandle() const;

void setRouterHandle(unsigned short x);

UBYTE getICBCount() const;

void setICBCount(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

C++ Class Response

class XLC_RouteControlAck : 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

The following table provides an overview of this message. The table following it, provides the detail for each byte.

EXS API Hex Format - Detailed