You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Route Control 0x00E8
SwitchKit Name
Type
EXS API and SwitchKit API message
Description
Use this message to outseize to a channel using Excel platform Call Control. If you want to the host application to choose the span/channel, use the Outseize Control message instead of this message.
Sent by
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.
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
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
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 API 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.
MESSAGE (White) |
RESPONSE (Gray) |
||
Byte |
Field Description |
Byte |
Field Description |
0 |
Frame (0xFE) |
0 |
Frame (0xFE) |
1, 2 |
Length (0xNNNN) |
1, 2 |
Length (0xNNNN) |
3, 4 |
Message Type (0x00E8) |
3, 4 |
Message Type (0x00E8) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
8 : |
AIB Address Method |
8, 9 |
|
Number of AEs to follow |
10 |
ICB |
|
AEs |
: |
Checksum |
|
: |
ICB |
|
|
: |
: |
|
|
: |
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 (0xNNNN) |
1, 2 |
Length (0xNNNN) |
3, 4 |
Message Type (0x00E8) |
3, 4 |
Message Type (0x00E8) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
8 : |
AIB Address Method 0x00 - Individual AEs |
8, 9 |
Status MSB, LSB |
|
: |
Number of ICBs to follow |
|
Number of AEs to follow |
: |
ICB 0x02 Data ICBs
Only the following TLVs are included |
|
|
: |
Number of TLVs to follow. |
|
|
: |
0x0039 Associated Span/Channel
0x0009 Address Element TLV
(For call ID reporting of outbound |
|
AEs Do not use this AIB. You must use the Router AIB below:
Using this AIB, the Excel platform
|
: |
If the preceding Status field is a positive acknowledgement, this field does not apply. |
|
: |
Number of ICBs to follow |
: |
Checksum |
: |
ICB 0x01 Action ICBs 0x00 Null * 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 * 0x09 Do Call Progress Analysis 0x0A Seize * 0x0C Reserved * 0x0D Cancel R2 Receiver * 0x0E Scan for Backward R2 Signal * 0x0F Wait for Host Control with Answer Supervision * 0x10 Do Call Progress Analysis Without Line Signaling
* The ICB has no data, so you will always use 0x00 for the value of the Data Length field.
0x02 Data ICBs |
||
|
0x03 Extended Data ICBs 0x001E Generic PPL (H.323 / SIP) 0x0033 NPDI Universal ICB (H.323 / SIP) |
||
|
|
||
|
Refer to Interworking TLVs if you have enabled interworking from the VoIP Protocol Configure 0x00EE message. |
||
: |
Checksum |