RTP_STARTED_EVENT (OPTIONAL)
The RTP_STARTED_EVENT message indicates that an RTP (Real Time Protocol) media stream has been started. There are two media streams for audio media (one for the caller and one for the receiver). So there are two RTP Started events, one indicating the input has started (that is, the phone is listening) and the other that the output has started (that is, the outgoing media from the agent phone has begun).
The RTP Started event generally comes up at the same time as the established event. It also occurs when a call is retrieved from being on hold, and when the transfer or conference operations are completed.
There is no guarantee of the order of the RTP started events in relationship to the established and retrieved events. The RTP started events can occur before or after the established event.
Tthe following tables define the format of the RTP_STARTED_EVENT message.
|
Fixed part Field name |
Value |
Data type |
Byte size |
|---|---|---|---|
|
reserved |
This value is set to 0. |
UINT |
4 |
|
reserved |
This value is set to 1. |
UINT |
4 |
|
clientPort |
The TCP/IP port number of the client connection. |
UINT |
4 |
|
Direction |
The direction of the event. One of the following values: 0: Input1: Output2: Bi-directional. |
USHORT |
2 |
|
RTPType |
The type of the RTP event. One of the following values: 0: Audio1: Video2: Data |
USHORT |
2 |
|
BitRate |
The media bit rate, used for a G.723 payload only: RTPBitRateR5_3: 1RTPBitRateR6_4: 2 |
UINT |
4 |
|
EchoCancellation |
0: off1: on |
USHORT |
2 |
|
PacketSize |
The packet size in milliseconds |
UINT |
4 |
|
PayloadType |
The audio codec type. See Audio Codec Type Values. |
USHORT |
2 |
|
ConnectionDeviceType |
The type of device ID supplied in the ConnectionDeviceID floating field. See ConnectionDeviceType Values. |
USHORT |
2 |
|
CallID |
The Call ID value assigned to this call by Unified CCX. |
UINT |
4 |
|
Floating part Field name |
Value |
Data type |
Maximum size |
|---|---|---|---|
|
ConnectionDeviceID[25] (required) |
The device ID between the call and the device. In CTI Protocol Version 14, the general rules for the Primary.Actual Field Format will apply to this field. |
STRING |
64 |
|
clientAddress [81] (required) |
The IP address of the client. |
STRING |
16 |
|
AgentExtension[4] (optional) |
The agent’s IP phone extension |
STRING |
16 |
|
AgentInstrument[6] (optional) |
The agent’s IP phone number |
STRING |
64 |
|
SendingAddress[125] (optional) |
The IP Address to which the client is sending the RTP stream. |
STRING |
16 |
|
SendingPort[126] (optional) |
The UDP (User Datagram Protocol) port number to which the client is sending the RTP Stream. |
UINT |
4 |
|
AgentID[194] |
The agent’s Unified CCX login. |
STRING |
129 |