You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > VoIP Protocol Query 0x00EF
SwitchKit Name
VOIPProtocolQuery
Type
EXS API and SwitchKit API message
Description
Use this message to query the VoIP configuration.
Sent by
SwitchKit Code
C Structure
typedef struct {
UBYTE TLVCount;
UBYTE Data[222];
} XL_VOIPProtocolQuery;
C Structure Response
typedef struct {
unsigned short Status;
UBYTE TLVCount;
UBYTE Data[250];
} XL_VOIPProtocolQueryAck;
C++ Class
class XLC_VOIPProtocolQuery : public XLC_OutboundMessage {
public:
UBYTE getTLVCount() const
void setTLVCount(UBYTE x)
const UBYTE *getData() const
UBYTE *getData()
void setData(UBYTE *x);
};
C++ Class Response
class XLC_VOIPProtocolQueryAck : public XLC_AcknowledgeMessage {
public:
unsigned short getStatus() const;
void setStatus(unsigned short x);
UBYTE getTLVCount() const;
void setTLVCount(UBYTE 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 (0x00EF) |
3, 4 |
Message Type (0x00EF) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
8 : |
Address Method 0x01 |
8, 9 |
|
Number of AEs to follow |
10
|
Checksum |
|
AEs
|
|
||
: |
Number of TLVs to follow |
||
: |
TLVs |
||
: |
: |
||
: |
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 (0x00EF) |
3, 4 |
Message Type (0x00EF) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
8-11 |
AIB Address Method 0x00 - Individual AEs |
8 |
Status MSB |
9 |
Status LSB
0x01 INVALID_TLV_DATA 0x02 INVALID_DATA_TYPE 0x05 INVALID_PROTOCOL 0x06 INVALID_TLV |
||
Number of AEs to follow |
|||
AE 0x00 00 00 00 Null (for SIP) |
|||
12 |
Number of TLVs to follow |
10 |
Number of TLVs to follow |
: |
TLV (same as message) |
||
: |
Checksum |
||
13 |
TLVs
Mandatory: 0x01C8 Protocol Type (for H.323 and SIP) Optional 0x01AE Poll Interval Configure 0x01CA Secondary Matrix IP Port 0x01ED RFC 2833 Jitter Buffer Size 0x01EE Invalid Packet Alarm Threshold 0x01EF Initial UDP Port Number 0x01F1 RFC 2833 Dynamic Payload Type 0x0262 Use SIP Local Port 0x0264 Use SIP Remote Host/Default Proxy Host 0x0266 Use SIP Anonymous Caller 0x0267 Use SIP Invite T1 Timer 0x026A Use SIP Maximum Retransmissions Invite 0x0272 Use SIP Registration Timeout 0x0275 Local Registration Enable/Disable 0x027D SIP Transport Type 0x0280 SIP Existing Socket Reuse 0x0281 SIP Idle Socket Timeout |
Value (Hex) |
Name |
Description |
0x01 |
Invalid query type |
User requested an incorrect query type |
0x02 |
IMSG Error |
Error due to IMSG operation, addTLV, getTLV, deleteTLV, addorReplace TLV. |
0x03 |
Internal Message Error |
Unable to send or create internal message |
0x04 |
PSOS Error |
Unable to get memory |
*For information on discovering and registering with a Gatekeeper, please refer to "Discovering a Gatekeeper" in the Developer’s Guide: Internet Protocol.