Cisco Cisco Computer Telephony Integration Option 9.0 Technical References
72
CTI Server Message Reference Guide (Protocol Version 17) for Cisco Unified Contact Center Enterprise
Release 10.0(1)
Miscellaneous Service
USER_MESSAGE_REQ
The USER_MESSAGE_REQ message, defined in
, 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.
connected to the CTI Server.
Table 5-68
USER_MESSAGE_REQ Message Format
Fixed Part
Field Name
Value
Data Type
Byte
Size
Size
MessageHeader
Standard message header. MessageType = 107.
MHDR
8
InvokeID
An ID for this request message, returned in the corresponding
confirm message.
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.
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
specifying the desired
distribution of this message.
USHORT
2
Floating Part
Field Name
Value
Data Type
Byte
Size
Size
ClientID
(optional)
(optional)
The clientid of the intended message recipient. Required if the
distribution field specifies DISTRIBUTE_TO_ CLIENT.
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.
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.
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.
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
ID
Unique ID for use by CTI OS to identify CIL Client
STRING
64
Maximum message size (including header):
439