Cisco Cisco Computer Telephony Integration OS 8.5 Reference Guide

Page of 276
   
5-57
CTI Server Message Reference Guide (Protocol Version 14) for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 8.0(1)
Chapter 5      Application Level Interfaces
Client Monitor Service
CLIENT_SESSION_OPENED_EVENT
This message indicates that a new CTI client session has been opened. One of these messages is sent for 
each existing CTI client session to the newly opened session, as if those CTI clients had just opened their 
sessions. 
 defines the format of the CLIENT_SESSION_OPENED_EVENT message.
Table 5-36
CLIENT_SESSION_OPENED_EVENT Message Format 
Fixed Part
Field Name
Value
Data Type
Byte 
Size
MessageHeader
Standard message header. MessageType = 99.
MHDR
8
SessionID
A value that uniquely identifies the newly 
opened CTI session.
UINT
4
PeripheralID
If the session was opened for Client Events 
Service, this field contains the Unified ICM 
PeripheralID of the ACD specified by the 
opening client. Otherwise this field contains 
the special value NULL_ PERIPHERAL_ID. 
UINT
4
ServicesGranted
A bitwise combination of the CTI Services 
listed in 
 that the opening client has 
been granted.
UINT
4
CallMsgMask
A bitwise combination of Unsolicited Call 
Event Message Masks that were specified by 
the opening client.
UINT
4
AgentStateMask
A bitwise combination of Agent State Masks 
in 
 that were specified by the opening 
client.
UINT
4
ClientPort
The TCP/IP port number of the opening CTI 
client connection.
UINT
4
Floating Part
Field Name
Value
Data Type
Max. 
Size
ClientAddress 
The IP address of the opening CTI client.
STRING
16
ClientID 
The ClientID of the opening CTI client.
STRING
64
ClientSignature 
The ClientSignature of the opening CTI client. STRING
64
AgentExtension (optional)
The AgentExtension specified by the opening 
client, if any.
STRING
16
AgentID (optional)
The AgentID specified by the opening client, if 
any.
STRING
12
AgentInstrument (optional)
The AgentInstrument specified by the opening 
client, if any.
STRING
64
ClientAddressIPV6 (not 
supported by Unified ICM)
The IP Address of the CTI client. Where 
supported this may replace ClientAddress; one 
but not both must be present.
STRING
16
Maximum message size (including header):
280