Cisco Cisco Computer Telephony Integration Option 9.0 Technical References
43
CTI Server Message Reference Guide (Protocol Version 17) for Cisco Unified Contact Center Enterprise
Release 10.0(1)
Peripheral Monitor Service
Peripheral Monitor Service
Peripheral Monitor service is similar to All Events service, and uses many of the same messages. Unlike
All Events service, however, the CTI client that has been granted Peripheral Monitor service must
specify for which devices and/or calls it wishes to receive events. The CTI client does this by
establishing a separate monitor for each device (Trunk, Trunk Group, or Agent Device) or call. The CTI
client can add or remove monitors at any time after it opens the session without closing and re-opening
the session or affecting any other established monitors. When a Peripheral Monitor client has multiple
monitors that are relevant to an event message, the client receives a corresponding number of event
messages. The MonitorID in each event message indicates which monitor is associated with that
message. Peripheral Monitor service clients also receive the CALL_TRANSLATION_ROUTE event
described in
All Events service, however, the CTI client that has been granted Peripheral Monitor service must
specify for which devices and/or calls it wishes to receive events. The CTI client does this by
establishing a separate monitor for each device (Trunk, Trunk Group, or Agent Device) or call. The CTI
client can add or remove monitors at any time after it opens the session without closing and re-opening
the session or affecting any other established monitors. When a Peripheral Monitor client has multiple
monitors that are relevant to an event message, the client receives a corresponding number of event
messages. The MonitorID in each event message indicates which monitor is associated with that
message. Peripheral Monitor service clients also receive the CALL_TRANSLATION_ROUTE event
described in
.
Monitors are not preserved across CTI Server failures or client session failures. All monitors that a CTI
client creates are automatically terminated when the session is terminated. In addition, call monitors are
automatically terminated when the corresponding call ends. CTI clients must re-create monitors when
opening a new CTI session following a failure or loss of connection. No messages are received for any
events that may have occurred during the intervening time interval.
client creates are automatically terminated when the session is terminated. In addition, call monitors are
automatically terminated when the corresponding call ends. CTI clients must re-create monitors when
opening a new CTI session following a failure or loss of connection. No messages are received for any
events that may have occurred during the intervening time interval.
RouterCallKeyDay
Together with the RouterCallKey CallID field
forms the unique 64-bit key for locating this call’s
records in the Unified CCE.
forms the unique 64-bit key for locating this call’s
records in the Unified CCE.
UINT
4
RouterCallKeyCallID
The call key created by Unified CCE. Unified CCE
resets this counter at midnight.
resets this counter at midnight.
UINT
4
RouterCallKey
SequenceNumber
SequenceNumber
Together with RouterCallKeyDay and
RouterCallKeyCallID fields forms the TaskID.
RouterCallKeyCallID fields forms the TaskID.
UINT
4
CallVariable1 (optional)
Call-related variable data.
STRING
41
…
…
…
…
CallVariable10 (optional)
Call-related variable data.
STRING
41
NamedVariable (optional)
Call-related variable data that has a variable name
defined in the Unified CCE. There may be an
arbitrary number of Named Variable and
NamedArray fields in the message, subject to a
combined total limit of 2000 bytes. See
defined in the Unified CCE. There may be an
arbitrary number of Named Variable and
NamedArray fields in the message, subject to a
combined total limit of 2000 bytes. See
for the format of this field.
NAMED
VAR
VAR
251
NamedArray (optional)
Call-related variable data that has an array variable
name defined in the Unified CCE. There may be an
arbitrary number of Named Variable and
NamedArray fields in the message, subject to a
combined total limit of 2000 bytes. See
name defined in the Unified CCE. There may be an
arbitrary number of Named Variable and
NamedArray fields in the message, subject to a
combined total limit of 2000 bytes. See
for the format of this field.
NAMED
ARRAY
ARRAY
252
Maximum message size (including header):
3245
Table 5-28
CALL_TRANSLATION_ROUTE_EVENT Message Format (continued)