Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide
5-48
CTI Server Message Reference Guide (Protocol Version 9) Release 7.0(0)
Chapter 5 Application Level Interfaces
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.
lists the Peripheral Monitor service messages.
Table 5-27
Peripheral Monitor Service Messages
Message
When Sent to CTI Client
MONITOR_START_REQ
When a new monitor is created for a
call or device.
call or device.
MONITOR_STOP_REQ
When a call or device monitor is
terminated.
terminated.
CHANGE_MONITOR_MASK_
REQ
REQ
When a call and agent state event mask
is changed.
is changed.
MONITOR_START_REQ
Use this message to create a new monitor for the given call or device.
depicts the Monitor Start message flow. The MONITOR_START_REQ and
MONITOR_START_CONF messages are defined in
and