Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide

Page of 500
   
9-31
CTI OS Developer’s Guide for Cisco ICM/IPCC Enterprise & Hosted Editions
Cisco CTI OS Release 7.2(1)
Chapter 9      Agent Object
Methods
SendChatMessage
The SendChatMessage method sends asynchronous chat-like messages between CTI OS clients. Users 
can specify a distribution of one or more clients, and attach a text message. 
Syntax
C++:
int SendChatMessage (Arguments& args)
COM:
HRESULT SendChatMessage (/*[in]*/ IArguments *args, /*[out,retval]*/ int * 
errorcode)
VB:
SendChatMessage (args As CTIOSCLIENTLib.IArguments) As Long)
Java:
int SendChatMessage(Arguments args)
.NET:
CilError SendChatMessage(Arguments args)
Parameters
args
Input parameter in the form of an Arguments array that contains one or more of the 
SendChatMessage parameters listed in the following table.
Table 9-13
SendChatMessage Parameters
Keyword
Type
Description
Distribution (required)
STRING Currently the only supported value is 
“agent”.
Target (optional)
STRING When the Distribution is set to 
DistributeToAgent, this field must be 
included with the AgentID of the intended 
recipient. When the LoginName is set to the 
LoginName of the agent to receive the chat 
message, this field must also be set to the 
login name of the agent to which to chat.
Message (optional)
STRING The text of the user message. Maximum 
message size is 255 bytes. 
LoginName (optional)
STRING Login name of the agent to receive the chat 
message. To chat to an agent by login name, 
set “LoginName” and “Target” to the login 
name of the agent to which to chat.
errorcode
An output parameter (return parameter in VB) that contains an error code from 
 in 
Return Values
Default CTI OS return values. See