Cisco Cisco Computer Telephony Integration Option 8.5 Reference Guide
5-148
CTI Server Message Reference Guide (Protocol Version 14) for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 8.0(1)
Chapter 5 Application Level Interfaces
Client Control Service
SNAPSHOT_DEVICE_REQ
Use this message to retrieve information on a specified device, including a list of the calls associated
with the device and the current state of each call. The CTI Client must be granted both Client Control
and All Events services to look at all devices. The SNAPSHOT_DEVICE_REQ message is defined in
with the device and the current state of each call. The CTI Client must be granted both Client Control
and All Events services to look at all devices. The SNAPSHOT_DEVICE_REQ message is defined in
Note
If the SERVICE_ACD_LINE_ONLY service is requested, the SNAPSHOT_DEVICE_REQ include the
calls in the confirmation that are on the primary (ACD) line but not the calls on secondary line.
calls in the confirmation that are on the primary (ACD) line but not the calls on secondary line.
CallDeviceType (optional)
The type of device ID in the following
CallDeviceID floating field (
CallDeviceID floating field (
).
There may be more than one
CallDeviceIDType field in the message (see
NumCall Devices). This field always
immediately follows the corresponding
CallConnection DeviceID field.
CallDeviceIDType field in the message (see
NumCall Devices). This field always
immediately follows the corresponding
CallConnection DeviceID field.
USHORT
2
CallDeviceID (optional)
The device ID of the subject device. There
may be more than one CallDeviceID field in
the message (see NumCall Devices). This
field always immediately follows the
corresponding CallDevice IDType field.
may be more than one CallDeviceID field in
the message (see NumCall Devices). This
field always immediately follows the
corresponding CallDevice IDType field.
STRING
64
CallDevice Connection
State (optional)
State (optional)
The local connection state of one of the call
device connections (
device connections (
). There may be
more than one Call DeviceConnection State
field in the message (see NumCall Devices).
This field always immediately follows the
corresponding CallDeviceID field.
field in the message (see NumCall Devices).
This field always immediately follows the
corresponding CallDeviceID field.
USHORT
2
CallReferenceID (optional) For Unified CCE systems where the Unified
CM provides it, this will be a unique call
identifier.
identifier.
UNSPEC
32
COCConnectionCallID
(optional)
(optional)
If specified, indicates that this call is a call on
behalf of a consult call.
behalf of a consult call.
UINT
4
COCCallConnection
DeviceIDType (optional)
DeviceIDType (optional)
If specified, indicates the type of connection
identifier specified in the
ConnectionDeviceID floating field for the
original call (
identifier specified in the
ConnectionDeviceID floating field for the
original call (
USHORT
2
COCCallConnection
DeviceID (optional)
DeviceID (optional)
If specified, indicates the device portion of
the connection identifier of the original call.
the connection identifier of the original call.
STRING
64
Maximum message size (including header):
6879
Table 5-125
SNAPSHOT_CALL_CONF Message Format (continued)
Table 5-126
SNAPSHOT_DEVICE_REQ Message Format
Fixed Part
Field Name
Value
Data Type
Byte Size