Cisco Cisco Computer Telephony Integration OS 8.5 Developer's Guide

Page of 490
   
9-18
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(3)
Chapter 9      Agent Object
Methods
Login
The Login method performs a login to the ACD (if supported). Generally, the minimum parameters 
required to log into an ACD are AgentID and AgentInstrument. Often, based on customer configuration, 
the minimum requirements include an ACD password (AgentPassword). Some switches require 
PositionID in place of (or in addition to) AgentInstrument. Optional arguments include Extension or 
AgentWorkMode.
To sign on a mobile agent, you must set the following parameters:
CTIOS_REMOTELOGIN set to true
CTIOS_AGENTREMOTENUMBER
CTIOS_AGENTCALLMODE
Example
rArgs.SetValue(Enum_CtiOs.CTIOS_REMOTELOGIN, "true");
rArgs.SetValue(Enum_CtiOs.CTIOS_AGENTREMOTENUMBER,"777989");
rArgs.SetValue(Enum_CtiOs.CTIOS_AGENTCALLMODE, 4);
Syntax
C++:
virtual int Login(Arguments & args);
COM:
HRESULT Login  ( /*[in]*/ IArguments * pVariantArgs, /*[out]*/ int * errorcode );
VB:
Login (args As CTIOSCLIENTLib.IArguments) As Long
Java:
int Login(Arguments args)
.NET:
CilError Login(Arguments args)
Input Parameters
args
Arguments array that contains the login parameters listed in 
.
Table 9-4
Login Parameters
Keyword
Type
Description
AgentID (required)
**
STRING
*
The agent’s login ID.
AgentInstrument
STRING
*
The agent’s instrument number.
LoginName (required)
**
STRING
The agent’s login name.
PositionID
STRING
*
Required for Alcatel only.
AgentExtension
STRING
*
The agent’s teleset extension. Optional if 
AgentInstrument is provided.
AgentPassword (optional)
STRING
*
The agent’s password.
AgentWorkMode 
(optional)
INT
A value representing the desired work mode of the 
agent. Used by Avaya Communications Manager 
(ACM) ECS with default value of ManualIn.
NumSkillGroups (optional) INT
The number of Skill Groups that the agent is currently 
associated with, up to a maximum of 20.