Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide
5-79
CTI Server Message Reference Guide (Protocol Version 9) Release 7.0(0)
Chapter 5 Application Level Interfaces
Miscellaneous Service
CLIENT_EVENT_REPORT_REQ
Send the CLIENT_EVENT_REPORT_REQ message, defined in
, to report significant events
through the ICM Alarm subsystem. The ICM Alarm subsystem allows simple textual event reports as
well as an object-oriented model that tracks the current state of named objects. The ICM Alarm
subsystem can also forward these events as SNMP traps.
well as an object-oriented model that tracks the current state of named objects. The ICM 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 ICM
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.
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 ICM 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 ICM 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 ICM 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 ICM Alarm objects would result; object “A:C” being
manipulated by client “A” and object “B:C” being independently manipulated by client “B”.
Table 5-64
CLIENT_EVENT_REPORT_REQ Message Format
Fixed Part
Field Name
Value
Data Type
Byte
Size
Size
MessageHeader
Standard message header.
MessageType = 32.
MessageType = 32.
MHDR
8
InvokeID
An ID for this request message,
returned in the corresponding confirm
message.
returned in the 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).
the 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 ICM 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.
event being reported.
STRING
255
Maximum message size (including header):
401
The CTI Server responds to the CTI client with the CLIENT_EVENT_REPORT_CONF message:
Table 5-65
CLIENT_EVENT_REPORT_CONF Message Format
Field Name
Value
Data Type
Byte
Size
Size
MessageHeader
Standard message header. Message
Type = 33.
Type = 33.
MHDR
8