Developer's Guide

4-4
CTI Server Message Reference Guide (Protocol Version 15) for Cisco Unified Contact Center Enterprise
Release 8.5(1)
Chapter 4 Session Management
Session Initialization
IdleTimeout The session idle timer, expressed in seconds. If
the session is idle (no messages received) for
this length of time, the CTI Server should reset
the TCP connection and await the
establishment of a new session. This value is
typically 4 times the heartbeat interval used by
the CTI client. If the CTI client does not use the
HEARTBEAT_REQ message, set this field to
0xFFFFFFFF.
UINT 4
PeripheralID The Peripheral ID of the ACD whose events are
of interest to the client. Required for Client
Events service; otherwise, set this field to the
special value NULL_ PERIPHERAL_ID.
UINT 4
ServicesRequested A bitwise combination of the CTI Services
listed in that the CTI client is requesting.
UINT 4
CallMsgMask A bitwise combination of the Unsolicited Call
Event Message Masks listed that the CTI client
wishes to receive.
UINT 4
AgentStateMask A bitwise combination of Agent State Masks
that the CTI client wishes to receive.
UINT 4
ConfigMsgMask A bitwise combination of Configuration Event
Masks that the CTI client wishes to receive.
Reserved1 Reserved for future use; set to zero. UINT 4
Reserved2 Reserved for future use; set to zero. UINT 4
Reserved3 Reserved for future use; set to zero. UINT 4
Floating Part
Field Name Value Data Type
Max.
Size
ClientID (required) The user ID of the CTI client. STRING 64
ClientPassword
(required)
The password of the user identified by
ClientID. ClientID and Client Password are
optionally used to authenticate the CTI client
making the session open request. This field
must be present even if authentication is not
being used (it may be of length zero).
UNSPEC 64
ClientSignature
(optional)
A character string appended to the Call Client
History list when this CTI client becomes
associated with a call. If not provided, the
ClientID is used.
STRING 64
AgentExtension The agent’s ACD teleset extension. For
CLIENT EVENTS service, at least one of
AgentExtension, AgentID, or AgentInstrument
must be provided by the CTI Client.
STRING 16
Table 4-2 OPEN_REQ Message Format (continued)