Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide
6-4
CTI OS Developer’s Guide for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 8.0(1)
Chapter 6 Event Interfaces and Events
ISessionEvents Interface
Note
CTI OS CIL will send the disconnect request to CTI OS Server when the login attempt fails. Hence CTI
OS Server closes the client connection.
OS Server closes the client connection.
Syntax
C++:
void OnCTIOSFailure (Arguments& args)
COM:
void OnCTIOSFailure (IArguments * args)
VB:
Session_OnCTIOSFailure (ByVal args As CtiosCLIENTLib.IArguments)
Parameters
args
Arguments array containing the following fields.
Table 6-3
OnCTIOSFailure Event Parameters
Following are the enumerated values for Failure Code:
Keyword
Type
Description
FailureCode
INT
A value according to an enumerated value, as shown immediately
following this table.
following this table.
SystemEventID
INT
Present only if FailureCode equals ServerConnectionStatus.
Contains a value according to an enumerated value, as shown
immediately following this table.
Contains a value according to an enumerated value, as shown
immediately following this table.
SystemEventArg1
INT
Present only if SystemEventID equals SysPeripheralOnline or
SysPeripheralOffline. Contains the peripheral ID of the affected
peripheral.
SysPeripheralOffline. Contains the peripheral ID of the affected
peripheral.
ErrorMessage
STRING
An error message.
enum enumCTIOS_FailureCode
{
eDriverOutOfService
=
1,
eServiceNotSupported
=
eDriverOutOfService + 1,
eOperationNotSupported
=
eServiceNotSupported + 1,
eInvalidPriviledge
=
eOperationNotSupported + 1,
eUnknownRequestID
=
eInvalidPriviledge + 1,
eUnknownEventID
=
eUnknownRequestID + 1,
eUnknownObjectID
=
eUnknownEventID + 1,
eRequiredArgMissing
=
eUnknownObjectID + 1,
eInvalidObjectState
=
eRequiredArgMissing
eServerConnectionStatus
=
eInvalidObjectState + 1,
eInconsistentAgentData
=
eServerConnectionStatus + 1,
eAgentAlreadyLoggedIn
=
eInconsistentAgentData + 1,
eForcedNotReadyForConfigError
=
eAgentAlreadyLoggedIn + 1
eMonitorModeConnectionDenied
=
eForcedNotReadyForConfigError + 1
};