VoIP Protocol Configure 0x00EE

SwitchKit Name

VOIPProtocolConfig

Type

EXS API and SwitchKit API message

Description

This message is used to configure H.323 and Session Initiation Protocol (SIP) software.

Sent by

Host

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

:

AIB

Address Method

0x01 Individual AEs

 

8, 9

Status MSB, LSB

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
0x04 INVALID_TLV_LENGTH

0x05 INVALID_PROTOCOL

0x06 INVALID_TLV
0x0C INVALID_TLV - Cannot configure the gateway alias names because the IP Signaling Series 3 card is already registered with a gatekeeper.

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

0x0006 Route Group ID

0x01 Add Virtual Card

0x000F Router Protocol ID

0x0013 Routing Method

0x0115 Call Agent Mode

0x01AE Poll Interval Configure

0x01C8 Protocol Type

0x01C9 Primary Matrix IP Port

0x01CA Secondary Matrix IP Port

0x01D6 DNS IP Address

0x01D7 Default Domain Name

0x01ED RFC 2833 Jitter Buffer Size

0x01EE Invalid Packet Alarm Threshold

0x01EF Initial UDP Port Number

0x01F0 Number of UDP Ports

0x01F1 RFC 2833 Dynamic Payload Type

0x0262 Use SIP Local Port
0x0263 Use SIP Remote Port/Default Proxy Port

0x0264 Use SIP Remote Host/Default Proxy Host

0x0265 Use SIP Site ID

0x0266 Use SIP Anonymous Caller

0x0267 Use SIP Invite T1 Timer

0x0268 Use SIP BYE T1 Timer

0x0269 Use SIP T2 Timer

0x026A Use SIP Maximum Retransmissions Invite

0x0270 SIP Tunnel Type

0x0272 Use SIP Registration Timeout

0x0274 Use No Local Media

0x0275 Local Registration Enable/Disable

0x0279 SIP Local Route Lookup

0x027B Session Interval

0x027C Min-SE Interval

0x027D SIP Transport Type
0x027F SIP Message Information Mask

0x027E SIP Persistent Sockets

0x0280 SIP Existing Socket Reuse

0x0281 SIP Idle Socket Timeout

0x0282 PPL Event Notification Mask

0x02BC Gatekeeper IP and Port

 

0x02BE Variant ID

0x02BF Version Number

0x02C0 Terminal Type

0x02C1 Vendor ID

0x02C2 Gatekeeper Auto Discovery*

0x02C3 Gatekeeper Auto Registration*
0x02C4 Gateway E164
0x02C6 Gateway URL ID

0x02C7 Gateway E-mail ID
0x02C8 H.225 T301 Timer

0x02C9 H.225 T303 Timer

0x02CA H.225 T310 Timer

0x02CB H.245 T101 Timer

0x02CC H.245 T103 Timer

0x02CD H.245 T105 Timer

0x02CE H.245 T106 Timer

0x02CF H.245 T108 Timer

0x02D0 H.245 T109 Timer

0x02D1 RAS GRQ Timer

0x02D2 RAS RRQ Timer

0x02D4 H.323 Message Information Mask

0x05EF Alarm Threshold Configure

:

Checksum

*For information on discovering and registering with a Gatekeeper, please refer to Discovering a Gatekeeper in the Developer’s Guide: Internet Protocol.