Cisco Cisco Computer Telephony Integration Option 8.5 Reference Guide
3-18
CTI Server Message Reference Guide (Protocol Version 14) for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 8.0(1)
Chapter 3 Messaging Conventions
Failure Indication Messages
ConnectionDeviceID that matches the ConnectionDeviceID provided in the call event message is the call
that is the subject of the event. The only difficult case is determining which call is the subject when a
new call connection is created. For this case, the following rule applies:
that is the subject of the event. The only difficult case is determining which call is the subject when a
new call connection is created. For this case, the following rule applies:
When more than one call with the same ConnectionCallID value exists, the connection being created
by a CALL_ESTABLISHED_ EVENT shall apply to the call that does not yet have a destination
connection established.
by a CALL_ESTABLISHED_ EVENT shall apply to the call that does not yet have a destination
connection established.
Typically, when this occurs, one call will have been the subject of a prior
CALL_ESTABLISHED_EVENT and will have two connections; the other will have only one
originating connection. The CALL_ESTABLISHED_EVENT will therefore create the second
connection on that call. It should never be the case that both calls have already been the subject of a
CALL_ESTABLISHED_EVENT.
CALL_ESTABLISHED_EVENT and will have two connections; the other will have only one
originating connection. The CALL_ESTABLISHED_EVENT will therefore create the second
connection on that call. It should never be the case that both calls have already been the subject of a
CALL_ESTABLISHED_EVENT.
Failure Indication Messages
The CTI Server may indicate errors to the CTI client using the FAILURE_CONF and
FAILURE_EVENT messages. The CTI Server may use the FAILURE_CONF message in response to
any request message from the CTI client. The CTI Server sends the FAILURE_CONF message instead
of the positive confirmation message specific to the request. The format of the FAILURE_CONF
message is defined in
FAILURE_EVENT messages. The CTI Server may use the FAILURE_CONF message in response to
any request message from the CTI client. The CTI Server sends the FAILURE_CONF message instead
of the positive confirmation message specific to the request. The format of the FAILURE_CONF
message is defined in
.
The CTI Server may use the FAILURE_EVENT message to asynchronously indicate a failure or error
condition to the CTI client. The format of the FAILURE_EVENT message is defined in
condition to the CTI client. The format of the FAILURE_EVENT message is defined in
.
Table 3-9
FAILURE_CONF Message Format
Field Name
Value
Data Type
Byte Size
MessageHeader
Standard message header.
MessageType = 1.
MessageType = 1.
MHDR
8
InvokeID
Set to the value of the InvokeID
from the corresponding request
message.
from the corresponding request
message.
UINT
4
Status
A status code indicating the
cause of the failure. The
possible status codes are defined
in
cause of the failure. The
possible status codes are defined
in
.
UINT
4
Maximum message size (including header):
16
Table 3-10
FAILURE_EVENT Message Format
Field Name
Value
Data Type
Byte Size
MessageHeader
Standard message header.
MessageType = 2.
MessageType = 2.
MHDR
8
Status
A status code indicating the
cause of the failure. The
possible status codes are
defined in .
cause of the failure. The
possible status codes are
defined in .
UINT
4
Maximum message size (including header):
12