Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide

Page of 640
Chapter 9      Agent Object
Methods
9-28
CTI OS Developer’s Guide for Cisco ICM/IPCC Enterprise & Hosted Editions Release 7.0(0)
*The CTI OS server imposes no restriction on the maximum length of this string. 
However, such restrictions are generally imposed by your switch/ACD and Cisco 
CTI Server. Consult the documentation for the switch/ACD or CTI Server for 
information on length restrictions for this string.
** Either AgentID or LoginName is required.
errorcode
An output parameter (return parameter in VB) that contains an error code 
from 
 in 
Return Values
Default CTI OS return values. See 
Remarks
If the Login request is successful, it returns a CIL_OK CtiOs_Enums.CilError 
code In addition, the requesting client should expect an AgentStateChange event 
if the request is successful with an Arguments member with keyword 
“AgentState” and value of the agent’s current state. (See GetAgentState for 
possible values.)
If the Login request is unsuccessful, the client will receive an 
OnControlFailureConf event and the request will return one of the following 
CtiOs_Enums.CilError codes:
  •
E_CTIOS_INVALID_SESSION -- either the agent is not associated with the 
session or the session is not connected.
  •
E_CTIOS_INVALID_ARGUMENT -- null or invalid arguments were 
provided.
  •
E_CTIOS_LOGIN_INCONSISTENT_ARGUMENTS -- Login request 
argument values for AgentId and/or PeripheralID do not match the values that 
were set by SetAgent() prior to the Login request.