Developer's Guide

5-67
CTI Server Message Reference Guide (Protocol Version 15) for Cisco Unified Contact Center Enterprise
Release 8.5(1)
Chapter 5 Application Level Interfaces
Miscellaneous Service
SYSTEM_EVENT
System event messages include the current PG Status as well as data related to the specific event that has
occurred. You can use the PG Status as a general indication of the operational health of the PG. Specific
PG Status codes are shown in Table 6-6. Normally you need not be aware of any specific codes; a
non-zero value indicates a component failure or data link outage that prevents normal CTI operations.
The SYSTEM_EVENT message is defined in Table 5-65:
REGISTER_VARIABLES_REQ To allow a CTI Client to register the call context
variables that it will use.
SET_APP_DATA_REQ Sent by CTI Client when it sets one of more
application variables.
START_RECORDING_REQ Sent by CTI Client on requesting the CTI Server to
start recording a call.
STOP_RECORDING_REQ Sent by CTI Client on requesting the CTI Server to
stop recording a call.
AGENT_DESK_SETTINGS_REQ To obtain current agent desk settings.
Table 5-64 Miscellaneous Service Messages (continued)
Table 5-65 SYSTEM_EVENT Message Format
Fixed Part
Field Name Value Data Type Byte Size
MessageHeader Standard message header. MessageType = 31. MHDR 8
PGStatus The current operational status of the Peripheral
Gateway. A non-zero value indicates a
component failure or communication outage
that prevents normal CTI operations (Table 6-6).
UINT 4
ICMCentral
ControllerTime
The current Central Controller date and time. TIME 4
SystemEventID A value that enumerates the specific system
event that occurred (Table 6-2).
UINT 4
SystemEventArg1 An argument value specific to the system event
being reported. Not used by all system events,
see Table 6-2 for details.
UINT 4
SystemEventArg2 A second argument value specific to the system
event being reported. Not used by all system
events, see Table 6-2 for details.
UINT 4
SystemEventArg3 A third argument value specific to the system
event being reported. Not used by all system
events, see Table 6-2 for details.
UINT 4
EventDeviceType Indicates the type of the device identifier
supplied in the EventDeviceID floating field
(Table 6-11). Should be DEVID_NONE if no
floating field is provided
USHORT 2
Floating Part