Cisco Cisco Computer Telephony Integration Option 9.0 Reference Guide
3-16
CTI Server Message Reference Guide (Protocol Version 14) for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 8.0(1)
Chapter 3 Messaging Conventions
Invoke IDs
Within the floating part, floating fields may appear in any order. In general, each floating field appears
only once unless the field is a member of a list. In this case, a fixed field in the message indicates the
number of list entries present.
only once unless the field is a member of a list. In this case, a fixed field in the message indicates the
number of list entries present.
For a list of possible floating field tag values, see
.
Invoke IDs
All request messages that can be sent to the CTI Server contain a field called the InvokeID. The InvokeID
value is returned in the corresponding response message to the CTI client. A CTI client usually places a
value in this field that enables it to associate a received response with the corresponding request.
Typically, this is simply a counter that is incremented as each request message is sent.
value is returned in the corresponding response message to the CTI client. A CTI client usually places a
value in this field that enables it to associate a received response with the corresponding request.
Typically, this is simply a counter that is incremented as each request message is sent.
Call Event Data
The C
ISCO
CTI Interface presents Call Event data using a CSTA-like model; however, the underlying
ACD datalink may or may not conform to this model. This means that, depending upon the type of ACD
being used, some Call Event messages may not be generated, and some of the CSTA message data for
other events may not be available. Be aware that the interpretation of Call Event data is very
peripheral-specific, particularly when multiple ACD types are being used.
being used, some Call Event messages may not be generated, and some of the CSTA message data for
other events may not be available. Be aware that the interpretation of Call Event data is very
peripheral-specific, particularly when multiple ACD types are being used.
For a discussion of peripheral-specific considerations, see the
.
Device IDs
The Call Event messages detailed later in this document typically provide several different device ID
fields. Depending upon the type of peripheral and the nature of the event, the device ID may represent a
Trunk number, a Trunk Group number, or an agent teleset number (extension). Some peripheral types
may not provide a device ID for one or more fields. To handle these situations, the Call Event messages
provide device IDs using two fields: a fixed field indicating whether or not the device ID was provided
and enumerating the type of device identified, and a floating field containing the device ID (if provided).
fields. Depending upon the type of peripheral and the nature of the event, the device ID may represent a
Trunk number, a Trunk Group number, or an agent teleset number (extension). Some peripheral types
may not provide a device ID for one or more fields. To handle these situations, the Call Event messages
provide device IDs using two fields: a fixed field indicating whether or not the device ID was provided
and enumerating the type of device identified, and a floating field containing the device ID (if provided).
Table 3-8
Floating Field Subfields
Subfield
Value
Data Type
Byte Size
Tag
The type of the floating
field.
field.
UCHAR
1
FieldLength
The number of bytes, n, in
the Data subfield of the
floating field.
the Data subfield of the
floating field.
UCHAR
1
Data
The data.
Depends on field type n