Cisco Cisco Computer Telephony Integration OS 8.5 Reference Guide
5-81
CTI Server Message Reference Guide (Protocol Version 14) for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 8.0(1)
Chapter 5 Application Level Interfaces
Miscellaneous Service
The CTI Server responds to the CTI Client with the USER_MESSAGE_CONF message:
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.
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.
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
ID
Unique ID for use by CTI OS to
identify CIL Client
identify CIL Client
STRING
64
Maximum message size (including header):
439
Table 5-68
Message Distribution Values
Distribution Code
Description
Value
DISTRIBUTE_TO_
CLIENT
CLIENT
The message is to be sent to the client
indicated by the ClientID field.
indicated by the ClientID field.
0
DISTRIBUTE_TO_
SUPERVISOR
SUPERVISOR
The message is to be sent to the agent team
supervisor.
supervisor.
1
DISTRIBUTE_TO_
TEAM
TEAM
The message is to be sent to all clients in the
same agent team.
same agent team.
2
DISTRIBUTE_TO_
ALL
ALL
The message is to be sent to all CTI Server
clients.
clients.
3
Table 5-69
USER_MESSAGE_CONF Message Format
Field Name
Value
Data Type
Byte
Size
Size
MessageHeader
Standard message header. Message
Type = 108.
Type = 108.
MHDR
8
InvokeID
Set to the value of the InvokeID from
the corresponding request message.
the corresponding request message.
UINT
4
Maximum message size (including header):
12
Table 5-67
USER_MESSAGE_REQ Message Format (continued)