Cisco Cisco Computer Telephony Integration Option 9.0 Technical References
49
CTI Server Message Reference Guide (Protocol Version 17) for Cisco Unified Contact Center Enterprise
Release 10.0(1)
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.
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-37
CLIENT_SESSION_OPENED_EVENT Message Format
Fixed Part
Field Name
Value
Data Type
Byte
Size
Size
MessageHeader
Standard message header. MessageType = 99.
MHDR
8
SessionID
A value that uniquely identifies the newly
opened CTI session.
opened CTI session.
UINT
4
PeripheralID
If the session was opened for Client Events
Service, this field contains the PeripheralID of
the ACD specified by the opening client.
Otherwise this field contains the special value
NULL_ PERIPHERAL_ID.
Service, this field contains the 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
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.
Event Message Masks that were specified by
the opening client.
UINT
4
AgentStateMask
that were specified by the opening
client.
UINT
4
ClientPort
The TCP/IP port number of the opening CTI
client connection.
client connection.
UINT
4
Floating Part
Field Name
Value
Data Type
Max.
Size
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.
client, if any.
STRING
16
AgentID (optional)
The AgentID specified by the opening client, if
any.
any.
STRING
12
AgentInstrument (optional)
The AgentInstrument specified by the opening
client, if any.
client, if any.
STRING
64
ClientAddressIPV6 (not
supported by Unified CCE)
supported by Unified CCE)
The IP Address of the CTI client. Where
supported this may replace ClientAddress; one
but not both must be present.
supported this may replace ClientAddress; one
but not both must be present.
STRING
16
Maximum message size (including header):
280