Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide

Page of 500
   
8-6
CTI OS Developer’s Guide for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 7.5(1)
Chapter 8      Session Object
Methods
Parameters
args
An arguments array containing the connection parameters listed in 
.
errorcode
An output parameter (return parameter in VB) that contains an error code from 
 in 
.
Return Values
Default CTI OS return values. See 
Remarks
A successful request will result in an OnConnection event.
A failure will result in an OnConnectionFailure event. This means that the CIL is in failover. The CIL 
will continue to attempt to connect, alternating between hosts CTIOS_CTIOSA and CTIOS_CTIOSB 
until connection succeeds at which point CIL will fire OnConnection. If application wishes to stop 
failover, it must call Disconnect. 
In some cases, additional failure codes and events may occur:
Connect will return a failure code of -1 if it cannot connect with the initial side of the duplexed 
CTIOS server pair chosen from the connect parameters. This error code requires no action on the 
part of the developer as the CIL will automatically attempt to connect using the parameters 
corresponding to the other side of the duplexed pair. 
The CIL will retry the connection attempt five times and then will not attempt to reconnect any 
longer. The final OnConnectionFailure event will contain the keyword "FinalAttempt" which 
informs the client application that the CIL has discontinued its attempts to reconnect. 
Table 8-3
Connect Parameters
Keyword
Type
Description
CtiosA
STRING
Name or TCP/IP address of CTI OS server A. If this value is not 
provided, the value of Ctios B is used.
Note
If values of neither Ctios A or Ctios B is provided, an 
error is returned.
CtiosB
STRING
Name or TCP/IP address of CTI OS server B. If this value is not 
provided, the value of Ctios A is used.
Note
If values of neither Ctios A or Ctios B is provided, an 
error is returned.
PortA (optional)
INT
TCP/IP port for ctiosA, default = 42028.
PortB (optional)
INT
TCP/IP port for ctiosB, default = 42028
Heartbeat (optional)
INT
Heartbeat time, expressed in seconds. If not set, default 
heartbeats are configurable on CTI OS server.