Cisco Cisco Computer Telephony Integration OS 8.5 Developer's Guide

*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 

Default CTI OS return values. See 

If the Login request is successful, it returns a CIL_OK CtiOs_Enums.CilError code In addition, the 
requesting client can 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 receives an OnControlFailureConf event and the request 
returns 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.

PeripheralID (optional)

INT

The Unified ICM Peripheral ID of the ACD the agent 
is attached to.

SkillGroupNumber 
(optional)

INT

The user-defined number of an agent skill group 
associated with the agent.

SkillGroupPriority 
(optional)

INT

The priority of an agent skill group associated with 
the agent.

Agent CallMode

INT

A value that indicates the agent's call mode. Valid 
values are call-by-call (3) and nailed-up (4).

AgentRemote Number

STRING

The phone number that the agent uses for remote 
login.

RemoteLogin

INT

A value that indicates the agent is configured for 
remote login as a remote agent.