You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > VoIP Protocol Configure 0x00EE
VoIP Protocol Configure 0x00EE
SwitchKit Name
VOIPProtocolConfig
Type
EXS API and SwitchKit API message
Description
VoIP Protocol Configure 0x00EE
This message is used to configure H.323 and Session Initiation Protocol (SIP) software.
Sent by
Example Message (Socket Log Output for SwitchKit)
The following socket log output/example message shows local SIP registrations enabled:
00 0E 00 EE 00 00 FF 00 00 00 00 01 01 C8 01 04
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 (0x00EE) |
3, 4 |
Message Type (0x00EE) |
|
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
|
6 |
Sequence Number |
6 |
Sequence Number |
|
7 |
Logical Node ID |
7 |
Logical Node ID |
|
8 : |
Address Method 0x00 Individual AEs
|
8, 9 |
|
|
Number of AEs to follow |
10 |
Checksum |
|
|
AEs |
|
||
|
: |
Number of TLVs to follow
|
||
|
: |
TLVs |
||
|
: |
: |
||
|
: |
Checksum |
||
SwitchKit Code
Configuration
VOIPProtocolConfig (
Node = integer,
Slot = integer
TLVCount = integer,
Data = string);
NOTE: The Slot parameter is needed only when configuring the H.323 protocol. SIP is configured automatically by SwitchKit.
C Structure
typedef struct {
UBYTE AddrInfo[30];
UBYTE TLVCount;
UBYTE Data[222];
} XL_VOIPProtocolConfig;
C++ Class
class XLC_VOIPProtocolConfig : public XLC_OutboundMessage {
public:
const UBYTE *getAddrInfo() const ;
UBYTE *getAddrInfo();
void setAddrInfo(UBYTE *x);
UBYTE getSlot() const };
void setSlot(UBYTE x) ;
UBYTE getTLVCount() const;
void setTLVCount(UBYTE x);
const UBYTE *getData() const;
UBYTE *getData();
void setData(UBYTE *x);
};
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 (0x00EE) |
3, 4 |
Message Type (0x00EE) |
|
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
|
6 |
Sequence Number |
6 |
Sequence Number |
|
7 |
Logical Node ID |
7 |
Logical Node ID |
|
8 |
AIB Address Method 0x01 Individual AEs
|
8 |
Status MSB
|
|
9 |
Status, LSB
0x01 INVALID_TLV_DATA 0x02 INVALID_DATA_TYPE 0x03 INVALID_NUMBER_OF_TLVS 0x05 INVALID_PROTOCOL 0x06 INVALID_TLV 0x07 INVALID_PORT_NUMBER 0x08 INVALID_DNS 0x09 PROTOCOL RUNNING 0x0A PROTOCOL MISMATCH 0x0B INVALID AIB 0x0D MANDATORY_TLVS_MISSING |
||
|
Number of AEs to follow 0x01 |
10 |
Checksum |
|
|
AEs 0x00 00 00 00 Null (for SIP) 0x01 Slot (for H.323) |
|
||
|
|
Number of TLVs to follow |
||
|
: |
TLVs
Mandatory: 0x01C8 Protocol Type (for H.323 and SIP) Optional 0x011C SIP Stack T.38 Fax Support 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 0x026B Use SIP Max Retransmissions BYE 0x0272 Use SIP Registration Timeout 0x0275 Local Registration Enable/Disable 0x027D SIP Transport Type 0x0280 SIP Existing Socket Reuse 0x0281 SIP Idle Socket Timeout |
||
|
|
0x02C2 Gatekeeper Auto Discovery* 0x02C3 Gatekeeper Auto Registration* 0x02C7 Gateway E-mail ID |
||
|
: |
Checksum |
||
*For information on discovering and registering with a Gatekeeper, please refer to Discovering a Gatekeeper in the Developer’s Guide: Internet Protocol.