Developer's Guide

5-70
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
USER_MESSAGE_REQ
The USER_MESSAGE_REQ message, defined in Table 5-68, allows a CTI Client to send a message to
a specified client, the client agent’s supervisor, all clients in the client agent’s team, or all clients
connected to the CTI Server.
Table 5-68 USER_MESSAGE_REQ Message Format
Fixed Part
Field Name Value Data Type
Byte
Size
MessageHeader Standard message header. MessageType = 107. MHDR 8
InvokeID An ID for this request message, returned in the corresponding
confirm message.
UINT 4
PeripheralID The PeripheralID of the ACD where the agent indicated by
Agent Extension, AgentID, or Agent Instrument is located. For
clients with All Events or Peripheral Monitor service, this
value must be provided if the Distribution field specifies
DISTRIBUTE_TO_ SUPERVISOR or DISTRIBUTE_
TO_TEAM.
UINT 4
Distribution One of the values from Table 5-69 specifying the desired
distribution of this message.
USHORT 2
Floating Part
Field Name Value Data Type
Byte
Size
ClientID
(optional)
The clientid of the intended message recipient. Required if the
distribution field specifies DISTRIBUTE_TO_ CLIENT.
STRING 64
AgentExtension The agent’s ACD teleset extension. For clients with ALL
EVENTS or PERIPHERAL MONITOR service, at least one of
Agent Extension, AgentID, or Agent Instrument must be
provided if the Distribution field specifies DISTRIBUTE_TO_
SUPERVISOR or DISTRIBUTE_ TO_TEAM.
STRING 16
AgentID The agent’s ACD login ID. For clients with ALL EVENTS or
PERIPHERAL MONITOR service, at least one of
AgentExtension, AgentID, or AgentInstrument must be
provided if the Distribution field specifies DISTRIBUTE_TO_
SUPERVISOR or DISTRIBUTE_ TO_TEAM.
STRING 12
AgentInstrument The agent’s ACD instrument number. For clients with ALL
EVENTS or PERIPHERAL MONITOR service, at least one of
AgentExtension, AgentID, or AgentInstrument must be
provided if the Distribution field specifies DISTRIBUTE_TO_
SUPERVISOR or DISTRIBUTE_ TO_TEAM.
STRING 64
Text The text of the message to be sent. STRING 255
CTIOSCILClient
ID
Unique ID for use by CTI OS to identify CIL Client
STRING 64
Maximum message size (including header): 439