Cisco Cisco Computer Telephony Integration OS 8.5 Developer's Guide
8-6
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(3)
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
.
Return Values
Default CTI OS return values. See
Remarks
A successful request results in an OnConnection event.
A failure results 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 the application wishes to stop
failover, it must call Disconnect.
continue to attempt to connect, alternating between hosts CTIOS_CTIOSA and CTIOS_CTIOSB until
connection succeeds, at which point CIL will fire OnConnection. If the application wishes to stop
failover, it must call Disconnect.
In some cases, additional failure codes and events may occur:
•
Connect returns a failure code of -1 if it cannot connect with the initial side of the duplexed CTI OS
server pair chosen from the connect parameters. This error code requires no action on the part of the
developer as the CIL automatically attempts to connect using the parameters corresponding to the
other side of the duplexed pair.
server pair chosen from the connect parameters. This error code requires no action on the part of the
developer as the CIL automatically attempts to connect using the parameters corresponding to the
other side of the duplexed pair.
•
The CIL retries the connection attempt five times and then does not attempt to reconnect any longer.
The final OnConnectionFailure event contains the keyword "FinalAttempt" which informs the client
application that the CIL has discontinued its attempts to reconnect.
The final OnConnectionFailure event contains 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.
provided, the value of Ctios B is used.
Note
If values of neither Ctios A or Ctios B is provided, an
error is returned.
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.
provided, the value of Ctios A is used.
Note
If values of neither Ctios A or Ctios B is provided, an
error is returned.
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.
heartbeats are configurable on CTI OS server.