Developer's Guide

4-11
CTI Server Message Reference Guide (Protocol Version 15) for Cisco Unified Contact Center Enterprise
Release 8.5(1)
Chapter 4 Session Management
Session Maintenance
Figure 4-2 Heartbeat Message Flow
The CTI Server does not initiate HEARTBEAT_REQ messages. The CTI Server detects failures using
the IdleTimeout value from the OPEN_REQ message. If you are using heartbeat messages, the CTI
client should set the IdleTimeout value to four times the heartbeat interval. If the CTI Server does not
receive any messages (including HEARTBEAT_REQ messages) for this period of time, the CTI Server
declares a session failure and resets the TCP connection.
Table 4-6 HEARTBEAT_REQ Message Format
Field Name Value Data Type Byte Size
MessageHeader Standard message header.
MessageType = 5.
MHDR 8
InvokeID An ID for this request message,
to be returned in the
corresponding confirm message.
UINT 4
Maximum message size (including header): 12
Table 4-7 HEARTBEAT_CONF Message Format
Field Name Value Data Type Byte Size
MessageHeader Standard message header.
MessageType = 6.
MHDR 8
InvokeID Set to the value of the InvokeID
from the corresponding
HEARTBEAT_REQ message.
UINT 4
Maximum message size (including header): 12
CTI Client
CTI Serve
HEARTBEAT_REQ
HEARTBEAT_CONF
HEARTBEAT_REQ
HEARTBEAT_CONF
Heartbeat
Interval