Cisco Cisco Computer Telephony Integration OS 8.5 Guia De Referência
4-4
CTI Server Message Reference Guide (Protocol Version 14) for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 8.0(1)
Chapter 4 Session Management
Session Initialization
MessageHeader
Standard message header. MessageType = 3.
MHDR
8
InvokeID
An ID for this request message, to be returned
in the corresponding confirm message.
in the corresponding confirm message.
UINT
4
VersionNumber
The version number of the interface requested
by the CTI client. This defines the version of
all messages in the message set. For this
release, set this value to 13.
by the CTI client. This defines the version of
all messages in the message set. For this
release, set this value to 13.
UINT
4
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.
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.
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.
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.
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.
that the CTI client wishes to receive.
UINT
4
ConfigMsgMask
A bitwise combination of Configuration Event
Masks that the CTI client wishes to receive.
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
Size
ClientID (required)
The user ID of the CTI client.
STRING
64
ClientPassword
(required)
(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).
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
Table 4-2
OPEN_REQ Message Format (continued)