Cisco Cisco Computer Telephony Integration OS 8.5 Technical References
70
CTI Server Message Reference Guide (Protocol Version 17) for Cisco Unified Contact Center Enterprise
Release 10.0(1)
Miscellaneous Service
CLIENT_EVENT_REPORT_REQ
Send the CLIENT_EVENT_REPORT_REQ message, defined in
, to report significant events
through the Unified CCE Alarm subsystem. The Unified CCE Alarm subsystem allows simple textual
event reports as well as an object-oriented model that tracks the current state of named objects. The
Unified CCE Alarm subsystem can also forward these events as SNMP traps.
event reports as well as an object-oriented model that tracks the current state of named objects. The
Unified CCE Alarm subsystem can also forward these events as SNMP traps.
A CTI client that elects to report events with named objects should initialize the objects in the Unified
CCE Alarm subsystem soon after establishing its session with the CTI Server by reporting the current
state of each named object. The object name given uniquely identifies the alarm object. Therefore, CTI
client applications that wish to create multiple instances of an alarm object must include some
instance-identifying characters (such as ClientID or ACD extension) in the object name.
CCE Alarm subsystem soon after establishing its session with the CTI Server by reporting the current
state of each named object. The object name given uniquely identifies the alarm object. Therefore, CTI
client applications that wish to create multiple instances of an alarm object must include some
instance-identifying characters (such as ClientID or ACD extension) in the object name.
For example, if a CTI client “A” and a CTI client “B” both report events on an object named “C”, there
will be one Unified CCE Alarm object “C” that is manipulated by both clients. If, on the other hand, the
Client ID were included in the object name, then two Unified CCE Alarm objects would result; object
“A:C” being manipulated by client “A” and object “B:C” being independently manipulated by client “B”.
will be one Unified CCE Alarm object “C” that is manipulated by both clients. If, on the other hand, the
Client ID were included in the object name, then two Unified CCE Alarm objects would result; object
“A:C” being manipulated by client “A” and object “B:C” being independently manipulated by client “B”.
Field Name
Value
Data Type
Max. Size
Text (optional)
A text message associated with the provided
SystemEperiphventID.
SystemEperiphventID.
STRING
255
EventDeviceID
A text value of the device ID if reported.
Initially only used by Unified CCX for an
SYS_DEVICE_IN_SERVICE, and
SYS_DEVICE_OUT_OF_ SERVICE message.
Initially only used by Unified CCX for an
SYS_DEVICE_IN_SERVICE, and
SYS_DEVICE_OUT_OF_ SERVICE message.
STRING
64
Maximum message size (including header):
289
Table 5-65
SYSTEM_EVENT Message Format (continued)
Table 5-66
CLIENT_EVENT_REPORT_REQ Message Format
Fixed Part
Field Name
Value
Data Type
Byte Size
MessageHeader
Standard message header. MessageType = 32.
MHDR
8
InvokeID
An ID for this request message, returned in the
corresponding confirm message.
corresponding confirm message.
UINT
4
State
One of the following values indicating the
seriousness of the event and the state of the named
object, if present. 0: normal (green), 1: warning
(yellow), 2: error (red).
seriousness of the event and the state of the named
object, if present. 0: normal (green), 1: warning
(yellow), 2: error (red).
USHORT
2
Floating Part
Field Name
Value
Data Type
Max.
Size
Size
ObjectName
(optional)
(optional)
The name of the Unified CCE Alarm object
affected by this event. The object is created if it
does not already exist.
affected by this event. The object is created if it
does not already exist.
STRING
128
Text
A text message associated with the event being
reported.
reported.
STRING
255
Maximum message size (including header):
401