Cisco Unified Communications Manager JTAPI Developers Guide
Overview
Downloads: This chapterpdf (PDF - 1.24MB) The complete bookPDF (PDF - 13.21MB) | Feedback

Overview

Table Of Contents

Overview

Cisco Unified JTAPI

CiscoObjectContainer

JtapiPeer and Provider

Initialization

Shutdown

Provider.getTerminals()

Provider.getAddresses()

Changes to the User Control List in the Directory

Addresses and Terminals

Address and Terminal Relationship

Unobserved Addresses and Terminals

Connection

TerminalConnection

CiscoConnectionID

CiscoCallID

Threaded CallBacks

CiscoSynchronousObserver Interface

Querying Dynamic Objects

callChangeEvent()

CiscoConsultCall

CiscoTransferStartEv

Alarm Services

Application Control of JTAPI Parameters

Jtapi.ini Parameters

Dynamic Trace Enabling Using Jtprefs

Supported Device Types

Call Forward Setting

Call Park

Park Retrieval

Park Reminder

Park DN Monitor

CiscoJtapiExceptions

Cisco Unified JTAPI Install Internationalization

Clear Calls Interface

Device Recovery

Device Recovery for phones

CTI RoutePoints

CTI Ports

Directory Change Notification

Enable or Disable Ringer

Transfer and Conference Extensions

Transfer

CiscoTransferStartEv

CiscoTransferEndEv

Transfer Scenarios

Conference

Cisco Extensions

Conference Scenarios

Conference Events

Transfer and Conference Enhancement

Consult Without Media

Media Termination Extensions

Cisco Unified Communications Manager Media Endpoint Model

Payload and Parameter Negotiation

Initialization

Payload Selection

Receive Channel Allocation

Starting Transmission and Reception

Stopping Transmission and Reception

CiscoMediaTerminal

Provisioning

Registration

Adding Observers

Accepting Calls

Receiving and Responding to Media Flow Events

Inbound Call Media Flow Event Diagram

Cisco Unified Communications Solutions RTP Implementation

Redirect

Routing

Cisco Route Session Implementation

Select Route Timer

Forwarding Timer

RouteSession Extension

Caller Options Summary

Fault Tolerance When Using Route Points

Redundancy

Cluster Abstraction

Cisco Unified Communications Manager Server Failure

Redundancy in CTIManagers

Invoking CTIManager Redundancy

CTIManager Failure

Heartbeats

Display Name Interface

SetMessageWaiting Interface

QuietClear

GetCallInfo Interface on Address

DeleteCall Interface

GetGlobalCallID

GetCallID in RTP Events

XSI Object Pass Through

CiscoTerminal Method

Authentication and Mechanism

Cisco VG248 and ATA 186 Analog Phone Gateways

Multiple Calls Per DN

Shared Line Support

Transfer and DirectTransfer

Conference and Join

Barge and Privacy Event Notification

CallSelect and UnSelect Event Notification

Dynamic CTIPort Registration

Media Termination at Route Point

Redirect Set Original Called ID

Single Step Transfer

Auto Update of API

Changes in DeviceType Name Handling

CiscoTerminal Filter and ButtonPressedEvents

Modifying Calling Number

AutoAccept Support for CTIPort and RoutePoint

CiscoTermRegistrationFailed Event

SelectRoute Interface Enhancement

Presentation Indicator (PI) for the Call

Progress State Converted to Disconnect State

Device State Server

Forced Authorization and Client Matter Codes

Forced Authorization Code (FAC)

Client Matter Code (CMC)

Supported Interfaces

Call.Connect() and Call.Consult()

Call.transfer(String) and Connection.redirect()

RouteSession.selectRoute()

Super Provider (Disable Device Validation)

Q.Signaling (QSIG) Path Replacement

Network Events

Network Alerting Change for Release 5.0

Partition Support

Hairpin Support

QoS Support

Transport Layer Security (TLS)

SIP Phone Support

Secure Real-Time Protocol Key Material

SIP REFER/REPLACE

SIP 3XX Redirection

Terminal and Address Restrictions

Unicode Support

Linux and Solaris Installation

JRE 1.2 and JRE 1.3 Support Removal

Superprovider and Change Notification

Interface Changes

Alternate Script Support

Half-Duplex Media Support

Recording and Silent Monitoring

Intercom

Arabic and Hebrew Language Support

Do Not Disturb

Secure Conferencing

SIP Phone Support

Cisco Unified IP 7931G Phone Interaction

Version Format Change

Querying the Calling Party IP Address

Multilevel Precedence and Preemption (MLPP) Support

Non-Controller Adding of Parties to Conferences

Conference Chaining

Forwarding on No Bandwidth & Unregistered DN

Directed Call Park

Voice MailBox Support

Privacy On Hold

CiscoRTPHandle Interface on Cisco RTP Events

Hold Reversion

Translation Pattern Support


Overview


This chapter introduces the major concepts with which you need to be familiar before creating JTAPI applications for Cisco Unified Communications Solutions.


Note For information about backward compatibility, see Chapter 2, "Backward Compatibility."


The chapter covers the following concepts:

Cisco Unified JTAPI

CiscoObjectContainer

JtapiPeer and Provider

Addresses and Terminals

Threaded CallBacks

Alarm Services

Application Control of JTAPI Parameters

Supported Device Types

Call Forward Setting

Call Park

CiscoJtapiExceptions

Device Recovery

Directory Change Notification

Transfer and Conference Extensions

Media Termination Extensions

Redirect

Routing

Redundancy

Display Name Interface

SetMessageWaiting Interface

QuietClear

GetCallInfo Interface on Address

DeleteCall Interface

GetGlobalCallID

GetCallID in RTP Events

XSI Object Pass Through

Cisco VG248 and ATA 186 Analog Phone Gateways

Multiple Calls Per DN

Shared Line Support

Transfer and DirectTransfer

Conference and Join

Barge and Privacy Event Notification

CallSelect and UnSelect Event Notification

Dynamic CTIPort Registration

Media Termination at Route Point

Redirect Set Original Called ID

Single Step Transfer

Auto Update of API (modified in Release 5.0)

CiscoTerminal Filter and ButtonPressedEvents

Modifying Calling Number

AutoAccept Support for CTIPort and RoutePoint

CiscoTermRegistrationFailed Event

SelectRoute Interface Enhancement

Presentation Indicator (PI) for the Call

Device State Server

Forced Authorization and Client Matter Codes

Super Provider (Disable Device Validation)

Q.Signaling (QSIG) Path Replacement

Network Events (modified in Release 5.0)

Release 5.0 included the following new sections:

Partition Support

Hairpin Support

QoS Support

Transport Layer Security (TLS)

SIP Phone Support

Secure Real-Time Protocol Key Material

SIP REFER/REPLACE

SIP 3XX Redirection

Terminal and Address Restrictions

Linux and Solaris Installation

JRE 1.2 and JRE 1.3 Support Removal

Superprovider and Change Notification

Alternate Script Support

Half-Duplex Media Support

Release 6.0 includes the following new sections.

Recording and Silent Monitoring

Intercom

Arabic and Hebrew Language Support

Do Not Disturb

Secure Conferencing

SIP Phone Support

Cisco Unified IP 7931G Phone Interaction

Version Format Change

Querying the Calling Party IP Address

Multilevel Precedence and Preemption (MLPP) Support

Non-Controller Adding of Parties to Conferences

Conference Chaining

Forwarding on No Bandwidth & Unregistered DN

Directed Call Park

Voice MailBox Support

Privacy On Hold

CiscoRTPHandle Interface on Cisco RTP Events

Hold Reversion

Translation Pattern Support

Cisco Unified JTAPI

An abstract telephony model, Java Telephony application Programming Interface (JTAPI), can uniformly represent the characteristics of a wide variety of telecommunication systems. Because JTAPI is defined without direct reference to any particular telephony hardware or software, JTAPI offers a well suited method for the task of controlling or observing nearly any telephone system. For instance, a computer program that makes telephone calls by using an implementation of JTAPI for modems might work without modification by using the Cisco Unified JTAPI implementation.

As powerful as an abstraction may be in theory, in practice, programmers often need to know the details of how the JTAPI model represents the underlying components of a particular telephony system. A modem represents a very simple telephony device with limited features. In contrast, the Cisco Unified Communications Solutions product family offers its users a comprehensive list of features and configuration capabilities. Programmers can best leverage the rich features of Cisco Unified Communications Solutions systems by understanding how it fits into the Cisco Unified JTAPI model.

The following sections outline the deviations, if any, from the JTAPI v 1.2 specification or the specifics of the Cisco Unified JTAPI implementation. Cisco Unified JTAPI also provides extensions to the JTAPI v 1.2 specification. These extensions offer additional functionality to the Cisco implementation that is not defined in the specification. The com.cisco.jtapi.extensions package includes the classes and interfaces for the extensions, and Chapter 4, "Cisco Unified JTAPI Implementation," explains them in detail.

CiscoObjectContainer

The CiscoObjectContainer interface allows applications to associate an application defined object to objects that implement this interface. In Cisco Unified JTAPI, the following interfaces extend the CiscoObjectContainer interface:

CiscoJTAPIPeer

CiscoProvider

CiscoCall

CiscoAddress

CiscoTerminal

CiscoConnection

CiscoTerminalConnection

CiscoConnectionID

CiscoCallID

JtapiPeer and Provider

The Provider object, which is created through the implementation of the JtapiPeer object, acts as the main point of contact between applications and JTAPI implementations. The Provider object contains the entire collection of call model objects, Addresses, Terminals, and Calls, which are controllable at any time by an application.

The JTAPI Preferences (JTPREFS) application administers JtapiPeer.getServices(), which returns server names.

The Provider entails two basic processes: initialization and shutdown.

Ensure that the following information is passed in the JtapiPeer.getProvider() method for applications to obtain a CiscoProvider:

Hostname or IP address for the Cisco Unified Communications Manager server

Login of the user who is administered in the directory

Password of the user that is specified

(Optional) Application information (This parameter may be a string of any length.)

Applications must include enough descriptive information, so if the appinfo were logged in an alarm, administrators would know which application caused the alarm. Applications should not include hostname or IP address where they reside, nor the time at which they were spawned. Also, ensure that no "=" or ";" characters are included in the appinfo string because they delimit the getProvider () string. When the appinfo is not specified, you can use a generic and quasi-unique name (JTAPI[XXXX]@hostname, where XXXX represents a random, four-digit number) instead.

The parameters get passed in key value pairs that are concatenated in a string as follows:

JtapiPeer.getProvider("CTIManagerHostname;login=user;passwd=userpassword;appinfo=Cisco Softphone")

Initialization

The JtapiPeer.getProvider() method returns a Provider object as soon as the TCP link, the initial handshake with the Cisco Unified Communications Manager, and device list enumeration are complete. The provider now exists in the OUT_OF_SERVICE state. Cisco Unified JTAPI applications must wait for the provider to go to the IN_SERVICE state before the controlled device list is valid. A ProvInServiceEv event gets delivered to an object that is implementing the ProviderObserver interface.


Note Implementing only the CiscoProviderObserver does not do enough; the observer must also get added to the provider with provider.addObserver(..). Applications must wait for a notification that the Provider is in service.


As a part of the QoS baselining effort in JTAPI, ProviderOpenCompletedEv provides the "DSCP value for Applications" to JTAPI. JTAPI sets this DSCP value for its connection with CTI, and all JTAPI messages to CTI will have this DSCP value as long as the Provider object exists.

Shutdown

When an application calls provider.shutdown(), JTAPI loses communications permanently with the Cisco Unified Communications Manager, and a ProvShutdownEv event gets delivered to the application. The application can assume that the Provider will not come up again, and the application must handle a complete shutdown.

Provider.getTerminals()

This method returns an array of terminals that are created for the devices that are administered in the user control list in the directory. Refer to the Cisco Unified Communications Manager Administration Guide to administer the user control list.

Provider.getAddresses()

This method returns an array of addresses that are created from the lines that are assigned to the devices that are administered in the user control list in the directory.

Changes to the User Control List in the Directory

If a device is added to the user control list after the JTAPI application starts, a CiscoTermCreatedEv, and the respective CiscoAddrCreatedEv, gets generated and sent to observers that are implementing the CiscoProviderObserver. In addition, applications can monitor the current registration state of the controlled devices and dynamically track the availability of these devices. The events for an in-service Address or Terminal get delivered to observers that are implementing the CiscoAddressObserver and the CiscoTerminalObserver.


Note Implementing only the observers does not do enough; the observers must also get added by address.addObserver(..) and, similarly, for the terminal by the terminal.addObserver(..) method.



Note Before invoking the call.connect() method, add a CallObserver to the address or terminal that is originating the call; otherwise, the method returns an exception.


Addresses and Terminals

The Cisco Unified Communications Solutions architecture includes three fundamental types of endpoints:

Telephone sets

Virtual devices (media termination points and route points)

Gateways

Of these endpoints, only telephones and media termination points get exposed through the Cisco Unified JTAPI implementation.

Cisco Unified Communications Manager allows users to configure telephones to have one or more lines, dialable numbers, which multiple telephones may share simultaneously, or lines can be configured for exclusive use by only one telephone at a time. Each line on a telephone can terminate two calls simultaneously, one of which must be on hold.

This operation acts in a similar way to the operation of the "call waiting" feature on home telephones. Figure 1-1 "Telephone Diagram" shows two configurations: Peter and Mary share one telephone line, 5001, while Paul has his own telephone line, 5002.

Figure 1-1 Telephone Diagram

Address and Terminal Relationship

A unique name identifies all types of Cisco Unified Communications Manager endpoints. Telephone terminal hardware Media Access Control (MAC) address (such as, "SEP0010EB1014") identifies it, whereas the system administrator may assign any name to a media termination point, so long as its name is distinct. For each endpoint that a provider controls, the Cisco Unified JTAPI implementation uses its administered name to construct a corresponding terminal object. Terminal objects in turn have one or more address objects, each of which corresponds to a line on the endpoint. Figure 1-2 "Address and Terminal Relationship" shows a graphical representation of the relationship between addresses and terminals.

Figure 1-2 Address and Terminal Relationship

If two or more endpoints share a line (directory number), the corresponding address object will be related to more than one terminal object.

Unobserved Addresses and Terminals

Cisco Unified JTAPI learns about calls only when a CallObserver attaches to the terminals/addresses of the provider. This means that methods such as Provider.getCalls() or Address.getConnections() will return null, even when calls exist at the address, unless a CallObserver attaches to the address. The system also requires adding a CallObserver to the address or terminal that is originating a call via the Call.connect(..) method.

Connection

Connections retain their references to calls and addresses forever. So, a connection reference that is obtained from a call event can always be used to obtain the connection call (getCall()) and address (getAddress()).

TerminalConnection

TerminalConnections always retain their references to terminals and connections. So, a terminal connection reference that is obtained from a call event can always be used to obtain the terminal connection terminal (getTerminal()) and connection (getConnection()).

CiscoConnectionID

The CiscoConnectionID object represents a unique object that is associated with each connection in Cisco Unified JTAPI. Applications may use the object itself or the integer representation of the object.

CiscoCallID

The Cisco CallID object represents a unique object that is associated with each connection in Cisco Unified JTAPI. Applications may use the object itself or the integer representation of the object.

Threaded CallBacks

The Cisco Unified JTAPI implementation design allows applications to invoke blocking JTAPI methods such as Call.connect() and TerminalConnection.answer() from within their observer callbacks. This means that applications do not get subjected to the restrictions that are imposed by the JTAPI 1.2 specification, which cautions applications against using JTAPI methods from within observer callbacks.

CiscoSynchronousObserver Interface

The Cisco Unified JTAPI implementation allows applications to invoke blocking JTAPI methods, such as Call.connect() and TerminalConnection.answer(), from within observer callbacks. This means that applications are not subject to the restrictions that are imposed by the JTAPI 1.2 specification, which cautions against using JTAPI methods from within observer callbacks. Applications can selectively disable the queuing logic of the Cisco Unified JTAPI implementation by implementing the CiscoSynchronousObserver interface on their observer objects.

This asynchronous behavior does not adversely affect many applications. Applications that would benefit from a coherent call model during observer callbacks can selectively disable the queuing logic of the Cisco Unified JTAPI implementation. By implementing the CiscoSynchronousObserver interface on its observer objects, an application declares deliver synchronous events to its observers. Events that are delivered to synchronous observers will match the states of the call model objects that are queried from within the observer callback.


Note Objects that implement the CiscoSynchronousObserver interface must not invoke blocking JTAPI methods from within their event callbacks. The unpredictable consequences of doing so may include deadlocking the JTAPI implementation. However, objects may safely use the accessor methods of any JTAPI object, for instance Call.getConnections() or Connection.getState().


Querying Dynamic Objects

Beware of querying dynamic objects such as call objects. By the time you get an event, the object (such as, call) may be in a different state than the state that is indicated. For example, by the time you get a CiscoTransferStartEV, the transferred call may have removed all its internal connections.

callChangeEvent()

When the callChangedEvent() method is called, the validity remains guaranteed for any references that are contained in the event. For example, if the event contains a getConnection() method, the application can call this method and get a valid connection reference. Likewise, a getCallingAddress() method guarantees to return a valid Address object.

CiscoConsultCall

For the CiscoConsultCall interface, a reference to a consulting terminal connection gets retained forever. For example, when a CiscoConsultCallActive event is processed, getConsultingTerminalConnection() guarantees to return a valid terminal connection reference. Further, the terminal connection guarantees to provide access to the consulting connection and thus the consulting call.

CiscoTransferStartEv

For the CiscoTransferStartEv, the references to the transferred call, transfer controller, and final call in the event become valid when callChangedEvent() is called. However, getConnections() may or may not return the connections on these calls.

Alarm Services

Part of the general serviceability framework for Cisco Unified Communications applications includes support for sending alarms to a service. The com.cisco.services.alarm package defines the alarm components.

An alarm interface and framework support the sending of alarm notifications in XML over TCP to an Alarm Service that is available on the network in a Cisco Unified JTAPI application. The alarm package includes the following features:

XML definition of alarms, resolved by a catalog in the alarm service

A bounded rollover queue to buffer alarms at the sender

Alarm sending on a separate thread to avoid blocking at the sending application

A TCP-based reconnection scheme to the alarm service

The overall framework of the Cisco Unified JTAPI alarm system is similar to the existing JTAPI tracing package. Applications must instantiate an AlarmManager for a particular facility code from which alarm objects can be created. Part of the implementation includes DefaultAlarm and DefaultAlarmWriter implementation classes.

Application Control of JTAPI Parameters

The jtapi.ini file includes the various parameters that are required for configuring Cisco Unified JTAPI. Cisco Unified JTAPI looks for the presence of this file in the current Java classpath.

Cisco Unified JTAPI also supports application setting of all the parameters that it requires. This system allows a single point of application administration, independent of jtapi.ini. The jtapi.ini file provides a starting point for default values, but client applications can modify different values without having to specifically modify the jtapi.ini file.

Applications obtain a CiscoJtapiProperties object from the CiscoJtapiPeer and make changes to the parameters by using the accessor and mutator methods. You must set these properties, which apply peerwide to all the providers that are derived from a CiscoJtapiPeer, prior to the first getProvider () call on that peer.

Different instances of client applications, however, can impose different settings for these parameters. The com.cisco.jtapi.extensions package defines the CiscoJtapiProperties interface.

Jtapi.ini Parameters

Cisco Unified JTAPI gets configured by using parameters in the jtapi.ini. These parameters get modified by using the Jtprefs application, which the Cisco Unified JTAPI installer installs. See Fields in the jtapi.ini File, page 3-18.

Dynamic Trace Enabling Using Jtprefs

You will generally want to turn off high-level debugging traces. Typically, tracing at full debug levels imposes a load on the system that is not desirable during normal system operation. For troubleshooting purposes, an administrator can turn tracing on or off dynamically.

Cisco Unified JTAPI supports the dynamic enabling of traces from the Jtprefs administrative application. The application communicates with JTAPI by using a TCP socket and sends a signal to enable or disable the traces. For more details on dynamic tracing, refer to the Cisco Unified Communications Manager Administration Guide. Ensure that the trace file generation is turned on before using dynamic tracing. If no trace files are being generated, dynamic tracing does not enable file generation. Dynamic tracing only enables or disables traces on an existing log file stream. By default, JTAPI enables file writing with all tracing levels off.

Supported Device Types

Cisco Unified JTAPI supports the following device types:

30 SP+ (This device has spurious off hook problems—not recommended.)

12 SP+ (This device has spurious off hook problems—not recommended.)

12 SP (This device has spurious off hook problems—not recommended.)

7902

7905

7906

7910

7911

7912

7920

7931 (supported in no-rollover mode only)

7935

7936

7940

7941

7942-G

7942-G/GE

7960

7961

7962-G

7962-G/GE

7970

7971

7972-G/GE

CTI Route Points

CTI Ports

VG248 Analog Devices

ATA 186 Analog Devices

Call Forward Setting

Cisco Unified JTAPI supports setting the Call Forward feature according to the JTAPI Specification. Cisco Unified JTAPI implementation does not support all the forwarding characteristics but supports only the FORWARD_ALL attribute for the Address. Applications can invoke setForwarding, getForwarding, and cancelForwarding methods on a CallControlAddress object, but the CallControlForwarding instruction can only be of type FORWARD_ALL.

Call Park

Cisco Unified JTAPI supports user interactions with Call Park and reports the appropriate events to the applications. When a call is parked from an IP phone, the connection that belongs to the parking address moves into Disconnected state, and the associated TerminalConnection moves into Dropped state. A new connection in queued state for the park number gets created.

If an application is monitoring only the address that parked the call, all existing connections get Disconnected, TerminalConnections get Dropped, and the call moves to Invalid state.

Park Retrieval

When a call is parked from an IP phone, the park number displays on the phone. Any terminal can unpark the call by dialing the park number. When a call is unparked, a new call gets created with connections to unparked address. The CallControlConnection for the park number in the original call, which is in the Queued state, moves to the Disconnected state.

Park Reminder

When a parked call is not retrieved for a specified time, a reminder call returns to the address that parked the call, and Park Number connection moves to the Disconnected state. The call reconnects and moves to the Established state. A terminal connection in Talking state gets created for the address that parked the call.

Park DN Monitor

Cisco Unified JTAPI applications can register to receive events when calls are parked and unparked. CiscoProvCallParkEv events will be delivered to provider observer when the application registers for this feature. To successfully register for this feature, ensure that the "call park retrieval allowed" flag for the user is turned on. You can access this flag with the user configuration on Cisco Unified Communications Manager Administration. After registering for this feature, the application will receive CiscoProvCallParkEv events whenever a call is parked or unparked from any device in the cluster.

The following new interfaces allow applications to register and unregister for this feature:

public interface CiscoProvider {
public void registerFeature ( int featureID ) throws  
	InvalidStateException, PrivilegeViolationException;
public void unregisterFeature ( int featureID ) throws  
	InvalidStateException;
}

where featureID is CiscoProvFeatureID.MONITOR_CALLPARK_DN.

CiscoJtapiExceptions

Cisco Unified JTAPI notifies the application of CTI-generated error codes. These codes return when an exception or error occurs in the CTIManager. The CTI returned error code propagates to the application separately. The application can extract the error code by invoking getErrorCode() method on the exception object, can get CTI error code name by invoking getErrorName() method, and can get error description by invoking method getErrorDescription().

The methods getErrorName(int errorCode) and getErrorDescription (int errorCode) deprecate and get removed in future releases. Cisco recommends that application users do not use these methods.

Cisco Unified JTAPI Install Internationalization

Cisco Unified JTAPI supports multiple languages for the JTAPI installation and user preference UI. When JTAPI launches, you receive options for choosing languages for the installation. After choosing a language, further installation instructions display in the chosen language. The first option always specifies English. If certain phrases are missing in the locale language, the instructions default to English. See Chapter 3, "Cisco Unified JTAPI Installation" for more information.

Clear Calls Interface

Cisco Unified JTAPI applications can clear phantom calls without dropping active calls. The CiscoAddress provides a clearCallConnections message to allow applications to clear the calls when no active calls exist on the Cisco Unified Communications Manager (formerly Cisco Unified CallManager).

Device Recovery

Cisco Unified JTAPI supports automatic device recovery.

Device Recovery for phones

For devices such as the Cisco Unified IP Phone 7960, the re-homing feature represents part of the device firmware. On a primary Cisco Unified Communications Manager failure, the phone attempts to connect to the backup Cisco Unified Communications Manager when it is no longer on a call. This transition gets communicated to applications in the form of out-of-service and in-service events that the CTIManager Failure section describes.

For virtual devices with no firmware such as CTI Ports and CTI RoutePoints, the CTIManager or Cisco Unified JTAPI performs the failover.

CTI RoutePoints

On a Cisco Unified Communications Manager server failure, the CTIManager recovers the device from the Cisco Unified Communications Manager server group as defined in the device pool administration for the CTI RoutePoint. When the primary Cisco Unified Communications Manager server recovers, the CTIManager attempts to recover the device on its primary Cisco Unified Communications Manager. This re-homing happens when no more calls exist on the device (similar to physical devices).

On a CTIManager failure, Cisco Unified JTAPI recovers the device on the backup CTIManager. The application receives notification of the availability of a device with the CiscoAddrOutOfServiceEv and CiscoAddrInServiceEv events.

CTI Ports

CTI Ports that are registered by an application include a mechanism similar to phone devices. When the Cisco Unified Communications Manager that is handling signaling for a CTIPort fails, the CTIManager recovers its services according to the device pool administration for this device. On a CTIManager failure, Cisco Unified JTAPI reregisters the CTI Port after it connects to the backup CTIManager. The CiscoAddrOutOfServiceEv and CiscoTermOutOfServiceEv events and the corresponding in-service events get sent after recovery of the CTI Port.

The application controls media streaming for these devices, and streaming continues even when the port is out of service. The application has responsibility to ensure that new calls do not get presented to the device until it is ready to accept them.

Directory Change Notification

Applications require notification asynchronously of device additions or deletions from the user control list and device deletions from the Cisco Unified Communications Manager database. Applications also receive notification about line changes to a device. This notification gets sent to Cisco Unified JTAPI, propagates to applications with CiscoAddrCreatedEv, CiscoAddrRemovedEv, CiscoTermCreatedEv, and CiscoTermRemovedEv on the AddressObserver and TerminalObservers, respectively.


Note Ensure that the device is registered for CTIPorts and CTIRoutePoints to receive the line change notification.


Enable or Disable Ringer

The CiscoAddress extension allows applications to set the status of the ringer for all lines on a device. No events generate when the ringer setting gets changed from the administration pages or anywhere else.

Transfer and Conference Extensions

You may find that transfer and Conference events are difficult to understand in JTAPI. This happens because, when the participants are moved from one call to the other, JTAPI represents this action by deleting the parties from one call and adding them to the other call. It may confuse you for an application to receive an indication that a party dropped from the call when, in reality, it is in the process of being moved. The Cisco Unified JTAPI implementation defines some extra events that make it easier for applications to deal with these functions.

Transfer

The transfer feature moves the participants of one call, the transferred call, to another call, the final call. Moving participants in a call results in their associated Connections transitioning to the DISCONNECTED state in the transferred call and new Connections for these participants being created in the final call. Similarly, any associated TerminalConnections transition into the DROPPED state in the transferred call and get created in the final call. Cisco extensions by definition mark the start and the end of the events that relate to transfer.

You can correlate the newly created connection objects with the old connection objects by use of the CiscoConnection.getConnectionID() method to obtain the CiscoConnectionID for the old and new connections. Matching connections possess identical CiscoConnectionID objects when compared by using the CiscoConnectionID.equals() method.

CiscoTransferStartEv

This event indicates that the transfer operation started, and the events that follow relate to this operation. Specifically, Connections and TerminalConnections get both removed and added as a result of the transfer.

Applications may obtain the two calls that are involved in transfer-transferred call and final call and the transfer controller information from this event. If the JTAPI application is not observing the transfer controller, the transfer controller information does not get made available in this event.

CiscoTransferEndEv

This event indicates that the transfer operation ended. After this event is received, the application can assume that all involved parties transferred, and all Connections and TerminalConnections moved to the final call.

Transfer Scenarios

In the following scenarios, A, B, and C represent three parties that are involved in the transfer.

Consult Transfer, Where B is the Transfer Controller

In a consult transfer, applications can redirect calls to a different address, and the transferrer can "consult" with the transfer destination before redirecting.

A calls B on call Call1.

B answers and consults to C on call Call2.

B transfers call Call2 to call Call1.

To do this type of transfer, use the following JTAPI methods:

Call2.setTransferEnable(true) (This optional method means transfer is enabled in the call object by default.)

Call2.consult(TermConnB, C)

Call1.transfer(Call2)


Note During consult transfer, Call1.transfer(Call2) will transfer the call but not Call2.transfer(Call1).


Table 1-1 lists the core events that observers of A and B receive between the CiscoTransferStartEv and the CiscoTransferEndEv:

Table 1-1 Core Events for Observers of A and B 

Meta Event Cause
Call
Event
Fields

META_UNKNOWN

Call1

CiscoTransferStartEv

transferredCall=Call2
finalCall=Call
transferController=
TermConnB

META_CALL_TRANSFERRING

Call1

TermConnDroppedEv B
CallCtlTermConnDroppedEv B
ConnDisconnectedEv B
CallCtlConnDisconnectedEv B

 

META_CALL_TRANSFERRING

Call1

ConnCreatedEv C
ConnConnectedEv C
CallCtlConnEstablishedEv C
TermConnCreatedEv C
TermConnActiveEv C
CallCtlTermConnTalkingEv C

 

META_CALL_TRANSFERRING

Call2

TermConnDroppedEv B
CallCtlTermConnDroppedEv B
ConnDisconnectedEv B
CallCtlConnDisconnectedEv B

 

META_CALL_TRANSFERRING

Call2

TermConnDroppedEv C
CallCtlTermConnDroppedEv C
ConnDisconnectedEv C
CallCtlConnDisconnectedEv C
CallInvalidEv C

 

META_UNKNOWN

Call2

CallObservationEndedEv

 

META_UNKNOWN

Call1

CiscoTransferEndEv

transferredCall=Call2
FinalCall=Call1
transferController=
TermConnB


Arbitrary Transfer, Where A is the Transfer Controller

In an arbitrary transfer, one call can get transferred to another call, irrespective of how either call was created. Unlike consult transfer, no need exists to first create one of the calls by using the consult method.

A calls B on call Call1.

A puts Call1 on hold.

A calls C on call Call2.

A transfers Call1 to Call2.

To do this type of transfer, use the following JTAPI methods:

Call2.transfer(Call1) to transfer call Call1 to final call Call2, or

Call1.transfer(Call2) to transfer call Call2 to final call Call1

Assuming Call1.transfer(Call2) was called, Table 1-2 lists the core events that observers on A and C receive between CiscoTransferStartEv and CiscoTransferEndEv:

Table 1-2 Core Events for Observers of A and C 

Meta Event Cause
Call
Event
Fields

META_UNKNOWN

Call1

CiscoTransferStartEv

transferredCall=Call2
finalCall=Call1
transferController=
TermConnB

META_CALL_TRANSFERRING

Call1

TermConnDroppedEv B
CallCtlTermConnDroppedEv B
ConnDisconnectedEv B
CallCtlConnDisconnectedEv B

 

META_CALL_TRANSFERRING

Call1

ConnCreatedEv C
ConnConnectedEv C
CallCtlConnEstablishedEv C
TermConnCreatedEv C
TermConnActiveEv C
CallCtlTermConnTalkingEv C

 

META_CALL_TRANSFERRING

Call2

TermConnDroppedEv B
CallCtlTermConnDroppedEv B
ConnDisconnectedEv B
CallCtlConnDisconnectedEv B

 

META_CALL_TRANSFERRING

Call2

TermConnDroppedEv C
CallCtlTermConnDroppedEv C
ConnDisconnectedEv C
CallCtlConnDisconnectedEv C
CallInvalidEv C

 

Conference

When conferencing two calls together, JTAPI specifies that all the parties from one call be moved to the other call. The call whose parties are moved away and that subsequently becomes invalid gets identified as the "merged" or "consult" call. The call to which the merged parties move gets identified as the "final" call hereafter. When parties move from the merged call to the final call, the application receives events that indicate that all parties dropped from the merged call and events that indicate that the parties reappeared on the final call.

To correlate the newly created connection objects with the old connection objects, use the CiscoConection.getConnectionID() method to obtain CiscoConnectionID objects for all old connections and all new connections. Matching connections will have identical CiscoConnectionID objects when compared by using the CiscoConnectionID.equals() method.

Conference support exists for the following methods:

javax.telephony.callcontrol.CallControlCall.conference(Call)

javax.telephony.callcontrol.CallControlCall.getConferenceController()

javax.telephony.callcontrol.CallControlCall.getConferenceEnable()

javax.telephony.callcontrol.CallControlCall.setConferenceController(TerminalConnection)

javax.telephony.callcontrol.CallControlCall.setConferenceEnable(boolean)

Cisco Extensions

Cisco Unified JTAPI implementation provides two extra events that signal the Start and End of Conference: CiscoConferenceStartEv and CiscoConferenceEndEv. These events get sent when Conference initiates and when it completes. They give handles to the final call, the merged conference (consult) call, and the two controlling TerminalConnections (in HELD and TALKING state).

CiscoConferenceStartEv

This event gets sent when call1.conference(call2) is invoked or if the Conference button is pressed for the second time on an IP phone. The ConferenceStartEv signifies the start of the merging process. A sequence of merging events that are reflected by the Conference process in Cisco Unified Communications Manager follows.

CiscoConferenceEndEv

This event gets sent at the end of the merge process after a ConferenceStartEv is sent. It signifies the completion of the merge of the Consult (or Merged) call into the Final Conference Call. The Merged call specifies in INVALID state and an ObservationEndedEv gets sent for the call observer.

CiscoCall.setConferenceEnable()

The Cisco Unified JTAPI implementation uses the CiscoCall.setConferenceEnable() and the CiscoCall.setTransferEnable() methods to control whether the consult call will be initiated via the conference or the transfer feature. If none of the features is enabled explicitly, transfer gets used by default.

Conference Scenarios

The following scenarios describe the two typical types of Conference that can be invoked.

Consult Conference with B as the Conference Controller

The following sequence of steps typically describes this scenario:

A calls B (Call 1).

B answers.

B Consults C (Call 2).

setConferenceEnable()

call2.consult(tc, C)

C answers.

B Completes Conference.

Call1.conference(Call2)


Note You must invoke the conference() method on the original call to complete a conference after a consultation. Invoking conference in the consult call object throws an exception.


Arbitrary Conference with B as the Conference Controller

The following sequence of steps typically describe this scenario:

A calls B (Call 1).

B answers.

B places the call on hold.

B calls C (Call 2).

C answers.

B Completes Conference.

Call1.conference(Call2) or

Call2.conference(Call1)

Conference Events

Table 1-4 provides the sequence of Core, Call control, and Cisco Extension events when Call1.Conference(Call2) is called:

Table 1-3 Sequence of Events 

Meta Event Cause
Call
Event
Fields

META_UNKNOWN

Call1

CiscoConferenceStartEv

consultCall = Call2
finalCall = Call1
conferenceController=
TermConnB

META_CALL_MERGING

Call1

CallCtlTermConnTalkingEv B

 

META_CALL_MERGING

Call1

ConnCreatedEv C
ConnConnectedEv C
CallCtlConnEstablishedEv C
TermConnCreatedEv C
TermConnActiveEv C
CallCtlTermConnTalkingEv C

 

META_CALL_MERGING

Call2

TermConnDroppedEv B
CallCtlTermConnDroppedEv B
ConnDisconnectedEv B
CallCtlConnDisconnectedEv B

 

META_CALL_MERGING

Call2

TermConnDroppedEv C
CallCtlTermConnDroppedEv C
ConnDisconnectedEv C
CallCtlConnDisconnectedEv C
CallInvalidEv C

consultCall=Call2
finalCall=Call1
conferenceController=
TermConnB

META_UNKNOWN

Call2

CallObservationEndedEv

 

META_UNKNOWN

Call1

CiscoConferenceEndEv

 

Transfer and Conference Enhancement

All parties who are involved in the call transfer get sent CiscoTransferStartEv and CiscoTransferEndEv. All parties involved in the call conference get sent CiscoConferenceStartEv and CiscoConferenceEndEv. A call transfer still generates two events—the dropping of a connection to the first call and the creation of a connection to the second call. Cisco Unified Communications Manager Release 3.1 changed this order of events. Connections first get created in the final call and then get dropped in the consult call.


Note In Cisco Unified Communications Manager Release 3.0, not all parties who are involved in the transfer of calls received these events



Note Applications should not rely on the order of events between CiscoTransferStartEv and CiscoTransferEndEv or between CiscoConferenceStartEv and CiscoConferenceEndEv for transferring and conferencing when porting applications from Cisco Unified Communications Manager Release 3.0 to 3.1.


Consult Without Media

Applications can inform Cisco Unified Communications Manager that a consultation call for a transfer is being placed without establishing the media path. The system does not require establishing the media path for the intermediate call, if the consultation call is being placed to determine whether an agent is available before the actual transfer. The consultWithoutMedia method as defined in the CiscoConsultCall interface creates a consultation call without establishing the media path.


Note The system allows only transferring the consultation call; it does not allow the call to be conferenced.


Media Termination Extensions

The media termination feature allows applications to transmit and capture the bearer of a call, for example, audio or video. This action sometimes gets referred to as "rendering and recording" or "sourcing and sinking" media. It remains distinct from call control because media termination concerns the data that flows between endpoints in a call, not the details of setting up or tearing down calls. For example, an automatic call distributor (ACD) uses call control to route calls among available agents but does not terminate media. An interactive voice response (IVR) application, on the other hand, uses call control to answer and disconnect calls and uses media termination to play sound files to callers.

Although no telephony applications are solely interested in media termination, this feature always gets used in combination with call control. JTAPI 1.2 primarily represents a call control specification and offers very limited support for applications that require media termination. Because the Cisco Unified Communications Solutions platform supports media termination to a much greater degree than JTAPI standard, the Cisco Unified JTAPI implementation extends JTAPI to add full support for this feature.

In Cisco Unified JTAPI, software-based media termination occurs by using Computer Telephony Integration (CTI) ports. They include one or more lines (dialable numbers) that can be used to originate or receive calls. They however need a controlling application to provide the source and sink of the media. An application registers its interest in the media termination port with the Cisco Unified Communications Manager. The Cisco Unified Communications Manager then delivers all the events that relate this virtual device to the application. In Cisco Unified JTAPI, CTI Ports get referred to as CiscoMediaTerminals. Figure 1-3 shows the CTI port configuration. For details about administering and configuring a CTI Port, refer to the Cisco Unified Communications Manager Administration information.

Figure 1-3 CTI Port Diagram

To implement a softphone application (where the PC acts as the telephone set, for example), the Cisco Unified JTAPI application would manage a CTI port.

Cisco Unified Communications Manager Media Endpoint Model

Endpoints represent the entities within the Cisco Unified Communications Solutions platform that terminate media, such as IP telephones and gateways. A call from one endpoint to another results in media flowing between the two endpoints. All endpoints in the Cisco Unified Communications Solutions platform transmit voice data by using real-time protocol (RTP). The Cisco Unified Communications Solutions telephones and gateways, for example, include built-in RTP stacks. Applications may also act as endpoints in a Cisco Unified Communications Solutions system; that is, they may terminate media. Because all Cisco Unified Communications Solutions endpoints use RTP, applications also must be able to transmit and receive RTP packets.

Payload and Parameter Negotiation

In addition to bearer data and payload, each RTP packet contains a header that helps endpoints to determine how to reassemble and decode a sequence of such packets into a media stream. RTP does not provide, however, a means for endpoints to negotiate which payload type to use for a particular stream. For example, audio data that is encoded by using the G.711 standard. Furthermore, RTP does not offer a means of negotiating unique payload type parameters such as the sampling rate of the encoded data or the number of samples that are to be transferred in each RTP packet. Instead, RTP usually gets used in conjunction with another protocol such as H.323, which specifies its own method for endpoints to negotiate these parameters. All such negotiation occurs prior to transmitting RTP packets between endpoints.

Cisco Unified Communications Manager, not the endpoints, has responsibility for selecting the payload and encoding parameters for RTP streams. The following five steps that are involved in a typical bidirectional audio telephone call apply:

Initialization

Payload Selection

Receive Channel Allocation

Starting Transmission and Reception

Stopping Transmission and Reception

Initialization

Upon startup, each endpoint informs Cisco Unified Communications Manager of its media capabilities, that is, G.711, G.723, G.729a, and so on. Startup for an IP phone for example, occurs when the phone is first turned on, or after it recontacts Cisco Unified Communications Manager after losing its former connection. The endpoint cannot express a preference for one payload type versus another, but it can specify certain parameters for each payload type, such as, packet size.

The capability list that the endpoint registers remains exclusive and immutable. If the endpoint specifies that it can support both G.711 and G.723, it implicitly declares that it cannot support G.729a. Moreover, the endpoint must disconnect from Cisco Unified Communications Manager and reinitialize to change the list of capabilities that it supports.

JTAPI applications perform this step by registering a CiscoMediaTerminal with Cisco Unified Communications Manager. The CiscoMediaTerminal.register() method allows applications to supply an array of media capability objects for registration with Cisco Unified Communications Manager. This step informs Cisco Unified Communications Manager that the application will act as the endpoint for all calls to or from a particular directory number, as determined by the device configuration in the Cisco Unified Communications Manager configuration.

Payload Selection

When a bidirectional media stream is about to be created between two endpoints, for instance, when a call is answered at an endpoint, Cisco Unified Communications Manager selects an appropriate payload type (codec) for the media stream. Cisco Unified Communications Manager compares the media capabilities of both endpoints that are involved in the call and selects the appropriate common payload type and payload parameters to use.

The basis for payload selection includes endpoint capabilities and location, although other criteria may get added to this selection logic in the future. Endpoints do not get dynamically involved in selecting payload types on a call-by-call basis.

Receive Channel Allocation

If Cisco Unified Communications Manager can find a common payload type for the RTP stream between the two endpoints, it requests that each endpoint create a logical "receive channel;" that is, a unique IP address and port at which the endpoint will receive RTP data for the call. Each endpoint returns an IP address and port to Cisco Unified Communications Manager in response to this request.

Currently, only IP phones and gateways perform this step. Cisco Unified Communications Manager requires JTAPI applications to specify a fixed IP address and port during initialization. Therefore, JTAPI applications cannot terminate more than one media stream simultaneously for the same endpoint. Applications that want to terminate multiple media streams must register multiple endpoints simultaneously.

If the endpoint does not respond to the open receive channel request quickly enough, Cisco Unified Communications Manager disconnects the call. Because JTAPI applications always supply an IP address when registering CiscoMediaTerminals, calls to application-controlled endpoints do not get disconnected for this reason. However, if Cisco Unified Communications Manager cannot find a common payload type between the two endpoints that are involved in the call, Cisco Unified Communications Manager disconnects the call.

Starting Transmission and Reception

After Cisco Unified Communications Manager receives channel information for both parties, it informs each endpoint of the codec parameters that it selected for the RTP stream and the destination address for the other endpoint. This information gets conveyed in two messages to each endpoint: a start transmission message and a start reception message.

JTAPI applications receive the CiscoRTPOutputStartedEv and CiscoRTPInputStartedEv events that contain all the codec parameters that are necessary for sending and receiving RTP data.

As a part of the QoS baselining effort in JTAPI, CiscoRTPOutputStartedEv provides the getPrecedenceValue() API to applications. CTI presents this value, "The DSCP for Audio Calls" to JTAPI. Using this value, applications can set the DSCP value for the media streams that they open.

Stopping Transmission and Reception

When the RTP stream must be interrupted because of a feature such as hold or disconnect, Cisco Unified Communications Manager requests that each endpoint stop its transmission and reception of RTP data. Just as when the media flow is started, the stop transmission and stop reception messages get sent separately.

JTAPI applications receive the CiscoRTPOutputStoppedEv and CiscoRTPInputStoppedEv.

CiscoMediaTerminal

In JTAPI, the terminal object represents the logical endpoint for a call and is presumed to be able to receive and transmit data (digital encoded voice samples, for example). Thus, terminals in JTAPI represent Cisco Unified IP Phones. Even though gateways terminate media, terminals do not represent them. The CiscoMediaTerminals in particular represent a special kind of endpoint for which applications take responsibility for media termination.

The following four steps associate with using CiscoMediaTerminals:

Provisioning

Registration

Adding Observers

Accepting Calls

Provisioning

Ensure CiscoMediaTerminals, which are analogous to physical terminals, get provisioned accordingly in Cisco Unified Communications Manager, even though they do not represent actual hardware IP phones or gateways. Just as IP phones must be added to Cisco Unified Communications Manager database by using the Device Wizard, CiscoMediaTerminals get added the same way, so Cisco Unified Communications Manager can associate the application endpoint with a directory number and other call control properties such as call forwarding. No device type called "CiscoMediaTerminal" exists in the DeviceWizard. Instead, Cisco Unified Communications Manager has one or more device types that support application registration—each of these types get exposed as a CiscoMediaTerminal through JTAPI. Currently, only the device type "CTI port" represents a CiscoMediaTerminal in JTAPI.

This procedure lists the steps for provisioning a CTI port for use as an application-controlled endpoint.

Procedure


Step 1 Within the Cisco Unified Communications Manager configuration web pages, add a "CTI port" device from the Device-Phone web page by using the Device Wizard. The CTI port device name specifies the name of the corresponding CiscoMediaTerminal in JTAPI.

Step 2 Add the new CTI port device, by using the User-Global Directory web page, to the list of devices that the application controls by using the User web page.


For more information, refer to the Cisco Unified Communications Manager Administration Guide.

Registration

After a media termination device is properly provisioned in Cisco Unified Communications Manager, the application may obtain a reference to the corresponding CiscoMediaTerminal object by using either the Provider.getTerminal() method or CiscoProvider.getMediaTerminal() method. The the two methods differ in that the CiscoProvider.getMediaTerminal() method only returns CiscoMediaTerminals, whereas Provider.getTerminal() will return any terminal object that is associated with the provider, including those representing physical IP phones.

Use the CiscoMediaTerminal.register() method to notify Cisco Unified Communications Manager of the intent to terminate RTP streams of certain payload types. The CiscoMediaTermina.register() method takes an IP address, a port number, and an array of CiscoMediaCapability objects that indicate the types of codecs that are supported by the application as well as codec-specific parameters.

The IP address and port indicate the address where the application can receive media streams. The following sample code demonstrates how to register a CiscoMediaTerminal and bind it to a local address, port number 1234:

CiscoMediaTerminal registerTerminal (Provider provider, String terminalName) {
   final int PORT_NUMBER = 1234;
   try {
      CiscoMediaTerminal terminal = provider.getTerminal (terminalName);
      CiscoMediaCapability [] caps = new CiscoMediaCapability [1];
      caps[0] = CiscoMediaCapability.G711_64K_30_MILLISECONDS;
      terminal.register (InetAddress.getLocalHost (), PORT_NUMBER, caps);
   }
   catch (Exception e) {
       return null;
   }
}

For this sample code to work, ensure the specified provider is IN_SERVICE. Further, be aware that this code uses the constant CiscoMediaCapability.G711_64K_30_MILLISECONDS. This actually represents a static reference to a CiscoG711MediaCapability object that specifies a 30-millisecond maximum RTP packet size. The CiscoMediaCapability class predefines this and other common media formats.

To specify a media payload that is not listed in the CiscoMediaCapability class, two options exist. If the desired payload type is a simple variation of one of the existing subclasses of CiscoMediaCapability, you only need to construct a new instance of the subclass. For instance, if an application can support G.711 payloads with a 60-millisecond maximum RTP packet size, it can construct the CiscoG711MediaCapability object directly, specifying 60 milliseconds in the constructor.

Alternatively, if no existing subclass of CiscoMediaCapability that matches the desired payload type exists, construct an instance of the CiscoMediaCapability class directly. The maximum packet size, for example, 30-milliseconds, represents the only other parameter that may be specified when constructing a CiscoMediaCapability.

The following code illustrates registering a custom payload capability:

CiscoMediaTerminal registerTerminal (Provider provider, String terminalName) {
   final int PORT_NUMBER = 1234;
   try {
      CiscoMediaTerminal terminal = provider.getTerminal (terminalName);
      CiscoMediaCapability [] caps = new CiscoMediaCapability [1];
      caps[0] = new CiscoMediaCapability (
         RTPPayload.G728,
         30    // maximum packet size, in milliseconds
         );
      terminal.register (InetAddress.getLocalHost (), PORT_NUMBER, caps);
   }
   catch ( Exception e) {
       return null;
   }
}

The payload type parameter that is used for constructing the CiscoMediaCapability object corresponds to the payload field in the RTP header. The RTPPayload interface defines a number of well-known payload types for this purpose.

Adding Observers

To receive events that indicate where and when to transmit and receive RTP data, place a CiscoTerminalObserver on the CiscoMediaTerminal. The CiscoTerminalObserver extends the standard JTAPI TerminalObserver interface without defining any new methods; it provides a marker interface that signals the application interest in receiving RTP events.


Note Because this is a TerminalObserver, not a CallObserver, it must get added by using the Terminal.addObserver() method, not the Terminal.addCallObserver() method.


Additionally, add a CallControlCallObserver to the Address object that is associated with the CiscoMediaTerminal. This guarantees that the application will get notified when calls are offered to the CiscoMediaTerminal. Unlike regular IP phones, which automatically accept any offered call, CiscoMediaTerminals accept, disconnect (reject), or redirect any call that is offered to it. Because the CallCtlConnOfferedEv is only presented to CallControlCallObservers that are placed on Address objects, not Terminal objects, the application places its CallControlCallObserver in the correct place.


Note Be sure to implement the CallControlCallObserver interface, not just the CallObserver interface; the CallCtlConnOfferedEv will not get delivered to observers that implement only the core CallObserver interface.


Accepting Calls

When an inbound call arrives at the CiscoMediaTerminal address, it must be accepted by using the CallControlConnection.accept() method before a terminal connection gets created. This process does not apply for outbound calls —the connection will occur in the CallControlConnection.ESTABLISHED state as soon as the call progresses beyond digit recognition. After the connection is accepted, answer the ringing terminal connection to start media flow. Assuming that Cisco Unified Communications Manager can match the capabilities that were registered with the capabilities of the calling endpoint, Cisco Unified Communications Manager sends the Media Flow events, so the application can begin transmitting and receiving RTP data.

Receiving and Responding to Media Flow Events

Whenever a media stream must be created between two endpoints, Cisco Unified Communications Manager issues start transmission and start reception events to both endpoints. In JTAPI, the CiscoRTPOutputStartedEv and CiscoRTPInputStartedEv events represent the start transmission and start reception events. The CiscoRTPOutputStartedEv.getRTPOutputProperties() method returns a CiscoRTPOutputProperties object, from which the application can determine the destination address of its peer endpoint in the call, as well as the other RTP properties for the stream such as payload type and packet size. Similarly, the CiscoRTPInputStartedEv.getRTPInputProperties() method returns a CiscoRTPInputProperties object that informs the application of the RTP characteristics for the inbound stream.

At any time while media is flowing, the current CiscoRTPOutputProperties and CiscoRTPInputProperties also remain available from the CiscoMediaTerminal.getRTPOutputProperties() and CiscoMediaTerminal.getRTPInputProperties() methods as well. These methods throw an exception if the CiscoMediaTerminal is not currently supposed to transmit or receive media.

When Cisco Unified Communications Manager wants the application to stop sending or receiving media as the result of a call disconnecting or being put on hold, for example, it sends the CiscoRTPOutputStoppedEv and CiscoRTPInputStoppedEv events. These events mean that the current RTP media stream that exists between the two endpoints should be torn down.

Inbound Call Media Flow Event Diagram

Table 1-4 illustrates the dialogue between Cisco Unified Communications Manager and a JTAPI application when a call is presented to an application-controlled endpoint. The events in the left column represent JTAPI events that are sent to the CallObserver of the application, and the requests in the right column represent methods that the application invokes.

Table 1-4 Inbound Media Flow Event 

JTAPI Event
Direction
Application Request

CallActiveEv

ConnCreatedEv

ConnProceedingEv

CallCtlConnOfferingEv

Æ

 
 

¨

CallControlConnection.accept ()

CallCtlConnAlertingEv

TermConnCreatedEv

TermConnRingingEv

Æ

 
 

¨

TerminalConnection.answer ()

ConnConnectedEv

CallCtlConnEstablishedEv

TermConnTalkingEv

CiscoRTPOutputStartedEv

CiscoRTPInputStartedEv

Æ

 
 

¨

CallControlConnection.disconnect ()

CiscoRTPOutputStoppedEv

CiscoRTPInputStoppedEv

TermConnDroppedEv

CallCtlConnDisconnectedEv

Æ

 


Note Table 1-4 shows JTAPI events for the local connection: that is, for the application endpoint. The actual JTAPI meta event stream contains events that describe the state of the calling party.


Cisco Unified Communications Solutions RTP Implementation

The Cisco Unified Communications Solutions architecture puts a premium on performance, and thus Cisco Unified Communications Solutions phones and gateways do not implement some of the features of RTP and its often-associated real-time control protocol (RTCP). To ensure its compatibility, applications must consider the following points:

Because RTCP is not supported. Cisco Unified Communications Solutions endpoints will not send RTCP messages, and they will ignore any such messages that are sent to them.

Cisco Unified Communications Solutions endpoints do not currently make use of the synchronization source (SSRC) field in the RTP header. Applications must not multiplex RTP streams by using the SSRC field, or phones and gateways may not correctly decode and present the media.

Redirect

JTAPI 1.2 specifies that one of the preconditions of the CallControlConnection.redirect() method is for the state of the connection to be in either the CallControlConnection.OFFERING or the CallControlConnection.ALERTING state. Cisco Unified JTAPI also allows a connection in the CallControlConnection.ESTABLISHED state to be redirected.

The redirect() method includes the following overloaded form in the CiscoConnection interface. It allows applications to specify the behavior that is desired when a failure occurs while redirecting a call, specifying the calling search space, or resetting the original called field.

Applications choose the desired behavior, by passing one of the following INT parameters in the overloaded redirect method from the CiscoConnection interface:

Redirect drop on failure—When a call is directed to a busy or an invalid destination, Cisco Unified Communications Manager can either drop the call if the redirect fails or leave the call at the redirect controller. The JTAPI application can then take corrective action, such as redirecting the call to another destination. The option for the redirect mode parameter follow:

CiscoConnection.REDIRECT_DROP_ON_FAILURE

CiscoConnection.REDIRECT_NORMAL

Calling Address search space—Redirect uses the calling search space parameter to indicate which callingSearchSpace is used. Applications can either use the calling party search space or the redirect controller search space. The parameter options for this scenario follow:

CiscoConnection.CALLINGADDRESS_SEARCH_SPACE

CiscoConnection.ADDRESS_SEARCH_SPACE

Resetting original called—The called address option parameter gets used to reset the original called fields. The options for this scenario follow:

CiscoConnection.CALLED_ADDRESS_UNCHANGED

CiscoConnection.CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION. This option affects the fields when the call arrives at the redirect destination.

For more information, refer to the com.cisco.jtapi.extensions.CiscoConnection documentation.

For the scenario where A Calls B, B redirects to C, and C (redirect destination) is not a provider observed address, JTAPI would provide CallCtlConnAlertingEv for C with cause code Ev.CAUSE_NORMAL. Prior to release 5.0, the cause code was Ev.CAUSE_REDIRECT for the same scenario.

This change was made to keep the behavior consistent for scenarios where C observed or did not observe the provider.


Note When C is observed, for the same scenario, CallCtlConnAlertingEv at C is provided with CAUSE_NORMAL from releases prior to 5.0, and that behavior continues without change.


Routing

Routing in JTAPI requires the configuration of a CTI Route Point on the Cisco Unified Communications Manager. Multiple calls can be queued to this Route Point, but only a single line can be configured on a CTI Route Point device.

JTAPI implementation of adjunct Routing, as described in the call center package, includes the following actions:

Registering route callbacks on Route Addresses

Creating appropriate handlers in response to the various routing events (routeSelect, routeEnd)


Note CTI Route Points represent devices that can process any number of incoming calls simultaneously on the same line. You can route calls by using the methods in the javax.telephony.callcenter package, or you can accept, redirect, or disconnect calls by using the methods in the javax.telephony.callcontrol package. You can configure each CTI Route Point with only one line in the Cisco Unified Communications Manager. A single CTI Route Point supports a maximum of 34 lines. To support more than 34 lines, provision additional route points. For details on how to configure and administer the CTI Route Point, refer to the Cisco Unified Communications Manager Administration Guide.


Figure 1-4 shows the CTI Route Point configuration.

Figure 1-4 CTI Route Points

Cisco Route Session Implementation

When a call comes in to the RouteAddress, the implementation starts a Route Session thread and sends the application a RouteEvent. This thread in turn starts a timer thread to time the application response to a RouteEvent with either a routeSelect() or an endRoute(). If the application responds with a routeSelect (String[] selectedRoutes), JTAPI verifies that all preconditions are satisfied and then attempts to route the call to the first destination that is specified in the array. If the destination is a valid and available number, the call gets routed, and the application gets a RouteUsedEvent followed by a RouteEndEvent. Otherwise, if an error occurs in routing (which may be caused by an invalid/busy/unavailable destination), the application gets a ReRouteEvent. JTAPI starts the Timer Thread again before it sends the re-Route Event. Because Cisco Unified Communications Manager does not support re-Routing, if the routing was unsuccessful, the caller will either receive a busy tone, or the call will get dropped. The application can clean up all failure instances and/or send JTAPI an endRoute to clean up the RouteSession. If the application does not respond with an endRoute(), the JTAPI timer once again expires, and JTAPI cleans up the Route Session by sending the application a RouteEndEvent().

If the routing timer expires before the application returns with a selectRoute() or an endRoute() method, the Cisco Unified Communications Manager applies same treatment as when a call is made to an unregistered phone (that is play fast busy). If ForwardNoAnswer is configured on the Route Point, the call immediately forwards to that number when the timer expires.

If the application cannot respond with a valid address to which to route the call, the application may choose to call endRoute with an error. The JTAPI specification defines three errors in the RouteSession interface: ERROR_RESOURCE_BUSY, ERROR_RESOURCE_OUT_OF_SERVICE, and ERROR_UNKNOWN. If an endRoute is invoked on the RouteSession, the implementation currently accepts() the call at the RouteAddress, so the caller may begin to receive ringback. If forwarding is configured for the Route Point, the call gets forwarded when the Forwarding Timer expires.

Select Route Timer

Configure this timer via the JTAPI.ini configuration file that has a key called RouteSelectTimeout=5000. Use milliseconds as the unit. The default value for this timer specifies 5 seconds; however, depending on the needs of the application, you can extend or decrease this timer to improve Route Session cleanup efficiency. Ensure that this timer is not unreasonably large. Each Route Session as a thread represents a call to the Route Point, and these Route Sessions should be cleaned up. Should an application expect significant delays between receiving the Route Event and responding with a routeSelect/endRoute event, the application would want to appropriately extend this timer.

Forwarding Timer

You can configure the timer for Forward on No Answer that is currently systemwide (that is, it applies to all devices on Cisco Unified Communications Manager) via the Cisco Unified Communications Manager Service Parameters configuration. The default value for this timer specifies 12 seconds. In future releases, a separate timer for CTI Route Points might be included, so that forwarding for the route point takes effect immediately after JTAPI accepts the call (when the application calls an endRoute or if the routing timer expires).

RouteSession Extension

CiscoRouteSession acts as a Cisco Extension to the JTAPI specification. Most importantly, this extension exposes the underlying Call object to the Applications. CiscoRouteSession.getCall() returns CiscoCall, and this call exposes other Call Model Objects such as the associated Addresses, Connections, and so on. The extension also defines additional errors for the application.

Caller Options Summary

In the absence of a callback, or if RouteSession.routeSelect() or endRoute() has not responded to a routeEvent, the caller receives nothing until

The application can disconnect() or reject() the connection on the Route Point and thereby the caller receives a busy tone.

The application can accept the call, and the Forward No Answer, if configured, kicks in.

The application can drop the call. The caller holds the receiver but does not know what happened.

With a callback, if the application chooses to call an endRoute(), after endRoute() returns, the caller receives a ringback until

The client calls a disconnect() that would drop the call.

The client redirects() the call.

The forward on no answer timer that is configured via the scm.ini will kick in and forward the call unless the preceding two options have already kicked in.

If no forwarding is configured for the Route Point, the caller continues to receives a ringback unless the first two options kick in.

Fault Tolerance When Using Route Points

One way for an application that uses route points to deal with fault tolerance requires connecting two JTAPI applications to two different Cisco Unified Communications Managers, each registering a different RouteAddress. For example, Application1 manages RouteAddress1 by using Communications Manager1. Application2 manages RouteAddress2 by using Communications Manager2. In Cisco Unified Communications Manager Administration, ensure the ForwardNoAnswer configuration for these CTI Route Points is administered so they point to each other. In this example, RouteAddress1 would have FNA=RouteAddess2, and RouteAddress2 would have FNA=RouteAddress1. If Communications Manager1 goes down, calls forward to RouteAddress2, so Application2 takes over. Furthermore, both applications could be configured to reconnect to the proper Cisco Unified Communications Manager server when they receive a ProviderShutdown event.

Redundancy

Configuration requires that devices are configured into device pools and are assigned static Cisco Unified Communications Manager groups. Devices register with a particular Cisco Unified Communications Manager server that handles call control signaling. When a server fails, the devices failover to the backup server in the group. When the primary server comes back online, it waits until no active calls exist on the device, then re-homes to the primary Cisco Unified Communications Manager server. Cisco Unified JTAPI informs the applications of this transition by sending a temporary out-of-service message while registering to the backup server.

Cluster Abstraction

The CTIManager provides a virtual representation of all the Cisco Unified Communications Managers in a cluster. Cisco Unified JTAPI applications communicate with the CTIManager instead of with a specific Cisco Unified Communications Managers. The CTIManager also maintains connection between Cisco Unified Communications Managers in a cluster. This allows a provider to represent any devices in the cluster under the CTIManager. Figure 1-5 illustrates "Single-box Configuration with JTAPI, Cisco Unified Communications Manager, and CTIManager in One Box." Figure 1-6 illustrates "Redundant Cisco Unified Communications Manager and CTIManagers with JTAPI Deployed as a Separate Client."

For more details about the cluster administration and device pool settings, refer to the Cisco Unified Communications Manager help pages.

Figure 1-5 Single-box Configuration with JTAPI, Cisco Unified Communications Manager, and CTIManager in One Box

Figure 1-6 Redundant Cisco Unified Communications Manager and CTIManagers with JTAPI Deployed as a Separate Client


Note In previous releases of Cisco Unified Communications Manager, applications that are running on Cisco Unified JTAPI could only control or monitor devices that are registered under a single Cisco Unified Communications Manager. If a Cisco Unified Communications Manager server went down, the connection between the Cisco Unified Communications Manager server and JTAPI would terminate and the Provider would shut down. Cisco Unified Communications Manager Release 3.1, introduced CTIManager service.


Cisco Unified Communications Manager Server Failure

If a Cisco Unified Communications Manager server fails, the associated devices re-home to the next Cisco Unified Communications Manager server in the group. The prioritized list of Cisco Unified Communications Managers in the device pool information configuration for each device defines this process.

Failure of a Cisco Unified Communications Manager server only results in a partial outage of devices in the cluster. Those devices remain available following a successful Cisco Unified Communications Manager failover and registration with a secondary Cisco Unified Communications Manager.


Note A device such as a Cisco Unified IP Phone 7960 fails over to a secondary Cisco Unified Communications Manager server only when no active calls exist on that device. The failure of a Cisco Unified Communications Manager server during a call results only in termination of observation of that device. The media path continues to exist but without any further call control features.


Cisco Unified JTAPI communicates this partial outage to applications by using CiscoAddrOutOfServiceEv and CiscoTermOutOfServiceEv events. When the Cisco Unified Communications Manager fails over, the device must successfully register to the secondary Cisco Unified Communications Manager before the device is available to the JTAPI applications. Cisco Unified JTAPI will send the CiscoAddrInServiceEv and CiscoTermInServiceEv events.

The Provider remains in service during this time. Devices on other Cisco Unified Communications Manager servers remain available for call control. The events get sent on callbacks of the respective Address or Terminal observer objects. CiscoAddrOutOfServiceEv and CiscoAddrInServiceEv events get sent to an object that is implementing the AddressObserver and get added to an Address by using the addressChangedEvent() callback object method. The CiscoTermOutOfServiceEv and CiscoTermInServiceEv events get sent to an object that is implementing the TerminalObserver interface and get added to a Terminal that is using the terminalChangedEvent( ) callback method.

If the devices are currently in a call, a CallObservationEnded message is sent on the CallObserver callChangedEvent() callback, followed by the CiscoAddrOutOfServiceEv and CiscoTermOutOfServiceEv messages.


Note Applications must monitor for and respond to the CiscoAddrOutOfServiceEv, CiscoTermOutOfServiceEv, CiscoAddrInServiceEv, and CiscoTermInServiceEv events before the calling call control functions on the address or terminal. Applications that do not support this action may encounter unexpected errors because the applications do not know the exact state of the system.


Redundancy in CTIManagers

Cisco Unified JTAPI also offers transparent applications for redundancy via the CTIManager. When the primary CTIManager fails, Cisco Unified JTAPI automatically connects to the backup CTIManager and communicates the reconnection to applications. Instead of connecting to a single Cisco Unified Communications Manager server, applications now connect to a set of CTIManagers. The applications supply the CTIManager server names when they invoke JTAPI.

Cisco Unified JTAPI and the CTIManager maintain bidirectional heartbeat signals to detect a loss of connectivity between them. The CTIManager detects when an application no longer runs and cleans up its allocated resources. Figure 1-7 illustrates the"Logical Representation of JTAPI, CTIManager and Cisco Unified Communications Manager in a Cluster"


Note After Cisco Unified JTAPI successfully connects to the primary CTIManager, it alternately will attempt to reconnect to the primary or backup CTIManager if the JTAPI connection to the CTIManager fails.


Figure 1-7 Logical Representation of JTAPI, CTIManager and Cisco Unified Communications Manager in a Cluster

Invoking CTIManager Redundancy

When getProvider() method on the CiscoJtapiPeer is called during the application startup, Cisco Unified JTAPI attempts a connection to the first CTIManager in the list and tries a connection to the next CTIManager if connection attempt fails with the first. If all the CTIManagers in the list are not available or if connection is refused by all CTIManagers, an exception gets sent to the application and no further reconnection attempts occur. After the first successful connection, Cisco Unified JTAPI alternatively attempts to connect to the backup or primary CTIManager when a failure to CTIManager or connection to CTIManager is detected.

The list of redundant CTIManagers designates a comma-separated list that is passed into the CiscoJtapiPeer.getProvider(String providerString) method as a String. The usage for the providerString follows:

providerString = CTIManager;login=XXX;passwd=YYY;appinfo=ZZZ (Non-redundant feature)

providerString = CTIManager1,CTIManager2;login=XXX,passwd=YYY;appinfo=ZZZ (Redundant feature)


Note Because the appinfo parameter is optional, the application provides no specific appinfo parameter. Cisco Unified JTAPI generates one from a JTAPI instance ID and the local host name.


Additionally, the jtapi.ini file may define different CTIManager lists to support the CiscoJtapiPeer.getServices() method. Cisco Unified JTAPI accepts the following definition:

CtiManagers=<CTIManager1>,<CTIManager2>;<CTIManager3>

where

<CTIManager1>,<CTIManager2> specifies a redundant group.

<CTIManager3> specifies a nonredundant group.

CTIManager Failure

When Cisco Unified JTAPI detects a loss of connection to a CTIManager, the application receives notification of this loss in service. The following events get sent to the application on the appropriate Observers:

A CallObservationEndedEv event gets sent to all Call Observers on an address and calls in progress end. The calls get physically connected, but the application observation of the call ends because Cisco Unified JTAPI cannot send call state changes.

A CiscoAddrOutOfServiceEv event gets sent to all addresses on a terminal and a CiscoTermOutOfServiceEv event gets sent to the terminal.

This process repeats for all Terminals in the Provider user-controlled list. (A CiscoAddrOutOfServiceEv event gets sent only to the addresses that have an active AddressObserver, and a CiscoTermOutOfServiceEv event gets sent only to terminals with an active TerminalObserver.)

The provider gets set in the out-of-service state, and the ProvOutOfServiceEv event gets delivered on any ProviderObserver callbacks present on the provider.

Cisco Unified JTAPI attempts a connection to the next CTIManager in the list, and the ProvInServiceEv gets sent to the ProviderObserver. The devices that previously registered under the application control get reinstated in the new CTIManager After the device is reinstated, CiscoAddrInServiceEv and CiscoTermInServiceEv events get sent to the application via the respective Observers. All previously added observers are maintained. If any calls exist on the devices, a snapshot of the call gets sent to the respective CallObservers.

CTI Ports that were previously registered are reregistered with the same media parameters. RouteAddress callbacks are maintained as before, and these calls get recovered on the new CTIManager. No call snapshot, however, gets delivered to the RouteAddresses.

Heartbeats

Cisco Unified JTAPI and the CTIManager maintain heartbeat signals to discover a failure in either the CTIManager or JTAPI. The CTIManager server controls the heartbeat parameters in the bidirectional heartbeat. Applications can request a desired server heartbeat interval when they are initializing Cisco Unified JTAPI, but the CTIManager can override it.

Applications specify the desired heartbeat parameter by using DesiredServerHeartbeatInterval in the jtapi.ini setting.

Cisco Unified JTAPI specifies the desired heartbeat interval for the client during initialization. The CTIManager specifies the client side heartbeat interval to Cisco Unified JTAPI and specifies the interval at which the server (CTIManager) will send heartbeats. A failure to receive heartbeat message for twice the server-specified interval results in a client-initiated teardown of the connection. To minimize heartbeat traffic, any messages from the client to the server or events from the server to the client substitute for a heartbeat.

Display Name Interface

The CiscoCall interface provides methods to get name displays of the calling party and the called party in a call. Applications can use getCurrentCallingPartyDisplayName() to get the display name of the calling party.

JTAPI applications can use the following interface to get the display names of the calling party and the called party.

{
..
..
	/**
	 *This interface returns the display name of the called party in the call.
	 *It returns null if display name is unknown.
	*/
	public String getCurrentCalledPartyDisplayName();

	/**
	 *This interface returns the display name of the calling party.
	 *It returns null if display name is unknown.
	*/
	public String getCurrentCallingPartyDisplayName();
}

The address objects store the display name internally, and the name gets updated when currentCallingAddress and currentCalledAddress are updated. NULL returns if the call is not in the active state and if currentCalling and currentCalled addresses of the call are not initialized.


Note The system does not support Call.getCurrentCalledAddress() and call.getCurrentCallingAddress() for conference calls. Also, the system does not support call.getCurrentCalledPartyDisplayName() and call.getCurrentCallingPartyDisplayName() for a conference call.


SetMessageWaiting Interface

SetMessageWaiting provides a method for applications to set the message-waiting lamp or indicator for an address. Invoke the method on an address that is in the same partition as the destination.

The following interface specifies whether the message waiting indicator should be activated or deactivated for the address that the destination specifies. If enable is true, message waiting activates if not already activated. If enable is false, message waiting deactivates if not already deactivated.

{
public void setMessageWaiting (java.lang.String destination, boolean enable)
	throws		javax.telephony.MethodNotSupportedException,
			javax.telephony.InvalidStateException,
			javax.telephony.PrivilegeViolationException
}

QuietClear

QuietClear occurs at the other end when two parties are on a call, and one address goes OutOfService because of a network outage, the Cisco Unified Communications Manager goes down, the application controlling CTIPort goes down, or CTIManager goes down. At this stage, the other end of the call can only drop the call or disconnect the connection. It cannot perform any other callControl operations.

For the party that went Out Of Service, applications will perceive ConnDisconnectedEv and/or TermConnDroppedEv, and the other end of the call receives ConnFailedEv with CiscoCause of CiscoCallEv.CAUSE_TEMPORARYFAILURE.

If applications try to invoke the following features during QuietClear mode, PlatformException with error code of CiscoJtapiException.CTIERR_OPERATION_FAILER_QUIETCLEAR gets thrown:

Consult transfer

Consult conference

Blind transfer

Hold

Unhold


Note Applications may only drop the call in this mode.


GetCallInfo Interface on Address

GetCallInfo interface on address provides applications with the ability to query CallInfo on an address. A query returns the CiscoAddressCallInfo object, which contains information about the number of active or held calls, maximum number of active or held calls, and the Call object for current calls on the address. This interface also specifies what calls are at a specific address at a specific time.

Use the following interface to get information about calls that are present at the terminal:

{ public CiscoAddressCallInfo getAddressCallInfo(Terminal iterminal);
}

DeleteCall Interface

DeleteCall interface provides applications with the ability to delete a call that was created by using the createCall interface. This method accepts a call and throws an InvalidStateException if a provider is not in service or if the call is not in the IDLE state. DeleteCall moves the call to the INVALID state.

The following interface gets added to CiscoProvider:

{ public void deleteCall( Call call ) throws InvalidStateException;
}

Applications can use this interface to delete the call that was created by using createCall interface. This method accepts a call and throws an InvalidStateException if the provider is not in service or if the call is not in the IDLE state. DeleteCall moves the call to the INVALID state.

To successfully delete a call, the application creates the call by using createCall, and the call should be in the IDLE state.

GetGlobalCallID

GetGlobalCallID provides an interface on the CiscoCallID to get the nodeID and the Global Call ID (GCID) of the call; this exposes the GCID information that is available in the internal call object.

The following methods get added to the CiscoCallID interface:

{	/**
	* returns the callmanager nodeID of the call
	*/
public int getCallManagerID();

	/**
	* returns the GlobalCallID of the call
	*/
public int getGlobalCallID ();
}

GetCallID in RTP Events

GetCallID provides an interface on RTP events to access any call information, such as calling party or called party, so applications can link RTP events with the calls.

The callLegID that is received in the RTP events from CTIManager gets used to determine the ICCNCall on the client side. This call passes on to the JTAPI layer, and the CiscoCall gets determined, from which CiscoCallID is obtained. This information gets used to construct the RTP events that are delivered to the application.

The following interface gets added to CiscoRTPInputStoppedEv, CiscoRTPInputStartedEv, CiscoRTPOutputStoppedEv, and CiscoRTPOutputStartedEv:

{ public CiscoCallID getCallID();
}

XSI Object Pass Through

Applications can pass XML objects through JTAPI and CTI interfaces to the phone. The XML object can contain display updates, softkey update/enable/disable, and other types of updates on the phone that are available through IP phone services features. This allows applications to access IP phone service capabilities through JTAPI and CTI interfaces without maintaining independent connections to the phones.

CiscoTerminal Method

Applications can send an XSI object in the byte format to the Cisco Unified IP Phone through the CiscoTerminal interface method. The system limits the payload to 2000 bytes of data with this interface.

CiscoTerminal must be in the <CODE>CiscoTerminal.REGISTERED</CODE> state; its Provider must be in the <CODE>Provider.IN_SERVICE</CODE> state. Successful response indicates that the data that was pushed has arrived at the phone. However, the application cannot receive any XML, including the CiscoIPPhoneResponse object from the push, back from the phone. If the application request is not successful, a PlatformException is thrown. Any request with more than 2000 bytes of data is rejected.

public String sendData (String terminalData) throws InvalidStateException, MethodNotSupportedException;

Before the application can make use of this feature, it must add TerminalObserver on the Terminal.

Authentication and Mechanism

Sending an HTTP POST request to the phone web server, which requires the phone IP address, performs an object push. The web server parses the request, authorizes the request through the HTTP returned to the Cisco Unified Communications Manager, executes the request, and returns an XML response that indicates the success or failure of the request to the application.

With XSI, the IP phone services object gets sent directly to the phone by the Skinny Client Control Protocol (SCCP). The phone does not authenticate the request, because the JTAPI client is trusted and does not require the phone IP address. For more information on actual XML contents, refer to the Cisco IP Phone Services Application Development Notes.

Cisco VG248 and ATA 186 Analog Phone Gateways

Cisco Unified JTAPI supports control of analog phones that are connected to the Cisco VG248 and ATA 186 Analog Phone Gateways. By adding the Cisco VG248 and ATA 186 Analog Phone Gateways to the user-controlled list, applications can control the devices.

Applications receive events for the devices in a way similar to other IP phones. Applications can also initiate calls and invoke other features except answer Request through APIs. Make call works only when the device goes physically off hook.

Applications cannot answer calls from APIs for the devices. If an application attempts to answer () on TerminalConnection for the VG248 and ATA 186 Terminal, the system throws PlatformException with error CiscoJtapiException.COMMAND_NOT_IMPLEMENTED_ON_DEVICE. To answer calls, you must manually pick up the handset, and then you can invoke other call control features such as transfer, conference, blind transfer, and park from the API.

Multiple Calls Per DN

Multiple calls per DN represents the ability to support multiple calls on a line (DN) and the features operation on these calls. Prior to Cisco Unified Communications Manager Release 4.0(1), the system supported only a maximum of two calls. Cisco JTAPI now supports multiple calls per line, which lets have multiple calls on the same line and feature operation on that line.

No no interface or message flow changes occurred for Multiple Calls Per DN.

Shared Line Support

Shared line represents the same DN appearances on multiple terminals. CiscoJtapi provides support for Shared Line, which provides applications with the ability to control shared DN terminals, hold a call on one shared DN Terminal and unhold the same call from another shared DN Terminal, make calls between two shared lines, initiate a call from one shared line terminal while another active call exists on another shared line terminal with the same DN.

Share line provides the following interfaces:

CiscoAddress.getInServiceAddrTerminals()—Returns an array of terminals for which the address is in service.

Terminal {} getInServiceAddrTerminals();

CiscoAddrOutOfService.getTerminal()—Returns the terminal that is going OutOfService.

Terminal getTerminal();

CiscoAddrInService.getTerminal()—Returns the terminal that is going InService.

Terminal   getTerminal();

CiscoConnection.setRequestController(TerminalConnection tc)—Allows an application to select a terminalConnection that is associated with a connection on which you can perform park, redirect, or disconnect operations. You need to do this in a situation where more than one active TerminalConnection exists in a SharedLine scenario.

CiscoConnection.getRequestController()—Returns TerminalConnection set by application as request controller.

CiscoAddrAddedToTerminalEv—Gets sent when the following conditions occur:

A Terminal/Device gets added into the user controlList that contains a SharedDN, which sends the event to the application. In other words, if user has an address in control list, and a new device gets added with same address in control list, this event gets sent.

An EM (extension mobility) user logs into the terminal with a profile that contains a SharedDN. In this scenario, this event notifies that a new terminal is added to an already existing Address.

A new SharedDN is added to a device in a user control list

Interface getTerminal() returns the terminal that gets added to the address.

Interface getAddress() returns the address on which a new terminal is added.

CiscoAddrRemoveFromTerminalEv—Gets sent when the following conditions occur:

A user removes a Terminal/Device from the user controlList that contains a SharedDN. In other words, if a user has a shared address in a control list, and one of the devices with same address gets removed, this event gets sent.

An EM(extension mobility) user logs out from the terminal that had a profile that contains a SharedDN. This event notifies applications that one of the terminals is removed from an existing Address.

A new SharedDN (SharedLine) is removed from a device in a control list.

Interface getTerminal() returns the terminal that gets removed from the address.

Interface getAddress() returns the address from where the terminal gets removed.

The following are the changed or new behaviors for a SharedLine:

Behavior changes for CiscoAddress event include:

JTAPI applications will receive multiple CiscoAddrInServiceEv for shared line addresses. Applications can use CiscoAddrInServiceEv.getTerminal() to get the terminal on which address goes InService.

JTAPI applications receive multiple CiscoAddrOutOfServiceEv for shared line addresses. Applications can use CiscoAddrInServiceEv.getTerminal() to get terminal on which address goes OutOfService.

The address state goes InService when a first shared line goes InService; for example, when the first CiscoAddressInServiceEv gets received.

The address state goes OutOfService when the last Shared Line goes OutOfService; for example, when the last CiscoAddressOutOfServiceEv gets received.

For an incoming call, all the line appearances of a shared line ring. To applications, this gets presented as one active call (callActiveEv), one Connection(ConnCreatedEv), and multiple terminalConnection(TermConnCreatedEv one each for each shared line).

Calls get presented to all terminals. When a call is in a ringing state, the state of the terminal connection equals Ringing. When a the Shared Line answers, the terminalConnection state goes to an active state, while other terminalConnections on the shared line go to a passive state, and callControlTerminalConnection for all the shared lines at this point go into a bridged state. When a call is put on hold, all the terminal connections go into an active state, and callControllTerminalConnection goes to a held state. At this point, any terminal can retrieve the call. The retrieving terminal terminalConnection remains in an active state, and callControlTerminalConnection goes to a talking state while all other shared terminals terminalConnections go into a passive state. Simultaneously, CallControlTerminalConnection changes from a held state to a bridged state.

A shared line can make a call to another shared line of the same DN. In this scenario, the call includes only one connection and multiple terminal connections.

When a shared line makes a call to another shared line of the same DN, the post condition for this equals only one connection.

For a shared line connection with two active terminalConnections (such as barge), Connection.Disconnect() does not result in disconnected connection.

If an application is monitoring only a SharedDN Connection with only a passive or bridged TerminalConnection, invoking any API on the connection results in a PreConditionException.

Similar to the previous scenario, if all the connections of a Call monitored by an application have only a Passive or Bridged TerminalConnection, all APIs on the call throw a PreConditionException (such as Call.Drop()).

If more than one active TerminalConnection exists on a shared line, Call.drop() does not return in CallInValid in the following scenarios:

A normal two-party call between A and B, where A represents a SharedLine with A' and A' barged into the call

The application does not monitor A' and B. If the application issues a Call.drop(), the A' TerminalConnection goes into a passive state, but the call does not go InValid.

Similar to above, if A, A' , A" and B are in a Conference Call

The application monitors only A and A', and Call.drop() does not result in the call going InValid. Only the A and A' terminal connections go passive.

A, A', and B, B' represent a SharedLine address

A Calls B, B answers, and A' and B' barge into the call. The application monitors only A and B. In this scenario, Call.drop() results in a TerminalConnection of A and B going passive, but the call does not go InValid.

If a TerminalConnection is in a passive or bridged state or Passive/InUse state, all APIs on the TerminalConnection() throw a PreConditionException. A TerminalConnection only allows an API Terminal ConnectionJoin() (called Barge) in the passive or bridged state. TerminalConnection does not currently support TerminalConnection Join().

If more than one active or talking TerminalConnections exists in a connection, applications may have to end one before issuing an API on the connection like Redirect(), Park(), Disconnect(). A TerminalConnection can be selected by using API Connection.setRequestController (TerminalConnection tc).

If a call gets held on SharedLine terminals and an application issues a Connection.Disconnect (), the applications may set a particular TerminalConnection through API Connection.setRequestController(TerminalConnection tc). If requestcontroller is not set, all HeldTerminalConnections get dropped, and connection goes to a disconnected state. If only one HeldConnection gets dropped, the call remains present on other SharedLines terminals. The call appearance disappears from the dropping terminal, which disallows the terminal from barging into the call or participating in feature operations on the call.

For details on the interface changes, see Chapter 4, "Cisco Unified JTAPI Implementation." To view the message flow for shared lines, see Appendix A, "Message Sequence Charts."

Transfer and DirectTransfer

The transfer feature provides the ability to transfer a call.

The direct transfer feature is the ability to transfer any of the two calls present on the line so that controller of the call drops out and other two parties remain active on the call. This functionality gets supported with one enhancement, which is this feature can be done in any state of the call and also redesign to work with new CTI events. The following enhancements apply to the transfer feature:

The application can transfer two held calls.

The application can have OneHeld and OneConnected call in any order.

The application can transfer any two calls present on the line.

The following are the changed or new interfaces for Transfer and DirectTransfer:

CiscoTransferStarted. getTransferControllers()—This new interface, which is provided for SharedLine scenarios, supports multiple terminalConnections if a SharedLine is a TransferController. When a transferController is not a SharedLine, only a TerminalConnection occurs in the list. This method returns null if the transfer controller is not being observed.

CiscoTransferStarted. getTransferController()—This current interface, which behaves as it does for a normal transfer, may exhibit a different behavior for SharedLines. When a transferController is a SharedLine, multiple TerminalConnections exist. This method returns an ACTIVE TerminalConnection, however, if the application is not observing the ACTIVE TerminalConnection, this method returns one of the PASSIVE TerminalConnections.

CiscoTransferEnded isSuccess()—This new interface, which is provided for the CiscoTransferEnded event, returns true if the transfer operation succeeds and false if the transfer fails. Transfer failure may result from the following:

The party dropped the call before CallProcessing could complete the transfer.

CallProcessing cannot Complete the transfer.

The following are changed or new behaviors for JTAPI Transfer.

No Hold or UnHold messages occur with an arbitrary transfer.

If a pre-condition for a transfer request has been modified, an application can issue transfer in any state of the call.

If an application does not have an active TerminalConnection that is passed as an argument, Call.consult() throws a PreConditionException/InvalidArgumentException.

If controller does not have any active TerminalConnection, Call.Transfer() throws a PreconditionException/InvalidArgumentException.

To view the message flow for Transfer and DirectTransfer, see Appendix A, "Message Sequence Charts."

Conference and Join

The Conference Feature provides the ability to conference more than two people into a single Call. Events at CTI layer change and Cisco Unified JTAPI gets enhanced to support the new CTI events.

Join Feature is ability to join multiple calls into one single conference call. This functionality was limited to joining only two calls and called Arbitrary Conference. Now it supports multiple calls. Applications need to pass an array of calls to be conferenced together.

The following are new or changed interfaces for conference and Joining of multiple calls into one conference call:

The following interface allows Join to conference multiple calls into one conference call:

Call.Conference(Call[] otherCalls)


Note A precondition requires that all the otherCalls must have controller as one leg of the call.


The following are new or modified interfaces in CiscoConferenceStartEv:

TerminalConnection getHeldConferenceController()—This interface is useful only for the arbitrary conferencing of two calls and returns only one of the held calls.

TerminalConnection[] getHeldConferenceControllers()—This interface gets all of the held calls when joining multiple calls.

TerminalConnection getTalkingConferenceController()—This interface returns the talking conference controller; however, if no talking conference controller exists when all the calls being joined into conference are held, this interface returns null.

Call getConferencedCall()—This interface returns only one of the many calls going to join into a conference and may not have any meaning for a join conference when more than two calls exist.

New interface in CiscoConferenceEnded event boolean isSuccess():

This interface Returns True or False depending on whether Conference is successful or failed. Application can use interface to find whether Conference is successful. Following are defined as Conference Failure:

If the application issues the request Call.conference(otherCalls[]), this conference would be considered failed if one or more than one calls could join into conference. Applications can use the interface getFailedCalls() to find the failed call.

If no Conference Bridge is available and the conference could not be completed at all. The application can use getFailedCalls() to get a list of calls that could not join the conference.

A party that was being conferenced dropped out before conference could be completed.

An interface on the CiscoConferenceEnded event (Call[] getFailedCalls()) gets all the calls that failed to join the conference when the conference fails.

The following are the new or changed behaviors for Conference:

There will not be a hold or unHold message such as applications see when an arbitrary conference occurs.

An arbitrary conference does not require, as a precondition, that any of the calls be in a talking state. However, all the otherCalls must have a controller as one leg of the call.

Applications can conference two or more held calls into a conference call. In finalCall, the controller automatically gets retrieved to a talking state.

Always include an active call in the request Call.Conference(otherCalls). If an active call is not included in the conference request, the request fails.

If there is no active call at the controller, the Call.Conference(otherCalls) request remains successful. However if one active call exists, it the request must include it, as previously stated.

If the application does not have an active TerminalConnection passed as an argument, Call.consult() throws a PreConditionException/InvalidArgumentException.

If the controller does not have an active TerminalConnection, Call.Conference()/Call.Conference(Call[]) throws a PreconditionException/InvalidArgumentException.

For details on the interface changes, see Chapter 4, "Cisco Unified JTAPI Implementation." To view the message flow for conference and join, see Appendix A, "Message Sequence Charts."

Barge and Privacy Event Notification

The Barge Feature provides the ability for Shared Addresses to Barge into an established Call of Address on another terminal. This feature gets activated when an address TerminalConnection is in the Passive State and CallCtlTerminalConnection is in the Bridged State. This version of Cisco Unified JTAPI only supports feature activation manually on application-controlled terminals (IP phones). For this release, the feature can not be activated through an API.

The Privacy feature provides the ability to enable or disable other shared addresses to barge into call. When privacy is enabled, other shared addresses cannot barge into a call and vice versa. Privacy is a terminals property. IP phones have a "Privacy" softkey and pressing it enables or disables the privacy. Privacy can be dynamically enabled or disabled for the active calls on the terminal. When Privacy is on for the call, the TerminalConnection for the call appearances on the shared address appear in the "InUse" state. If privacy status changes during the CallProgress, CiscoTermConnPrivacyChangedEvent gets delivered to the application.

There are two types of Barge feature functionalities provided in Cisco Unified Communications Manager: one uses built-in Conference Bridge called "Barge", while another uses Shared Conference Bridge resources called "CBarge". From the application point of view, there are no interface changes between Barge and CBarge, however, there are some behavioral changes, which are described in the message flow diagram in Appendix A, "Message Sequence Charts."

Barge, CBarge, and Privacy have these interfaces:

Interface CiscoTerminalConnection.getPrivacyStatus()

boolean getPrivacyStatus()

This interface returns the privacy status of a call on the terminal.

Interface CiscoTermConnPrivacyChangedEv

javax.telephony.TerminalConnection getTerminalConnection()

A new reason code, CiscoCall.CAUSE_BARGE gets added to CiscoCall for Barge events.

JTAPI provides CallCtiCause as CiscoCall.CAUSE_BARGE when a SharedLine TerminalConnection or CallCtiTerminalConnection goes to an active or talking state as a result of barge. This cause code also gets provided in CallCtiEvents for dropping temporary calls that are created during the barge operation.

This cause code is not provided for the CBarge scenario.

For details on these interfaces , see Chapter 4, "Cisco Unified JTAPI Implementation." To view the message flow for barge, CBarge, and privacy, see Appendix A, "Message Sequence Charts."

CallSelect and UnSelect Event Notification

You can select or unselect call on a phone for doing DirectTransfer or join or any other feature operation. When a SharedLine user selects a call, the RemoteInUse shares line TerminalConection will go passive, and CallCtlTermiCallConnection goes in InUse state. When call is unselected, CallCtlTerminalConnection goes into a bridged state. An application cannot invoke any API on Passive/InUse TerminalConnection. CallProcessing also performs a Select/UnSelect operation during features (such as transfer/conference) operation. Applications will also see these events if the RemoteInUse terminal is monitored by applications.

For example, if A and A' are SharedLine, and A selects the call, CallCtlTerminalConnection of A' goes into a passive or InUse state. If A "UnSelects" the call, the CallCtlTerminalConneciton of A' goes into the passive or bridged state.

To view the message flow for CallSelect or UnSelect, see Appendix A, "Message Sequence Charts."

Dynamic CTIPort Registration

This feature lets applications provide an IP address (ipAddress) and port number (portNumber) for each call or whenever media is established. To use this feature, applications must register the media terminal by supplying media capabilities. When a call is answered at this media terminal, CiscoMediaOpenLogicalChannelEv is sent to applications. This event gets sent whenever media is established. Applications must react to this event and specify the IP address and port number where media gets established.

A CiscoMediaTerminal is a special kind of CiscoTerminal that allows applications to terminate RTP media streams. Unlike a CiscoTerminal, a CiscoMediaTerminal does not represent a physical telephony endpoint, which is observable and controllable in a third-party manner. Instead, a CiscoMediaTerminal is a logical telephony endpoint, which may be associated with any application that terminates media. Such applications include voice messaging systems, interactive voice response (IVR), and softphones.


Note Only CTIPorts appear as CiscoMediaTerminals through Cisco Unified JTAPI.


Terminating media is a two-step process. To terminate media for a particular terminal, an application adds an observer that implements the CiscoTerminalObserver interface by using the Terminal.addObserver method. Finally, the application registers its IP address and port number to which the terminal incoming RTP streams are directed using the CiscoMediaTerminal.register method.

To register the ipAddress and portNumber dynamically on a per-call basis, applications must register by only providing capabilities that they support. Applications must react to CiscoMediaOpenLogicalChannelEv that gets sent whenever media is established. If any features are performed before applications react to CiscoMediaOpenLogicalChannelEv, the features may fail.

If the applications do not respond to this event during the time that is specified in the Media Exchange Timer in the Cisco Unified Communications Manager Administration windows, the call may fail.

For details on the interface changes, see Chapter 4, "Cisco Unified JTAPI Implementation." To view the message flow for Dynamic CTIPort Registration Per Call, see Appendix A, "Message Sequence Charts."


Note The ChangeRTPDefaults interface is not supported on CiscoMediaTerminal.


The following are the new or changed interfaces for Dynamic CTIPort Registration Per Call:

Interface CiscoMediaOpenLogicalChannelEv Extends CiscoTermEv

int

getpacketSize()

Returns the packet size of the far end in milliseconds.

int

getPayLoadType()

Returns the payload format of the far end, one of the following constants:

CiscoRTPHandle

getCiscoRTPHandle ()

Returns the CiscoTerminalConnection object on which applications must invoke the setRTPParams request.


Interface CiscoRTPHandle

int

getHandle()

Returns an integer representation of this object, currently the Cisco Unified Communications Manager CallLeg ID.


CiscoProvider

CiscoCall

getCall (CiscoRTPHandle rtpHandle)

Returns the call object with the rtpHandle that is associated with a specific terminal. If no callobserver gets added to the terminal at the time when the applications receive CiscoRTPHandle in CallOpenLogicalChannelEv, CiscoCall may be null.


Media Termination at Route Point

This feature enables multiple active calls at the route point, and applications can terminate media for all active calls by specifying the IP address and port number for each call or whenever media is established.
To use this feature, applications must register the route point by supplying media capabilities. When a call gets answered at this route point, CiscoMediaOpenLogicalChannelEv gets sent to the applications. This event gets sent whenever media is established. Applications must react to this event and specify the IP address and port number to where they want to terminate media.

A CiscoRouteTerminal is a special kind of CiscoTerminal that allows applications to terminate RTP media streams. Unlike a CiscoTerminal, a CiscoRouteTerminal does not represent a physical telephony endpoint, which is observable and controllable in a third-party manner. Instead, a CiscoRouteTerminal represents a logical telephony endpoint, which may be associated with any application that desires to route calls and also terminate media. Unlike CiscoMediaTerminal, CiscoRouteTerminal can have multiple active calls at the same time. Typically, CiscoRouteTerminals get used to place calls in queue until an agent is available to service the caller.


Note Only RoutePoint Terminals appear as CiscoRouteTerminal through JTAPI.


Terminating media is a three-step process.


Step 1 The application registers its media capabilities with this terminal by using the CiscoRouteTerminal.register method.

Step 2 An application adds an observer that implements CiscoTerminalObserver interface by using the Terminal.addObserver method.

Step 3 The application must add addCallObserver on CiscoRouteTerminal or on CiscoRouteAddress to receive CiscoCall object from the provider by using CiscoRTPHandle.


Applications receive CiscoMediaOpenLogicalChannelEv for each call and must supply the IP address and port number by using the setRTPParams method on CiscoRouteTerminal.

Applications written for the CiscoJtapiClient 1.4(x) release or earlier must be modified to register with CiscoRouteTerminal.NO_MEDIA_TERMINATION if the applications are not interested in media termination.

Multiple applications can register with the same route point as long as they are registered with the same media capabilities and registrationType. All applications, if they have registered with CiscoRouteTerminal.DYNAMIC_MEDIA_REGISTRATION and then add a terminal observer, receive CiscoMediaOpenLogicalChannelEv, but only one application can invoke setRTPParams.


Note Applications that terminate media must use the CallControl package for answering and redirecting calls. Applications that only route calls can use a routing package.



Note Applications should be aware that if any features are performed before reacting to CiscoMediaOpenLogicalChannelEv, the features may fail. If applications do not respond to these events in the time specified in the Media Exchange Timeout parameter in the Cisco Unified Communications Manager Administration windows, the call may fail.


The following are the new or changed interfaces for Media Termination at Route Point:

Interface CiscoRouteTerminal Extends CiscoTerminal

boolean

isRegistered()

If the CiscoMediaTerminal gets registered, this method returns true. Otherwise, it is false.

boolean

isRegisteredByThisApp()

If the application issues a successful registration request, this method returns true and remains true until the application unregisters the device. This remains valid even if the device is out of service because of CTIManager failure.

void

register (CiscoMediaCapability[] capabilities, int registrationType)

The CiscoRouteTerminal must be in the CiscoTerminal.UNREGISTERED state, and the provider must be in the Provider.IN_SERVICE state.

void

setRTPParams (CiscoRTPHandle rtphandle, CiscoRTPParams rtpParams)

Applications set the ipAddress and the RTP port number to dynamically stream media for a call.

void

Unregister()

The CiscoRouteTerminal must be registered, and the provider must be in the Provider.IN_SERVICE state.


Interface CiscoMediaOpenLogicalChannelEv Extends CiscoTermEv

int

getpacketSize()

Returns the packet size of the far end in milliseconds.

int

getPayLoadType()

Returns the payload format of the far end, one of the following constants:

CiscoRTPHandle

getCiscoRTPHandle ()

Returns the CiscoTerminalConnection object on which applications must invoke the setRTPParams request.


Interface CiscoRTPHandle

int

getHandle()

Returns an integer representation of this object, currently the Cisco Unified Communications Manager CallLeg ID.


CiscoProvider

CiscoCall

getCall (CiscoRTPHandle rtpHandle)

Returns the call object with the rtpHandle hat is associated with a specific terminal. If no callobserver gets added to the terminal at the time when the applications receive CiscoRTPHandle in CallOpenLogicalChannelEv, CiscoCall may be null.


For details on these interfaces, see Chapter 4, "Cisco Unified JTAPI Implementation." To view the message flow for media termination at route point, see Appendix A, "Message Sequence Charts."

Redirect Set Original Called ID

Cisco Unified JTAPI applications can specify the preferred original called party DN in the redirect request. The Redirect Set Original Called ID feature lets applications redirect a call on a connection to another destination while letting the applications set the OriginalCalledID to any value. This enables applications to transfer the call directly to another user's voice mail. For example, if A calls B and B wants to transfer the call to C VoiceMail, applications can specify in the enhanced redirect request C as the preferred original called party and destination party as C VoiceMail profile. With this request, calls appear in C VoiceMail profile with the Cisco Unified Communications Manager originalCalledParty field as C. Typical voice mail applications look for originalCalledParty information to identify a user voice mailbox.

Any application that redirects a call to a party by modifying the original called party can take advantage of this feature.


Note This feature also changes the lastRedirectedAddress to the preferredOriginalCalledParty that gets specified in the redirect request.


Below is the callControlConnection interface for Redirect Set Original Called ID:

Interface CiscoConnection Extends callControlConnection With Additional Cisco Unified Communications Manager-Specific Capabilities

javax.telephony.Connection

redirect (java.lang.String destinationAddress, int mode, int callingSearchSpace,
java.lang.String preferredOriginalCalledParty)

This method overloads the CallControlConnection.redirect() method.


For details on the interface, see Chapter 4, "Cisco Unified JTAPI Implementation." To view the message flow for Redirect Set Original Called ID, see Appendix A, "Message Sequence Charts."

Single Step Transfer

This interface allows applications to transfer a call to an address. Cisco Unified JTAPI continues to support this interface as defined in JTAPI 1.2 specification, but the events that are delivered to applications are changed from the previous versions of Cisco Unified JTAPI.

In previous versions of Cisco Unified JTAPI, the original call goes to a held state and a new call gets created between the transfer controller and destination when applications use this interface. After successful completion of transfer, both calls on transfer controller go to an IDLE state. If a transfer fails, the original call remains in a held state, and applications retrieve the call. CiscoTransferStart and end events get delivered to the applications at the start and completion of the transfer operation.

Applications get the following changes:

A new call is not created.

CiscoTransferStartEv and CiscoTransferEndEv are not delivered to applications.

The state of the original call is retained if the transfer operation fails.

The pre and post conditions of this interface did not change.

To view the message flow for Single Step Transfer, see Appendix A, "Message Sequence Charts."

Auto Update of API

When the Cisco Unified Communications Manager is upgraded to a higher version, the APIs may or may not be compatible with the new Cisco Unified Communications Manager version. The APIs must be upgraded to a compatible version so the applications work as expected. Because the APIs are installed locally on the client server, the upgrade must take place on multiple machines. In the case of fewer client applications, you can easily do this by connecting to the Cisco Unified Communications Manager Administration and downloading and installing the Cisco Unified Communications Manager compatible plug-in.

For multiple client applications, this feature provides a facility by which an application at startup can identify itself to a web server via an HTTP request and receives a response with the version of the required JTAPI API.

The application compares the version that is available on the server to the local version in the application classpath and determines whether an upgrade is necessary. This allows applications to refresh the jtapi.jar component to match the Cisco Unified Communications Manager and provides a way to centrally deploy the jtapi.jar to which applications can auto update.

The API that is required to perform this functionality is packaged in the form of an updater.jar. The jtapi.jar and updater.jar are packaged with the standard manifest, which can be used to compare versions.


Note This feature does not update JTAPI Preferences, JTAPITestTools, Updater.jar and javadoc components. If applications require these components, install JTAPI from the Cisco Unified Communications Manager plug-in pages. Auto Update supports JTAPI Release 2.0 and later.


Refer to Chapter 3, "Cisco Unified JTAPI Installation" for more information.

The following are new or changed interfaces for autoupdate of APIs:

Class com.cisco.services.updater.ComponentUpdater

Component

queryLocalComponentVersion (java.lang.String componentName, 
java.lang.String path)

Throws an IOException, IllegalArgumentException.

Component

queryServerComponentVersion (java.lang.String componentName, 
java.lang.String urlString)

Throws an IOException, IllegalArgumentException, and sends an HTTP query to the server to determine the remote server installed components version.


Interface com.cisco.services.updater.Component

int

compareTo (Component otherComponent)

Component

fetchFromServer()

Performs an HTTP fetch of the component from the server and writes to the local file system with the file name temp.jar in the local directory.

java.lang.String

getBuildDescription ()

Returns the string 'Release' for a version of the form 'a.b(c.d) Release'.

int

getBuildNumber ()

Returns 'd' for a version of the form a.b(c.d).

java.lang.String

getLocation ()

The string form location of the component.

int

getMajorVersion ()

Returns 'a' version for a version of the form a.b(c.d).

int

getMinorVersion ()

Returns 'b' version for a version of the form a.b(c.d).

java.lang.String

getName ()

Returns the name of the component.

int

getRevisionNumber ()

Returns 'c' for a version of the form a.b(c.d).


The Autoupdater feature in JTAPI also allows applications to download the latest version of JTAPI.JAR directly from the Cisco Unified Communications Manager.

1. Updater creates a newjtapi.jar file in the current folder of the application, which is the new version of the jar file that was downloaded from the Cisco Unified Communications Manager.

2. Updater copies the current jtapi.jar to a file that is named component.temp in the classpath specified.

3. Updater replaces the current jtapi.jar file with the new jtapi.jar file.

At the end of this operation, the current jar file becomes component.temp and the new jar file becomes jtapi.jar. This operation is supported for both Linux and Windows.

Example usage of Autoupdater.

Command Line : java com.cisco.services.updater.ComponentUpdater <server> <component name> 
<login> <passwd>
Component localComponent, downloadedComponent;
ComponentUpdater updater = new ComponentUpdater();
String localPath = updater.getLocalComponentPath(args[1]);
localComponent = updater.queryLocalComponentVersion("jtapi.jar",localPath);
localComponent.copyTo("component.temp");
String provString = args[0] + ";login=" + args[2] + ";passwd=" + args[3];

CiscoJtapiPeer peer = (CiscoJtapiPeer) (JtapiPeerFactory.getJtapiPeer(null));
CiscoJtapiProperties tempProp = ( (CiscoJtapiPeerImpl) (peer)). getJtapiProperties();
tempProp.setLightWeightProvider(true);

Provider provider = peer.getProvider(provString);
String url = ( (CiscoProvider) (provider)).getJTAPIURL(); provider.shutdown();
Component serverComponent = updater.queryServerComponentVersion("jtapi.jar", url);

downloadedComponent = serverComponent.fetchFromServer();
int retVal = downloadedComponent.replaces(localComponent);

The "replaces" API will replace the existing JTAPI version with the new version.


Note The updater will only update the JTAPI.JAR file and not the other sample applications and Cisco JTAPI documentation that are bundled with the JTAPI plug-in. To get these other components, applications must download the plug-in from the Cisco Unified Communications Manager and install it.


Changes in DeviceType Name Handling

Currently, TSP hardcodes the DeviceTypeName depending on the DeviceType. When a new device type is added, we have to manually add the new device type name to the list of supported devices. Because CTI does not fetch and store the device type name in its cache, TSP cannot get this info from CTI. TSP needs to update the device type name when a new device type is added without any manual intervention.

In JTAPI, the changes have been made to ensure that QBE interface is changed to handle the receive devicetypename that is sent from CTI and is stored in the deviceInfo structure. It is not used anywhere in JTAPI and will not be exposed to applications. Only the QBE interface changed as follows:

public DeviceRegisteredEvent ( String deviceName, int deviceType, boolean 
allowsRegistration, int deviceID, boolean loginAllowed, UnicodeString userID, boolean 
controlled, int reasonInt, int registrationType, int unicodeEnabled,int locale,

// added for deviceTypeName change 
String devTypeName) {

public DeviceUnregisteredEvent ( String deviceName, int deviceType, boolean 
allowsRegistration, int deviceID, UnicodeString userID, boolean controllableBool, int 
reasonInt , int locale,
//added for devtypename support
String devTypeName) {

CiscoTerminal Filter and ButtonPressedEvents

Prior to the JTAPI 2.0 release, Cisco Unified JTAPI applications did not have direct control over Terminal events. Applications can now receive button pressed events by setting the appropriate filter in the terminal observer. Applications no longer need to add call observer to get RTP events.

When setButtonPressedEv gets enabled using CiscoTermEvFilter, applications receive CiscoTermButtonPressedEv when a digit gets pressed on the phone.

The following are the new or changed interfaces for CiscoTerminal Filter and ButtonPressedEvents:

CiscoTerminal

void

setFilter (CiscoTermEvFilter terminalEvFilter)

Allows an application to have more control over the events that get delivered to the TerminalObserver.


CiscoTermEvFilter

boolean

getButtonPressedEnabled()

Gets the enable or disable status of the button-pressed events for the terminal. The default value is disabled.

boolean

getDeviceDataEnabled()

Gets the enable or disable status of the device data events for the terminal. The default value is disabled.

boolean

getRTPEventsEnabled()

Gets the enable or disable status of the RTP events for the terminal. The default value is disabled.

void

setButtonPressedEnabled (boolean enabled)

Enables or Disables the button pressed events for the terminal.

void

setDeviceDataEnabled (boolean enabled)

Enables or Disables the device data status events for the terminal.

void

setRTPEventsEnabled (boolean enabled)

Enables or Disables the RTP events for the terminal.


CiscoTermButtonPressedEv

int

getButtonPressed ()

For details on the interface changes, see Chapter 4, "Cisco Unified JTAPI Implementation." To view the message flow for CiscoTerminal Filter and ButtonPressedEvents, see Appendix A, "Message Sequence Charts."

Modifying Calling Number

This feature enables applications to modify the calling party DN in the select route API from the route point. Applications may pass an array of modifying calling numbers in the selectRoute API and an array length of modifying calling numbers may be equal to the length of the route selected. If there is no modifying calling number element present for a corresponding routeSelected index or if the element is null, then no modifying calling number gets set for that route selected element.

Two new interfaces getModifiedCallingAddress () and getModifiedCalledAddress () are exposed on the call object, which returns modified calling or called number. If there is no modification, these interfaces may return the same values as getCurrentCallingAddress () and getCurrentCalledAddress () interfaces. If an application is only controlling the route point and modifies the calling number using selectRoute API, it may not get modified calling address in the getModifiedCallingAddress interface. If an application is controlling any of calling or called parties, it may get correct values once it receives call control events after the calling number is modified.

A new interface, getRouteSelectedIndex (), exposed on the new class CiscoRouteUsedEvent, an extension of RouteUsedEvent, which gives the index of the selected route. Applications need to cast the RouteUsedEvent to the CiscoRouteUsedEvent in order to get access to this method.

Example


routeSelected[0] = 133555 
routeSelected[1] = 144911 
routeSelected[2] = 143911 
routeSelected[3] = 5005   

modifiedCallingNumber[0] =null
modifiedCallingNumber[1] =9721234567
modifiedCallingNumber[2] =9721234568
modifiedCallingNumber[3] =null

If routeSelected[0] or routeSelected[3] is selected for routing, the modifying calling number may not be applied.

You can only use this feature after an administrator enables the modifying calling number check box in the Cisco Unified Communications Manager Administration for a particular user, which by default is False. If it is not configured, a RerouteEvent with the cause of RouteSession.CAUSE_PARAMETER_NOT_SUPPORTED gets sent to the applications. The application that is modifying the calling number needs to be aware that display name on the called party is affected, and subsequent feature interactions of the calling or called party may result in inconsistent behavior.

The following are new or changed interfaces for Modifying Calling Number:

CiscoRouteSession

void

selectRoute (java.lang.String[] routeSelected, int callingSearchSpace, 
String[] modifiedCallingNumber)

This interface allows applications to modify the calling party number to the routeSelected address. If no modifiedCallingNumber element exists for the corresponding routeSelected element, the calling number does not get modified if a call gets routed to that particular routeSelected element.


CiscoCall

javax.telephony.Address
getModifiedCalledAddress ()

This interface returns a modified called address for the call if an application modifies the calling party using the selectRoute API. However, this information may not be accurate if an application is only controlling the route point that modifies the calling number. If no modified calling number gets performed, this is similar to the getCurrentCalledAddress interface. Typically, this gets varied from getCurrentCalledAddress when a feature gets invoked after modified calling number modifications.

javax.telephony.Address
getModifiedCallingAddress ()

This interface returns a modified calling address for the call if an application modifies the calling party using the selectRoute API. However, this information may not be accurate if an application is only controlling the route point that modifies the calling number. If no modified calling number gets performed, this interface is similar to the getCurrentCallingAddress interface.


CiscoRouteUsedEvent

int

getRouteSelectedIndex ()

This method returns an array index of the route to where the call gets routed.


For details on the interface changes, see Chapter 4, "Cisco Unified JTAPI Implementation." To view the message flow for Modifying Calling Number, see Appendix A, "Message Sequence Charts."

AutoAccept Support for CTIPort and RoutePoint

This feature provides applications the ability to enable or disable AutoAccept for the addresses on CTIPorts and Route Points. When AutoAccept status changes for the address, Cisco Unified JTAPI provides the event to inform the application for changes.


Note The maximum number of lines supported for route points equals 34.


The new interface setAutoAcceptStatus(), provided on the CiscoAddress object, allows the capability to set AutoAccept to ON or OFF. Interface getAutoAcceptStatus(), also provided on the CiscoAddress object, allows applications to query the current status of AutoAccept on the address.

When AutoAccept status changes for the address, applications get CiscoAddrAutoAcceptStatusChangedEv on AddressObservers. This event includes the interface getTerminal(), which returns the terminal on which the AutoAccept status gets changed, and the interface getAutoAcceptStatus(), which returns integers that specify whether AutoAccept is ON or OFF. If an address observer is not added, the event does not get provided.

The following interfaces support AutoAccept on CTIPort and RoutePoint:

CiscoAddress

int

getAutoAcceptStatus (javax.telephony.Terminal terminal)

Ciscoaddress.getAutoAccept(Terminal iterminal) returns an AutoAccept status of address on terminal.

void

setAutoAcceptStatus (int autoAcceptStatus, 
javax.telephony.Terminal terminal)

This allows an application to enable AutoAccept for addresses on the CiscoMediaTerminal and or the CiscoRouteTerminal.


CiscoAddrAutoAcceptStatusChangedEv

Public interface: CiscoAddrAutoAcceptStatusChangedEv

Extends com.cisco.jtapi.exension.CiscoAddrEv

The CiscoAddrAutoAcceptStatusChangedEv event gets sent to applications whenever AutoAccept status for the address on the terminal gets changed. If an address has multiple terminals, this event gets sent for the address AutoAccept status on each individual terminals.

This event provides the following interface:

int

getAutoAcceptStatus ()

CiscoAddrAutoAcceptStatusChangedEv.getAutoAcceptStatus returns the following value of AutoAccept status of address on terminal CiscoAddress.AUTOACCEPT_OFF CiscoAddress.AUTOACCEPT_ON.

com.cisco.jtapi. 
extensions.CiscoTerminal
getTerminal ()

Returns the terminal at which this address AutoAccept status gets changed.


For details on the interface changes, see Chapter 4, "Cisco Unified JTAPI Implementation." To view the message flow for AutoAccept on CTIPort and RoutePoint, see Appendix A, "Message Sequence Charts."

CiscoTermRegistrationFailed Event

This event gets provided to the application when CiscoMediaTerminal or CiscoRouteTerminal registration fails asynchronously. Usually when registration fails, the application gets a CiscoRegistrationFailedException. However, it is possible that the registration request was successful, but the registration was rejected by the CTI. This event is provided for the cases where the registration request is successful, but the registration gets rejected. The application should have TerminalObserver to receive this event. Upon receipt of this event, the applications should reregister with the new parameter depending on the error code that is provided for this event.

The following list provides the errors that get returned and the actions to take, by the application, to resolve them.

Error Message    CiscoTermRegistrationFailedEv.MEDIA_CAPABILITY_MISMATCH

Explanation    Registration cannot get done because the terminal is already registered. Do the second registration with the same media capability.

Recommended Action    Try reregistering with the same capability.

Error Message    CiscoTermRegistrationFailedEv.MEDIA_ALREADY_TERMINATED_NONE

Explanation    Registration cannot get done because the terminal is already registered with media termination type 'none'.

Recommended Action    Try reregistering with media termination type 'none'.

Error Message    CiscoTermRegistrationFailedEv.MEDIA_ALREADY_TERMINATED_STATIC

Explanation    Registration cannot get done because the terminal is already registered with static media termination. For static registration, the second registration is not allowed.

Recommended Action    Wait until the terminal UnRegisters.

Error Message    CiscoTermRegistrationFailedEv.MEDIA_ALREADY_TERMINATED_DYNAMIC

Explanation    Registration cannot get done because the terminal is already registered with dynamic media termination.

Recommended Action    Try reregistering with dynamic media termination.

Error Message    CiscoTermRegistrationFailedEv.OWNER_NOT_ALIVE

Explanation    When trying to register the terminal, registration gets in a race condition.

Recommended Action    Try reregistering the terminal.


The following interface is defined for this event:

int

getErrorCode ()

Returns the errorCode for this exception.


There are no changes in the message flow.

SelectRoute Interface Enhancement

The SelectRoute interface gets enhanced to take the parameters "PreferredOriginalCalledNumber" and "PreferredOriginalCalledOption." This enables applications to reset the OriginalCalled value to a specified "PreferredOriginalCalledNumber" when the call gets routed. This interface takes a list of "PreferredOriginalCalledNumber," "PreferredOriginalCalledOption," and corresponds them to the "RouteSelected" list. If the call gets routed to Route at index "I" in the RouteSelected list, the PreferredOriginalCalledNumber and PreferredOriginalCalledOption at index "I" get used. Applications get the following behavior with different values for these parameters.


Note Below x, point to the index where the call is being routed. For example, if the call gets routed to Route n, then value of x will be n. If a PreferredOriginalCalledOption at index x is invalid or out of range, JTAPI defaults it to CiscoRouteSession.DONOT_RESET_ORIGINALCALLED, and if PreferredOriginalCalledOption is null, all the routing gets done with option CiscoRouteSession.DONOT_RESET_ORIGINALCALLED.


When PreferredOriginalCalledOption[x] is set to CiscoRouteSession.RESET_ORIGINALCALLED

If RouteSelected list contains Routes R1, R2 .. Rn, and preferredOriginalCalled list contains O1, O2, ... On, if R1 is available, then call will be routed to R1, and OriginalCalledNumber will be set to O1; if R1 is busy and R2 is available, then call will be routed to R2, and OriginalCalledNumber will be set to O2 ... and so on.

If RouteSelected list contains Routes R1, R2 .. Rn, and preferredOriginalCalled list contains O1, O2, ... Om, and m < n, if R1 is available, the call will be routed to R1, and preferredOriginalCalled will be set to O1; if R1 is busy and R2 is available, the call will be routed to R2, and OriginalCalledNumber will be set to O2 and so on until m. From Route m+1, if Rm+1 is available, the call will be routed to Rm+1, and OriginalCalledNumber will be set to Rm+1, and so on. Lastly, if Rn is available, the call gets routed to Rn, and OriginalCalledNumber gets set to Rn".

If RouteSelected list contains Routes R1, R2 .. Rn, and preferredOriginalCalled list is NULL, then if R1 is available, the call will be routed to R1, and OriginalCalledNumber will be set to R1; if R1 is busy and R2 is available, the call will be routed to R2, and OriginalCalledNumber will be set to R2 ... and so on.

When PreferredOriginalCalledOption[x] is set to CiscoRouteSession.DONOT_RESET_ORIGINALCALLED

If RouteSelected list contains Routes R1, R2 .. Rn, and preferredOriginalCalled list contains O1, O2,.. On, the call will be routed to one of the available routes, and the OriginalCalledNumber will remain unchanged.

If RouteSelected list contains Routes R1, R2 .. Rn, and preferredOriginalCalled list contains O1, O2, ... Om, and m < n, the call will be routed to one of the available routes, and the OriginalCalledNumber will remain unchanged.

If RouteSelected list contains Routes R1, R2 .. Rn, and preferredOriginalCalled list is NULL, the call will be routed to one of the available routes and OriginalCalledNumber will remain unchanged.


Note When OriginalCalled gets set to PreferredOriginalCalled, LastRedirectingParty number also gets reset to PreferredOriginalCalled.


The following are new or changed interfaces for SelectRoute Interface Enhancement:

int

selectRoute (java.lang.String[] routeSelected, int 
callingSearchSpace, java.lang.String[] 
preferredOriginalCalledNumber, int[] 
preferredOriginalCalledOption)

Selects one or more possible destinations for routing a call.


PreferredOriginalCalledOption takes one of the following values:

static int

DONOT REESET_ORIGINALCALLED 

Optional parameter value for PreferredOriginalCalledOption that specifies not to reset OriginalCalled.

static int

REESET_ORIGINALCALLED 

Optional parameter value for PreferredOriginalCalledOption that resets OriginalCalled to preferredOriginalCalledNumber.


For details on the interface changes, see Chapter 4, "Cisco Unified JTAPI Implementation." To view the message flow for SelectRoute Interface Enhancement, see Appendix A, "Message Sequence Charts."

Presentation Indicator (PI) for the Call

The presentation indicator on a call provides the application with the ability to hide or reveal Calling/Called/CurrentCalling/CurrentCalled/LastRedirecting parties name and number to the end user. JTAPI provides get functions on CiscoCall to get PI value for the party. Use this PI info to present the parties information to the end user. These get functions return a value of true or false. A value of "True" indicates that presentation in "Allowed," and a value of "False" indicates the presentation is "Restricted."

For a conference call, the interfaces on CiscoCall do not return a correct value. Applications must iterate through all the connections in the call to get the PI value that is associated with the address for which the connection gets created. The interface provided on CiscoConnection is getAddressPI().

The following new interfaces provided on CiscoCall retrieve PI values:

CiscoCall

boolean

getCalledAddressPI()

Returns the PI that is associated with getCalledAddressPI. If it returns true, the application displays the address name. If it returns false, the application must not display the address name.

boolean

getCallingAddressPI()

Returns the PI that is associated with getCallingAddressPI. If it returns true, the application displays the address name. If it returns false, the application must not display the address name.

boolean

getCurrentCalledAddressPI()

Returns the PI that is associated with CurrentCalledAddressPI. If it returns true, the application displays the address name. If it returns false, the application must not display the address name.

boolean

getCurrentCalledDisplayNamePI()

Returns the PI that is associated with CurrentCalledDisplayNamePI. If it returns true, the application displays the address name. If it returns false, the application must not display the address name.

boolean

getCurrentCallingAddressPI()

Returns the PI that is associated with getCurrentCallingAddressPI. If it returns true, the application displays the address name. If it returns false, the application must not display the address name.

boolean

getCurrentCallingDisplayNamePI()

Returns the PI that is associated with getCurrentCallingDisplayNamePI. If it returns true, the application displays the address name. If it returns false, the application must not display the address name.

boolean

getLastRedirectingAddressPI()

Returns the PI that is associated with getLastRedirectingAddressPI. If it returns true, the application displays the address name. If it returns false, the application must not display the address name.


The following interface on CiscoConnection retrieves the PI value for the address that is associated with the connection:

CiscoConnection

boolean

getAddressPI()

Returns the PI that is associated with the address on which the connection gets created. If it returns true, the application displays the address name. If it returns false, the application must not display the address name.


There is no change in the message flow.

Progress State Converted to Disconnect State

If an outbound call is initiated through the API to an unallocated directory number across the European PSTN, the application will see the ConnFailedEv event with the cause as CiscoCallEv.CAUSE_UNALLOCATEDNUMBER. For the US PSTN, the application may not see any event.

To make the behavior consistent across the European and American PSTNs and also to address backward compatibility issues, a new service parameter UseProgressAsDisconnectedDuringErrorEnabled was added to the jtapi.ini file starting with JTAPI Version 1.4(3.21), which, when enabled (1=enable; 0=disable; the default is disable), causes applications to see ConnFailedEv in both cases.

Device State Server

The Device State server provides the cumulative state of all the addresses on a terminal. These events are delivered as TerminalEvent. Applications need to add TerminalObserver to get these events.

The states are:

IDLE—If no calls exist on any of the addresses on the terminal, then the DeviceState is considered IDLE, and Cisco Unified JTAPI sends CiscoTermDeviceStateIdleEv to applications.

ACTIVE—If any of the addresses on the terminal have an outgoing call (in CTI State Dialtone, Dialing, Proceeding, Ringback, or Connected) or an incoming call (in CTI State Connected), then the DeviceState is ACTIVE, and Cisco Unified JTAPI sends CiscoTermDeviceStateActiveEv to the application.

ALERTING—If none of the addresses on the terminal has an outgoing call (in CTI State Dialtone, Dialing, Proceeding, Ringback, or Connected) or an incoming call (in CTI State Connected) and at least one of the addresses on the terminal has an unanswered incoming call (in CTI State Offering, Accepted, or Tinging), then the DeviceState is ALERTING, and Cisco Unified JTAPI sends CiscoTermDeviceStateAlertingEv to the application.

HELD—If all the calls on any of the address on the terminal are held (in CTI State OnHold) the DeviceState is HELD and Cisco Unified JTAPI sends CiscoTermDeviceStateHeldEv to the application.

New Events

CiscoTermDeviceDeviceStateIdleEv

CiscoTermDeviceStateActiveEv

CiscoTermDeviceStateAlertingEv

CiscoTermDeviceStateHeldEv

New and Changed Interfaces

public int getDeviceState() returns the device state of the terminal.

The following new interfaces on CiscoTermEvFilter set and get the device state:

void

setDevideStateActiveEvFilter(boolean filterValue)

Enables and disables the CiscoTermDeviceStateActiveEv filter.
The default value is disable.

void

setDeviceStateAlertingEvFilter(boolean filterValue)

Enables and disables the CiscoTermDeviceAlertingEv filter.
The default value is disable.

void

setDeviceStateHeldEvFilter(boolean filterValue)

Enables and disables the CiscoTermDeviceHeldEv filter.
The default value is disable.

void

setDeviceStateIdleEvFilter(boolean filterValue)

Enables and disables the CiscoTermDeviceIdleEv filter. The default value is disable.

boolean

getDeviceStateActiveEvFilter()

Gets the CiscoTermDeviceStateActiveEv filter status.

boolean

getDeviceStateAlertingEvFilter()

Gets the CiscoTermDeviceStateAlertingEv filter status.

boolean

getDeviceStateActiveEvFilter()

Gets the CiscoTermDeviceStateAlertingEv filter status.

boolean

getDeviceStateActiveEvFilter()

Gets the CiscoTermDeviceStateAlertingEv filter status.


For details on the interface changes, see Chapter 4, "Cisco Unified JTAPI Implementation."

Forced Authorization and Client Matter Codes

Forced Authorization Code (FAC)

FACs force the user to enter a valid authorization code prior to extending calls to specified classes of dialed numbers (DN), such as external, toll, or international calls. Authorization information is written to the Cisco Unified Communications Manager CDR database.

Client Matter Code (CMC)

CMCs let the user enter a code before extending a call. Customers can use Client Matter Codes for assigning accounting or billing codes to calls placed, and Client Matter Code information is written to the Cisco Unified Communications Manager CDR database.

Supported Interfaces

Cisco Unified JTAPI supports FAC and CMC in the following interfaces:

Call.Connect()

Call.Consult()

Call.Transfer(String)

Connection.redirect()

RouteSession.selectRoute()

Call.Connect() and Call.Consult()

When an application initiates a call with one of these interfaces to a DN that requires an FAC, CMC, or both codes, CiscoToneChangedEv is delivered on a CallObserver that also contains which code or codes are required for the DN. The getCiscoCause() interface returns CiscoCallEV.CAUSE_FAC_CMC for this even if it is delivered because of FAC_CMC feature. The getTone() interface returns CiscoTone.ZIPZIP to indicate that a ZIPZIP tone has played.

Upon receiving the CiscoToneChangedEv, applications need to enter the appropriate code or codes by using the connection.addToAddress interface with a # terminating string. Digits either can be entered one at a time within the interdigit timer value (T302 timer) for each digit including the # terminating character, or all the digits, including the # termination character, can be entered within the T302 timer value that is configured in Cisco Unified Communications Manager Administration.

When FAC and CMC Are Both Required

For a DN that requires both codes, the first event is always for the FAC and the second code is for the CMC, but the application has the option to send both codes, separated by a pound sign (#), in the same request. The second event remains optional, based on what the application sends in the first request.

The application can send both codes at the same time, but both codes must end with #. as shown in the following example:

connection.addToAddress("1234#678#")

where 1234 is the FAC and 678 is the CMC.

In this case, the application does not receive a second CiscoToneChanged.

The first CiscoToneChangesEv will have getWhichCodeRequired()=CiscoToneChanged.FAC_CMC_REQUIRED, and getCause()=CiscoCallEv.CAUSE_FAC_CMC.

In response, one of the following cases can occur:

The application sends FAC and CMC in the same connection.addToAddres(code1#code2#) request. In this case, no second CiscoToneChangedEv gets sent to the application.

The application sends only a FAC code in connection.addToAddress(code#1). In this case, the application receives a second CiscoToneChangedEv with getWhichCodeRequired()=CiscoToneChangedEv.CMC_REQUIRED.

The application sends only part of the first code or the complete first code and incomplete second code (if the code is not terminated with #, it remains is incomplete and the system waits for the T302 timer to expire and tries to validate the code). If the code is incomplete, a second CiscoToneChangedEv tone gets generated with getWhichCodeRequired()=CiscoToneChangedEv.CMC_REQUIRED and getCause()=CiscoCallEv.CAUSE_FAC_CMC.

PostCondition Timer

The PostCondition timer resets each time the connection.addToAddress interface is invoked to send code. FAC and CMC must have the terminal # [for example, Connection.assToAddress("1234#"), where 1234 is the FAC]. The system waits for the T302 timer to expire, then extends the call if all codes have been entered. If all codes have not been entered, the system plays reorder tone. In this case, the application could receive PlatformException with postConditionTimeout even if the call is extended. To avoid this, the application needs to increase the postcondition timeout by using JTAPI Preferences.

If the application uses call.connect() or call.consult() to initiate a call, but the FAC or CMC (including #) is not entered from a Cisco IP Phone within the postcondition timeout limit, then the request could get a platformException with postCondition timeout, but the call may actually be extended. To avoid this, the application needs to increase the postcondition timeout by using JTAPI preferences.

Shared Lines

If the initiating party is a shared line, then applications need to use setRequestController to set active terminalConnection before passing additional digits by using the connection.addToAddress interface.

Invalid or Missing Codes

If a code is invalid or no code is entered before the T302 timer expires, the call gets rejected with callCtlCause cause code as CiscoCallEv.CAUSE_FAC-CMC.

Call.transfer(String) and Connection.redirect()

Two additional string parameters (facCode, cmcCode) are added to these interfaces to support FAC and CMC. The default value for these codes are null values.

No CiscoToneChangedEv gets delivered for these requests for DNs that require codes. A call that is conditionally redirected to a DN, a FAC, a CMC, or both, does not get rejected but remains connected if either of the codes is incorrect.

RouteSession.selectRoute()

Two additional arrays of string parameters (facCode, cmcCode) support FAC and CMC. For each routeselect element, applications can specify the code for the DN. Applications need to specify null values for DNs that do not require any codes. The default values for the codes are null values.

If one routeselected element does not contain the correct code, the next element in the arrays gets tried. If all of them fail, then reRouteEvent gets sent to the application.


Note The system does not support forwarding to a DN that requires an FAC or CMC code. The application can set the forward number to these DNs by using the Address API, but calls forwarded to these numbers are rejected.


Super Provider (Disable Device Validation)

When a JTAPI application user is configured, the system administrator normally associates a certain set of terminals (Cisco Unified IP Phones and devices) with this application user, who can control and monitor only this set of terminals. The Super Provider feature gives applications the ability to control and monitor any terminal in a Cisco Unified Communications Manager cluster.

The new createTerminal() new interface in CiscoProvider lets the application create a terminal by specifying a terminalName. JTAPI does not provide the capability to get the terminalName through any interface. The CiscoProvider.createTerminal(terminalName) returns the terminal. If the terminal already exists in the provider domain, JTAPI returns the existing terminal.

A second new interface, CiscoProvider.deleteTerminal(), lets the application delete the CiscoTerminal objects created using the CiscoProvider.createTerminal() interface. If the terminal object does not exist or the application did not create the terminal with the CiscoProvider.createTerminal() interface, JTAPI throws exceptions.

JTAPI also provides a new interface on CiscoProviderCapabilities, canObserveAnyTerminal(), which can be enabled for application users through Cisco Unified Communications Manager Administration user configuration. Applications can use this interface to determine if they have sufficient capability to invoke the createTerminal(terminalName) interface. If the application does not have sufficient capability and this interface is invoked, JTAPI throws a PrivilegeViolationException. If the application provides a terminalName that does not exist in the Cisco Unified Communications Manager cluster, JTAPI throws a InvalidArgumentException.

Q.Signaling (QSIG) Path Replacement

QSIG Path Replacement, a network feature, optimizes the real-time protocol (RTP) path when calls are transferred or forwarded to other PBXs connected through QSIG trunks. When path replacement is in progress a small window of time exists when the feature requests from applications would be ignored and JTAPI would throw an exception to the application.

The Global Call ID or the call is changed when the RTP path is optimized with a direct path between the starting terminating PBXs. JTAPI provides new interfaces to monitor the call.

Network Events

In previous releases of Cisco Unified JTAPI, when a call is made to an address outside the cluster, CallCtlConnNetworkReachedEv and CallCtlConnNetworkAlertingEv events are delivered for the far-end address.

In later versions of Cisco Unified Communications Manager (4.0 and above), these events are not delivered. In these versions CallCtlConnection for the far-end address goes to the ESTABLISHED state from OFFERED state. The application will receive CallCtlConnOfferedEv, CallCtlConnEstablishedEv for the far-end address. The CallCtlConnNetworkReachedEv and CallCtlConnNetworkAlertingEv events are not delivered to application. To receive network events, the "Allow overlap sending" flag on the route pattern configured for the gateway must be turned on.

A new jtapi.ini parameter called "AllowNetworkEventsAfterOffered" is introduced to allow the application to control the delivery of these events. Applications that need the network events but cannot turn on this flag can use this new jtapi.ini parameter to receive network events for outgoing calls.

To turn on the parameter complete the following steps:


Step 1 Run jtprefs and select the required options. This creates jtapi.ini file in c:\winnt\java\lib, if Cisco Unified JTAPI is installed in the default directory. If the jtapi.ini file already exists, you can update the file directly without running jtprefs.

Step 2 Add AllowNetworkEventsAfterOffered=1 to the end of the file and save it.

Step 3 Repeat the preceding step every time Cisco Unified JTAPI is reinstalled.

When the AllowNetworkEventsAfterOffered flag is enabled, the application will receive CallCtlConnOfferedEv, CallCtlConnNetworkReachedEv or CallCtlConnNetworkAlertingEv and CallCtlConnEstablishedEv for the far-end address.


Network Alerting Change for Release 5.0

In earlier releases of CiscoJTAPI (CiscoJTAPI versions 1.4(x.y)), when a call was made to an address outside of the cluster, CallCtlConnNetworkReachedEv and CallCtlConnNetworkAlertingEv events were delivered to the far end address.

In later versions of Cisco Unified Communications Manager (4.0 and above) and Cisco Unified JTAPI (2.0(2.0)), these events were not delivered. In these versions CallCtlConnection for the far end address went to the ESTABLISHED state from the OFFERED state. The previous versions of Cisco Unified JTAPI delivered CallCtlConnOfferedEv, CallCtlConnEstablishedEv for the far end address when a call was made across a gateway with "overlap sending" turned off. CallCtlConnNetworkReachedEv and CallCtlConnNetworkAlertingEv events were not delivered to the application.

In Cisco Unified Communications Manager 4.0 and 4.1, the "Allow overlap sending" flag on the route pattern configured for the gateway or the "AllowNetworkEventsAfterOffered" parameter in jtapi.ini needed to be turned on to receive network events.

In Cisco Unified Communications Manager Release 5.0, if the "Allow overlap sending" flag is enabled, an application sees ConnCreatedEv, CallCtlConnNetworkReachedEv, CallCtlConnNetworkAlertingEv, and CallCtlConnEstablishedEv for the far end address for calls across a gateway.

If the "Allow overlap sending" flag is not enabled, an application sees ConnCreatedEv, CallCtlConnOfferedEv, CallCtlConnNetworkReachedEv, CallCtlConnNetworkAlertingEv, and CallCtlConnEstablishedEv for the far end address for calls across a gateway.


Note "AllowNetworkEventsAfterOffered" is not available in Cisco Unified Communications Manager Release 5.0. The above events are delivered regardless of the jtapi.ini parameter setting.


Partition Support

Prior to Cisco Unified Communications Manager Release 5.0, JTAPI did not support partitions. JTAPI considered addresses with the same DN, but different partitions, as same address. It created only one Address object for such cases because addresses are identified only by their DN and not by their partition information.

Beginning with Release 5.0, JTAPI supports addresses that have the same DN but belong to different partitions and treats them as different addresses. Partition information of the addresses is exposed to applications through the methods specified below. Applications that want to make use of this partition support feature must use the API provided to them through JTAPI interfaces and use the address objects accordingly.

This feature is backward compatible. JTAPI supports the current APIs that are used to open and access address objects.

In Cisco Unified Communications Manager Release 5.0, JTAPI is partition aware and the following configurations are supported.

Addresses with the same DN, in the same partition, and in different devices get treated as shared lines.

Addresses with the same DN, in the same partition, and in the same device are not allowed.

Addresses with the same DN, in different partitions, and in the same device get treated as different addresses. Two address objects get created for this scenario, and the application can distinguish between the two by calling the getPartition() API on the address objects.

Addresses with the same DN, in different partitions, and in different devices get treated as different addresses. Two address objects get created for this scenario and the application can distinguish between the two by calling the getPartition() API on the address objects.

Partition support changes in JTAPI are confined to the address objects and do not affect any other functions or classes of JTAPI. The following sections specify the interface changes.

CiscoAddress Interface

A new method is provided in this class with the following signature.

string getPartition ()

Returns the partition string of the address object. Applications need to use this method to get the partition information. JTAPI will use this partition information to distinguish between addresses that have the same DN but belong to different partitions and sends the partition information to open the specific addresses.

For example, a provider open returns two addresses, A(1000, P1) and B (1000, P2), where A and B denote the address objects, 1000 denotes the DN of the address objects, and P1,P2 indicate the partitions to which the addresses belong.

Figure 1-8 Provider Open Returns Two Addresses

When the user invokes A.getPartition (), P1 gets returned while B.getPartition () returns P2.

The provider.getAddresses() method returns multiple addresses in which the Address objects have the same DN but different partition information. An Application can use this method to distinguish between two Address objects that have the same DN but belong to different partitions.

CiscoProvider Interface

The CiscoProvider interface provides the following methods:

Address[]

getAddress(String number)

Returns an array of Address objects that corresponds to the number and different partitions.

Address

getAddress(String number, String partition)

Returns the Address object that has the same DN as the "number" parameter and belongs to the same partition as specified by the "partition" parameter.


If two addresses A(1000, P1) and B(1000,P2) exist, where A and B denote the address objects, 1000 denotes the DN of the address objects, and P1,P2 indicate the partitions to which the addresses belong, when an application calls provider.getAddress("1000"), it gets two address objects, A and B.

Figure 1-9 provider.GetAddress() Returns Two Address Objects

When the application calls A.getPartition(), it returns P1, B.getPartition() returns P2, and so on. An Application can distinguish between the two address objects that are using the getPartition method.

Consider the case where the application calls provider.getAddress(1000, P1). In this case, the application specifically looks for the address object whose DN is 1000 and partition is P1. In this case, "A" gets returned by the provider object.

Figure 1-10 Provider Calls a Specific Address and Partition

CiscoProvCallParkEv Event

CiscoProvCallParkEv provides the following methods in this interface.

string   getParkingPartyPartition()

Returns the partition string of the parking party.

string   getParkedPartyPartition()

Returns the partition string of the parked party.

string   getParkPartyPartition()

Returns the partition string of the park DN.

For details on the interface changes, see Chapter 4, "Cisco Unified JTAPI Implementation." To view the message flow for partitions support, see Appendix A, "Message Sequence Charts."

Hairpin Support

JTAPI considers a call as a `hairpin" call when the call goes out of the cluster to some other device across the gateway, then comes back to a device in the same cluster. In this case, the GCID for the call coming back into the cluster would be different than the GCID that originally initiated the call, even though both are in the same cluster. In previous releases, if both parties were controlled by JTAPI, then there were two connections: one for CiscoAddress.Internal and the other for CiscoAddress.External.

JTAPI now supports hairpin scenarios where an application monitors both ends of the hairpin call. Previously only one end of the hairpin call could be monitored as the Address was represented only as a directory number (DN). Now if there are two addresses with the same DN, but one is within the same cluster and the other is across the gateway, then JTAPI creates a separate Address object for the external DN and only one connection is returned for an Address, based on its type. This avoids hairpin issues, as in previous releases where the address was represented only as a DN and when an application retrieved connections for the address it used to get two connections.

Since fixing these issues could have caused compatability issues with earlier releases, a generic solution for these issues was developed in this release. Calls involving an external party with the same DN as the monitored local party are now properly supported; however, no new interface is added for this feature.

QoS Support

QoS support is enhanced in this release to enable QoS (DSCP marking) in both directions of the application ´ CTIManager connectivity. In previous releases it was enabled in only one direction: CTIManager Æ application.

The DSCP (QoS) values for both directions of the link are set by the "DSCP IP CTIManager to Application" value in the CTIManager service parameters. The default value is CS3(precedence 3) DSCP (011000).

The "DSCP value for Audio calls" service parameter is the recommended QoS value for audio calls. This value is exposed to JTAPI applications.

The following setup procedures must be performed on the client machine for JTAPI QoS to work on Windows platforms.

If you are running Windows 2000, follow these steps:


Step 1 Start the Registry Editor (Regedt32.exe).

Step 2 Go to key: HKEY_LOCAL_ MACHINE on
Local Machine\System\CurrentControlSet\Services\Tcpip\Parameters\

Step 3 On the Edit menu, click Add Value.

Step 4 In the Value name box, enter DisableUserTOSSetting.

Step 5 In the Data Type list, click REG_DWORD and then click OK.

Step 6 In the Data box, enter a value of 0 (zero) and then click OK.

Step 7 Quit Registry Editor and then restart the computer.


If you are running Windows XP or Windows Server 2003, follow these steps:


Step 1 Start Registry Editor (Regedt32.exe).

Step 2 Go to key: HKEY_LOCAL_ MACHINE on
Local Machine\System\CurrentControlSet\Services\Tcpip\Parameters\

Step 3 On the Edit menu, point to New, and then click DWORD Value.

Step 4 Enter DisableUserTOSSetting as the entry name, and then press ENTER.

When you add this entry, the value gets set to 0 (zero). Do not change the value.

Step 5 Quit Registry Editor and then restart the computer.


For more information on using the Registry Editor to set the Internet Protocol Type of Service bits, see the topic "Setsockopt is unable to mark the Internet Protocol type of service bits in Internet Protocol packet header" on the Microsoft technical support web site.

These JTAPI interfaces support QoS:

Provider Interface

int

getAppDSCPValue()

Returns the "DSCP IP for CTI applications" service parameter. This value specifies the DSCP value that JTAPI sets on its link to CTI. Applications can get this value by querying the provider object by using this API every time that they get a ProviderInServiceEvent.

private int

precedenceValue = 0x00

To store the DSCP value that CTI provides.


For details on these interfaces, see Chapter 4, "Cisco Unified JTAPI Implementation." To view the message flow for QoS, see Appendix A, "Message Sequence Charts."

Transport Layer Security (TLS)

This feature lets JTAPI applications communicate with CTIManager through a secure connection. CTIManager runs a TLS listener socket to accept connections from JTAPI. A client certificate, which the server uses to authenticate the client, and a server certificate, which the client uses to authenticate the server, are both required for establishing a TLS connection.

In the Cisco Unified Communications Manager environment, the server certificate exists in the form of CTL on the TFTP server, and JTAPI downloads this certificate. The initial download of CTL is trusted and occurs without verification, so Cisco strongly recommends performing this download in a secure environment. One of the two System Administrator Security Tokens (SAST) that are present in the CTL file signs the CTL; subsequent CTL downloads get verified with the SAST from the old CTL file.

JTAPI connects to CAPF by using the CAPF protocol to get the client certificate (LSC). These certificates can be authenticated with the issuer's certificate present in CTL.

CTI tracks the number of provider connections created per client certificate. Applications can create only one provider by using a client certificate. If more than one instance of a provider is created, both providers get disconnected from CTI and go out of service. JTAPI will retry the connection to CTI to bring the original provider in service; however, if both instances of provider continue to exist, after a certain number of retries provider will get permanently shut down, and the client certificate will be marked as compromised. Any further attempt to create a provider by using this client certificate will fail. Applications must contact the administrator to configure a new instanceId and download a new client certificate to resume operation.


Note Each client certificate is associated with a unique instanceId configured in the Cisco Unified Communications Manager database. Applications can provide an instanceId in providerString as an optional parameter to use a unique certificate while creating a CiscoProvider.


To run multiple instances of applications with TLS, the application user should be configured in the Cisco Unified Communications Manager database with multiple instanceIDs. Applications use these unique instanceIDs to get unique client certificates for each instance.

The JTAPI preferences application provides a graphic user interface to configure the Security parameters and update server/client certificates. Application users need to configure the TFTPServer IP address, CAPFServer IP address, Username, InstanceID, and AuthorizationString parameters through the JTAPI preferences to download/install certificates on the application server.

New interfaces are provided for JTAPI client applications on the client layer object. For example, a JTAPI client interface is provided on the CTIClientProperties class.

This feature is backward compatible with previous releases as JTAPI Applications can still connect to CTIManger on non-secure socket connections. However, this option will be available only for a limited number of releases and could be removed in future releases. It is recommended that Applications move to secure connections.

The following sections describe the interface changes for TLS support in JTAPI.

CiscoJtapiPeer.getProvider()

public javax.telephony.Provider getProvider(java.lang.String providerString) 
throws  
javax.telephony.ProviderUnavailableException

This interface is modified to take a new optional parameter InstanceID. It returns an instance of a Provider object given a string argument that contains the desired service name.

Optional arguments may also be provided in this string, with the following format:

< service name > ; arg1 = val1; arg2 = val2; ... 

Where < service name > is not optional, and each optional argument=value pair that follows is separated by a semicolon. The keys for these arguments are implementation-specific, except for two standard-defined keys:

login—Provides the login user name to the Provider.

passwd—Provides a password to the Provider.

A new optional argument would be expected by CiscoJtapiPeer in providerString:

InstanceID—Provides InstanceID for Application Instance.

InstanceID is needed when two or more instances of an application want to connect to Provider(CTIManager) through a TLS connection from the same client machine. Each instance of an application requires its own unique X.509 certificate to establish a TLS connection. If JTAPI attempts to open more that one connection with same username/instanceID, CTIManager rejects the TLS connection. If instanceID is not provided, JTAPI randomly picks one of the instances of USER and, in that case, the connection may fail if a connection for the selected Instance already exists.

If the argument is null, this method returns some default provider as determined by the JtapiPeer object. The returned provider is in the Provider.OUT_OF_SERVICE state.

Post-conditions:

this.getProvider().getState() = Provider.OUT_OF_SERVICE

Specified by—getProvider in interface javax.telephony.JtapiPeer

Parameters—providerString—The name of the desired service plus an optional argument.

Returns—An instance of the Provider object.

Throws—javax.telephony.ProviderUnavailableException—Indicates that a provider corresponding to the given string is unavailable.

CiscoJtapiProperties

JTAPI provides an interface on CiscoJtapiProperties to enable or disable the security option and install the client/server certificates that are required to establish a secure TLS socket connection.

com.cisco.jtapi.extensions  
Interface CiscoJtapiProperties

getSecurityPropertyForInstance

public java.util.Hashtable getSecurityPropertyForInstance()

This interface returns a Hashtable with all the parameters set for User/InstanceID. The Hashtable gets set with the following "key-value" pairs:

KEY
VALUE

          "user"

userName

string "instanceID"

InstanceID

string "AuthCode"

authCode

string "CAPF"

capfServer IP-Address

string "CAPFPort"

capfServer IP-Address port

string "TFTP"

tftpServer IP-Address

string "TFTPPort"

tftpServer IP-Address port

string "CertPath"

certificate Path

string "securityOption"

Boolean security option(true for enable/ false for disabled)

string "certificateStatus"

Boolean certificate status(true for updated/ false for not updated)


Returns—Hashtable in the format described previously for the first user and instance.


getSecurityPropertyForInstance

public java.util.Hashtable getSecurityPropertyForInstance 
(java.lang.String user, java.lang.String instanceID)

This interface returns a Hashtable with all the parameters set for User/InstanceID. The Hashtable is set with the following "key-value" pairs:

KEY
VALUE

          "user"

userName

string "instanceID"

InstanceID

string "AuthCode"

authCode

string "CAPF"

capfServer IP-Address

string "CAPFPort"

capfServer IP-Address port

string "TFTP"

tftpServer IP-Address

string "TFTPPort"

tftpServer IP-Address port

string "CertPath"

certificate Path

string "securityOption"

Boolean security option(true for enable/ false for disabled)

string "certificateStatus"

Boolean certificate status(true for updated/ false for not updated)


Parameters:

user - UserName for which you want security parameters

instanceID - InstanceID for which you want security parameters

Returns—Hashtable in above described format.


setSecurityPropertyForInstance

public void setSecurityPropertyForInstance(java.lang.String user,
                                           java.lang.String instanceID,
                                           java.lang.String authCode,
                                           java.lang.String tftp,
                                           java.lang.String tftpPort,
                                           java.lang.String capf,
                                           java.lang.String capfPort,
                                           java.lang.String certPath,
                                           boolean securityOption)

You can use this interface to set security properties for the following parameters:

Parameters:

user—UserName for which the security parameter is being updated

instanceID—InstanceID for which the security parameter is being updated

authCode—Authorization string

capf—IP-Address of CAPF server

capfPort—IP-Address port number on which the CAPF server is running, as defined in a CallManger Service parameter. If the value is null, the default value is 3804.

tftp—IP-Address of TFTP server

tftpPort—IP-Address port number on which the TFTP server is running. The Cisco Unified Communications Manager TFTP server usually runs on port 69. If the value is null, the default value is 69.

certPath—Path where certificate needs to be installed


updateCertificate

public void updateCertificate(java.lang.String user,
                              java.lang.String instanceID,
                              java.lang.String authcode,
                              java.lang.String ccmTFTPAddress,
                              java.lang.String ccmTFTPPort,
                              java.lang.String ccmCAPFAddress,
                              java.lang.String ccmCAPFPort,
                              java.lang.String certificatePath)

This interface installs an X.509 client certificate for the USER instance in the certificate store by connecting to the Cisco Unified Communications Manager Certificate Authority Proxy Function (CAPF) server. It also downloads the Certificate Trust List (CTL) from the Cisco Unified Communications Manager TFTP server.

If the user credentials are not valid, this method throws a PrivilegeViolationException. If the TFTP server or CAPF server address is not correct, this method throws an InvalidArgumentException. Every instance of an application requires a unique client certificate. If a multiple instanceID is configured in the Cisco Unified Communications Manager database, applications can call this interface multiple times to install a client certificate for every instance.

Pre-conditions—When calling this interface, an application should have network connectivity with the Cisco Unified Communications Manager CAPF and TFTP servers.

Post-conditions—This process installs client and server certificates on the JTAPI application machine.

Parameters:

user—Name of the CTI application user that is configured in the Cisco Unified Communications Manager database

instanceID—Application instance ID that is configured in the Cisco Unified Communications Manager database. Every instance of an application requires a unique ID.

authCode—Authorization string that is configured in the Cisco Unified Communications Manager database. The authCode can be used only once for getting certificates.

ccmTFTPAddress—IP-Address of the Cisco Unified Communications Manager TFTP server.

ccmTFTPPort—IP-Address port number on which the Cisco Unified Communications Manager TFTP server is running. The Cisco Unified Communications Manager TFTP server usually runs on port 69. If null, the default value is 69.

ccmCAPFAddress—IP address of the Cisco Unified Communications Manager CAPF server.

ccmCAPFPort—Port number on which the Cisco Unified Communications Manager CAPF server is running, as defined in the Cisco Unified Communications Manager Service parameters. If the value is  null, the default value is 3804.

certificatePath—Directory path where the certificate needs to be installed

Throws:

InvalidArgumentException—This exception gets thrown for an invalid TFTP server or CAPF server address.

PrivilegeViolationException—This exception gets thrown for an invalid user, instanceID, or authCode.


IsCertificateUpdated

public boolean IsCertificateUpdated 
	(java.lang.String user, java.lang.String instanceID)

This interface provides information about whether client and server certificates are updated for a given user/instanceID.

Parameters:

user—UserName as defined in the Cisco Unified Communications Manager Admin page.

instanceID—InstanceID for the specified UserName.

Returns—True if certificates are already updated; false if certificates are not updated.


updateServerCertificate

public void updateServerCertificate(java.lang.String ccmTFTPAddress,
                                    java.lang.String ccmTFTPPort,
                                    java.lang.String ccmCAPFAddress,
                                    java.lang.String ccmCAPFPort,
                                    java.lang.String certificatePath)

This interface installs an X.509 server certificate that is given the certificate path. If the TFTP server address is not correct, this method throws an InvalidArgumentException. Auto update applications should use this interface to update the server certificate before invoking an HTTPS connection with Cisco Unified Communications Manager.

Pre-conditions—When calling this interface, applications should have network connectivity with the TFTP server.

Post-conditions—This interface installs the server certificate on the JTAPI application machine.

Parameters:

ccmTFTPAddress—IP address of the Cisco CallManger TFTP server.

ccmTFTPPort—Port number on which the Cisco Unified Communications Manager TFTP server is running.
If null, the default value is 69.

certificatePath—Directory path for installing the certificate.

ccmCAPFAddress—IP address of the Cisco Unified Communications Manager CAPF server.

ccmCAPFPort—Port number on which the Cisco Unified Communications Manager CAPF server is running.
If the value is null, the default value is 3804.

Throws:

InvalidArgumentException—If the TFTP server address is invalid.


Interface that is Provided on JTAPI Preferences

The JTAPI Preferences dialog box includes a Security tab to let application users configure the username, instanceId, authCode, TFTP IP address, TFTP port, CAPF IP server address, CAPF server port, and certificate path, and enable secure connection.

"CAPF server port" number defaults to 3804.

This value is configurable in the Cisco Unified Communications Manager Administration service parameters page. The CAPF server port value entered through JTAPI Preferences should be same as that configured in Cisco Unified Communications Manager Administration.

"TFTP server port" number defaults to 69.

This value should not be changed unless you are advised to do so by the System Administrator.

"Certificate Path" is where the application wants the sever and client certificates to be installed.

If this field is left blank, the certificates get installed in the ClassPath of JTAPI.jar.

"Certificate update Status" provides information on whether a certificate has been updated or not.

You must select "Enable Secure Connection" to enable a secure TLS connection to Cisco Unified Communications Manager.

If "Enable Security Connection" is not selected, JTAPI makes a non-secure connection to CTI even if the certificate is updated/installed.

The "Enable Security Tracing" check box lets you enable or disable tracing for the certificate installation operation.

If tracing is enabled, you can select three different levels, "Error," "Debug," or "Detailed," from the drop-down menu.

The JTAPI Preference UI can be used to configure a security profile for one or more than one userName/instanceID pair. When application users revisit this page, and have previously configured security profile for a userName/instanceID pair, the security profile automatically gets populated when the user enters a username/instanceID and clicks on any other edit box.

One change in the JTAPI Preferences UI is that the "Trace Levels" tab is renamed "JTAPI Tracing." This is to highlight the fact that the "JTAPI Tracing" tab only lets you change trace setting for the JTAPI layer. Tracing for the installation of Security certificates must be enabled on the Security tab.

SIP Phone Support

This release of Cisco Unified Communications Manager allows SIP phones to register and interoperate with SCCP phones. The following sections describe the new interfaces introduced to support SIP phones along with the limitations and differences in behavior with respect to SCCP phones. Though not all existing features are supported on SIP phones, the general behavior in terms of JTAPI events and interfaces for SIP phones are similar to that of a SCCP phone.

JTAPI applications can only control TNP-based SIP phones, which includes Cisco Unified IP 7970 phones. Applications should not include Cisco Unified IP 7960, 7940, and other phones that are running the SIP protocol in their control list. JTAPI applications cannot control third-party SIP phones, so third-party SIP phones should not be included in the control list.

Also see SIP Phone Support.

JTAPI supports the following features for SIP phones:

Call.connect; offhook

answer; disconnect; drop; hold, unhold

consult; transfer; conference; redirect

playdtmf, deviceData

JTAPI supports the following events for SIP Phones:

CiscoTermDeviceStateEv, RTP events, inService, and OutOfService

MediaTermConnDtmfEv (only out of band is supported), transfer start and end events, conference start and end events, CiscoToneChangedEv, and CiscoTermConnPrivacyChangedEv

SIP phone behavior differs from that of SCCP phones in the following ways:

Call Rejection—When a call is made to a SIP phone, the phone can choose to reject the call. In this case, applications will see CallActive, ConnCreatedEv followed by ConnDisconnectedEv for the address on the SIP terminal. This is similar to RP rejecting the call.

Consult without media calls involving SIP phones should be transferred within 1.5 seconds after the call is connected.

For SIP phones, enbloc dialing is always used even if the user first goes off hook before dialing digits. The phone will wait until all the digits are collected before sending the digits to the Cisco Unified Communications Manager. This means that CallCtlConnDialingEv will get delivered only after enough digits are pressed on the phone to match one of the configured dialing patterns.

Applications should configure "out of band DTMF" on all devices to receive MediaTermConnDtmfEv.

Events for ctiports, route points, and SCCP phones are not changed.

When a SIP TNP phone using UDP as transport fails connectivity with Cisco Unified Communications Manager, JTAPI applications receive the events CiscoTermOutOfServiceEv and CiscoAddrOutOfServiceEv for the terminal and address defined for the phone. Because of the inherent delay in UDP in detecting the connectivity loss, the TNP-based SIP phone may visually show as registered after applications already have been notified with the out-of-service events.

If Cisco Unified IP Phones 7960,7940, and non-TNP phones running SIP, are included in the control list, exceptions will be thrown when observers (both observer and call observers) are added to the address or terminal and CiscoTermRestrictedEv is delivered to a provider observer. The cause for these events would be CiscoRestrictedEv.CAUSE_UNSUPPORTED_PROTOCOL.

CiscoTerminal exposes new interface getProtocol() to indicate whether terminal is an SCCP phone or a SIP phone. CiscoTerminalProtocol defines the values that are returned by getProtocol().

The following new interfaces defined on CiscoCall let applications get URL information for external SIP entities.

Public interface CiscoCall

CiscoPartyInfo

getLastRedirectingPartyInfo()

CiscoPartyInfo

getCurrentCallingPartyInfo()

CiscoPartyInfo

getCurrentCalledPartyInfo()

CiscoPartyInfo

getCalledPartyInfo()

Public interface CiscoPartyInfo

CiscoUrlInfo

getUrlInfo()

Address

getAddress()

string

getDisplayName()

string

getUnicodeDisplayName()

boolean

getAddressPI()

boolean

getDisplayNamePI()

boolean

getlocale()

Public interface CiscoUrlInfo

int

getUrlType() 
Final int URL_TYPE_TEL
Final int URL_TYPE_SIP
Final int URL_TYPE_UNKNOWN

string

getHost()

string

getUser()

int

getPort()

int

getTransportType()
Final int TRANSPORT_TYPE_UDP
Final int TRANSPORT_TYPE_TCP

Public interface CiscoTerminal

int

getProtocol ()

CiscoTerminalProtocol

static int

PROTOCOL_NONE

Indicates an unrecognized or unknown protocol type

static int

PROTOCOL_SCCP

Indicates the device is using SCCP protocol to communicate to Cisco Unified Communications Manager

static int

PROTOCOL_SIP

Indicates the device is using SIP protocol to communicate to Cisco Unified Communications Manager


Secure Real-Time Protocol Key Material

This feature provides the mechanism that is needed to deliver Secure Real-Time Protocol (SRTP) key material of an encrypted media session between authenticated end points within Cisco Unified Communications Manager based Enterprise systems. To receive this key material, the administrator must configure the TLS Enabled and SRTP Enabled flags in the Cisco Unified Communications Manager Administrator pages and a TLS link must be established between JTAPI and the CTIManager.

Key materials get exposed in CiscoRTPInputKeyEv and CiscoRTPOutputKeyEv. To get these events, applications must enable rtpKeyEvenabled in CiscoTermEvFilter. By default, filters are disabled to maintain backward compatibility. If filters are enabled, application always get CiscoRTPInputKeyEv and CiscoRTPOutputKeyEv. A security indicator in these events indicates whether the media is encrypted and whether keys are available.

CiscoRTPInputKeyEv contains key material of the input stream and CiscoRTPOutputKeyEv contains key material of the output stream. Applications can use this key material to decrypt the packets and start monitoring or recording the media. Applications must not store this key material in a way that leaves the material vulnerable to tampering, and applications must zero out or clear the entry for these keys when they go out-of-scope.

This key material contains

Key Length

Master Key

Salt Length

Master Salt

AlgorithmID

isMKIPresent

Key Derivation Rate

This enhancement also supports a secure media termination for CTIPorts and RoutePoints. To do this, the application passes in supported encrypted algorithms in CTIPort and route point register requests. The application gets an error if no TLS link and no SRTP Enabled flags exist. Whether media are encrypted or not depends on whether the other end is interested in secure media and whether the algorithm is negotiated successfully.

For mid-call monitoring, if the application comes up after a call is established between two end points, the application must query Terminal.createSnapshot() and snapshot event CiscoTermSnapshotEv. CiscoTermSnapshotCompletedEv gets sent, which indicates whether the current media between end points is secure or not. Applications can query CiscoMediaCallSecurityIndicator to get a security indicator for a call; however, this does not contain any key material in the event. If no calls exist on any of the lines on the terminal, applications only get CiscoTermSnapshotCompletedEv. To maintain backward compatibility, these events get generated only when an application enables the snapShotRTPEnabled filter in CiscoTermEvFilter.

CiscoRTPHandle gets added in all RTP events so that applications can correlate RTP events related to a single call. For backward compatibility, no new events are generated when there is no secure media.

For more information on SRTP, see the Secure RTP Library API Documentation by David McGrew on SourceForge.net.

The following sections describe the interface changes for SRTP key material.

Public interface CiscoMediaEncryptionKeyInfo

int

getAlgorithmID()

This method returns the media encryption algorithm for the current stream.

int

getIsMKIPresent()

An MKI indicator that indicates whether MKI is present. Key management defines, signals, and uses the MKI.

int

getKeyLength ()

This method returns the master key length.

byte[]

getKey() 

This method returns the master key for the stream.

int

getSaltLength ()

This method returns the salt length.

byte[]

getSalt()

This method returns the salt key for the stream.

int

keyDerivationRate()

Indicates the SRTP key derivation rate for this session.


CiscoMediaSecurityIndicator

static int

MEDIA_ENCRYPTED_KEYS_AVAILABLE

Indicates that media terminated is secured and keys are available.

static int

MEDIA_ENCRYPTED_KEYS_UNAVAILABLE

Indicates that media is terminated in secured mode, but keys are not available because SRTP is not enabled in Cisco Unified Communications Manager Administration User windows. This could be because either no TLS exists or no IPSec is configured for this application.

static int

MEDIA_ENCRYPTED_USER_NOT_AUTHORIZED

Indicates that media is terminated in secured mode, but keys are not available because user is not authorized to get the keys.

static int

MEDIA_NOT_ENCRYPTED

Indicates that media is not encrypted for this call.


CiscoRTPInputKeyEv

CiscoMedia
EncryptionKeyInfo

getCiscoMediaEncryptionKeyInfo ()

Returns CiscoMediaEncryptionKeyInfo only if the provider is opened with TLS link and if SRTP enabled option is set for the application in Cisco Unified Communications Manager User Administration; otherwise, it returns null.

int

getCiscoMediaSecurityIndicator()

Returns media security indicator, which is one of the following constants from the CiscoMediaSecurityIndicator:

MEDIA_ENCRYPTED_KEYS_AVAILABLE 
MEDIA_ENCRYPT_USER_NOT_AUTHORIZED 
MEDIA_ENCRYPTED_KEYS_UNAVAILABLE 
MEDIA_NOT_ENCRYPTED

CiscoCallID

getCallID ()

Returns CiscoCallID object if CiscoCall is present when this event is sent. If no CiscoCall is present, this method returns null.

CiscoRTPHandle

getCiscoRTPHandle ()

Returns CiscoRTPHandle object. Applications can get a call reference by using CiscoProvider.getCall( CiscoRTPHandle ). If no call observer exists, or if there was no call observer when this event is delivered,  CiscoProvider.getCall( CiscoRTPHandle ) may return null.


CiscoRTPOutputKeyEv

CiscoMedia
EncryptionKeyInfo

getCiscoMediaEncryptionKeyInfo ()

Returns CiscoMediaEncryptionKeyInfo only if the provider is opened with TLS link and if the SRTP enabled option is set for the application in Cisco Unified Communications Manager User Administration. Otherwise, it returns null.

int

getCiscoMediaSecurityIndicator() 

Returns media security indicator, which is one of the following constants from CiscoMediaSecurityIndicator:

MEDIA_ENCRYPTED_KEYS_AVAILABLE 
MEDIA_ENCRYPT_USER_NOT_AUTHORIZED 
MEDIA_ENCRYPTED_KEYS_UNAVAILABLE 
MEDIA_NOT_ENCRYPTED

CiscoCallID

getCallID ()

Returns CiscoCallID object if CiscoCall is present when this event is sent. If  no CiscoCall is present, this method returns null.

CiscoRTPHandle

getCiscoRTPHandle ()

Returns CiscoRTPHandle object. Applications can get a call reference by using CiscoProvider.getCall(CiscoRTPHandle). If no call observer exists, or if there was no call observer when this event is delivered,  CiscoProvider.getCall( CiscoRTPHandle ) may return null.


CiscoTermSnapshotEv

CiscoMediaCall
MediaSecurity
Indicator[]

getMediaCallSecurityIndicator ()

Returns media security status for each active call on this device.


CiscoTermSnapshotCompletedEv

This event has no methods.

CiscoMediaCallSecurityIndicator

int

getCiscoMediaSecurityIndicator()

Returns media security indicator, one of the following constants from CiscoMediaSecurityIndicator:

MEDIA_ENCRYPTED_KEYS_AVAILABLE 
MEDIA_ENCRYPT_USER_NOT_AUTHORIZED 
MEDIA_ENCRYPTED_KEYS_UNAVAILABLE 
MEDIA_NOT_ENCRYPTED

CiscoCallID

getCallID ()

Returns a CiscoCallID object if a CiscoCall is present when this event is sent. If no CiscoCall is present, this method returns null.

CiscoRTPHandle

getCiscoRTPHandle ()

Returns a CiscoRTPHandle object. Applications can get a call reference by using CiscoProvider.getCall( CiscoRTPHandle ). If no callobserver exists or if there was no callobserver when this event is delivered, CiscoProvider.getCall( CiscoRTPHandle ) may return null.


CiscoRTPInputStartedEv

CiscoRTPHandle

getCiscoRTPHandle ()

Returns a CiscoRTPHandle object. Applications can get a call reference by using CiscoProvider.getCall(CiscoRTPHandle). If no call observer exists, or if there was no call observer when this event is delivered, CiscoProvider.getCall(CiscoRTPHandle) may return null.


CiscoRTPInputStoppedEv

CiscoRTPHandle

getCiscoRTPHandle ()

Returns a CiscoRTPHandle object. Applications can get call reference by using CiscoProvider.getCall(CiscoRTPHandle). If no call observer exists, or if there was no call observer when this event is delivered, CiscoProvider.getCall(CiscoRTPHandle) may return null.


CiscoRTPOutputStartedEv

CiscoRTPHandle

getCiscoRTPHandle ()

Returns a CiscoRTPHandle object. Applications can get a call reference by using CiscoProvider.getCall(CiscoRTPHandle). If no call observer exists, or if there was no call observer when this event is delivered, CiscoProvider.getCall(CiscoRTPHandle) may return null.


CiscoRTPOutputStoppedEv

CiscoRTPHandle

getCiscoRTPHandle ()

Returns CiscoRTPHandle object. Applications can get call reference using CiscoProvider.getCall(CiscoRTPHandle). If there is no call observer, or if there was no call observer when this event is delivered, then CiscoProvider.getCall(CiscoRTPHandle) may return null.


CiscoTermEvFilter

boolean

getSnapshotEnabled ()

Returns the enable/status of CiscoTermSnapshotEv and CiscoTermSnapshotCompletedEv for the terminal.

void

setSnapshotEnabled (boolean enabled)

Sets enable/disable status of CiscoTermSnapshotEv. If disabled, CiscoTermSnapshotEv and CiscoTermSnapshotCompletedEv
are not sent to applications.

boolean

getRTPKeyEvEnabled ()

Returns the enable/disable status of CiscoRTPInputKeyEv and CiscoRTPOutputKeyEv.

void

setRTPKeyEvEnabled (boolean enabled)

Sets enable/disable status for CiscoRTPInputKeyEv and CiscoRTPOutputKeyEv.


CiscoTerminal

void

createSnapshot () throws  InvalidStateException

This method generates CiscoTermSnapshotEv, which contains security status of current active call on the terminal. To access this method, the terminal must be in CiscoTerminal.IN_SERVICE state, and CiscoTermEvFilter.setSnapshotEnabled () must be set to True.


CiscoMediaTerminal

void

register(CiscoMediaCapability[] capabilities, 
int[] supportedAlgorithms)

The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its provider must be in the Provider.IN_SERVICE state. This interface provides dynamic registration with secure media. If applications do not invoke this method, the media gets terminated in non-secure mode.

void

register(java.net.InetAddress address, int port, 
CiscoMediaCapability[] capabilities, int[] algorithmIDs)

The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state, and its provider must be in the Provider.IN_SERVICE state. This interface provides static registration with secure media. If applications do not register this interface, the media remains non-secured. AlgorithmIDs indicate SRTP algorithms that this CTIPort supports. AlgorithmIDs maybe only one of CiscoSupportedAlgorithms.


CiscoRouteTerminal

void

register(CiscoMediaCapability[] capabilities, int registrationType, int[] 
algorithmIDs

The CiscoRouteTerminal must be in the CiscoTerminal.UNREGISTERED state, and its provider must be in the Provider.IN_SERVICE state. By default, media gets terminated in non-secure mode. AlgorithmIDs indicate SRTP algorithms that this CTIPort supports. AlgorithmIDs may be only one of CiscoSupportedAlgorithms.


CiscoSupportedAlgorithm Constants

AES_128_COUNTER

SIP REFER/REPLACE

REFER is a SIP method that is defined by RFC 3515. The REFER method indicates that the recipient (referee, identified by the Request-URI) should contact a third party (referred to as the "target") by using the contact information that is provided in the request. This REFER method allows the party who is sending the REFER (referrer) to be notified of the outcome of the referenced request.

Cisco Unified Communications Manager, being a Back-To-Back User Agent (B2BUA), processes both inside and outside dialog inbound REFER on behalf of the Referee. As result of REFER, Cisco Unified Communications Manager creates a call between the Referee and the Refer-to-Target. If there is a previously existing call between the Referrer and the Referee, the call at the Referrer gets dropped after REFER completes.

The REPLACES feature is the replacement of an existing SIP dialog with a new dialog. A SIP dialog is a call between two SIP user agents; a Cisco Unified Communications Manager dialog is a half call (callleg). The REPLACES feature is triggered either by REFER or by an INVITE. Cisco Unified Communications Manager handles a REPLACES request on behalf of the recipient of the REPLACES header. The request is associated with a new dialog and the requesting party is the party that wants to replace another party in the existing dialog (call) identified in the REPLACES header. Cisco Unified Communications Manager disconnects the dialog (call) identified in the REPLACES header and connects the requesting party.

JTAPI is enhanced to model Call events caused by the Cisco Unified Communications Manager REFER and REPLACE features in the JTAPI call model. JTAPI provides applications with the capability to handle call events caused by REFER and REPLACE features. JTAPI does not provide any interface for applications to initiate REFER or REFER/INVITE with REPLACES requests; however, JTAPI can handle the call events properly.

These two features are backward compatible. JTAPI provides events that are caused by REFER/REPLACE with CAUSE_NORMAL. Applications can get feature-specific reasons from the new interface CiscoCallEv.getCiscoFeatureReason().


Note This interface provides feature-specific reasons for current and new features, but this method will not remain backward compatible in future releases. Applications using this interface must implement default handling to avoid future backward-compatibility issues.


The following sections describe the interface changes for SIP REFER/REPLACE.

CAUSE provided for REFER/REPLACE

JTAPI provides CAUSE_NORMAL for events that caused by REFER/REPLACES. Applications should use CiscoCallEv.getCiscoFeatureReason() to get the feature-specific reason.

Interface provided on CiscoCallEv

This interface provides CiscoFeatureReason in the JTAPI call event. Older features, such as transfer, continue to receive the old CiscoCause that is provided by the previous interface, CiscoCallEv.getCiscoCause(). This new interface provides REASON_TRANSFER for transfer.

com.cisco.jtapi.extensions
Interface CiscoCallEv

int

getCiscoFeatureReason()

This interface returns Cisco Unified Communications Manager Feature Reason.


Interface CiscoFeatureReason:

JTAPI provides CiscoFeatureReason in Call events caused by features. CiscoFeatureReason is provided for existing as well as new Cisco Unified Communications Manager features. For REFER and REPLACES features, the reason would be REASON_REFER and REASON_REPLACES. This interface will provide new reasons for any new features that may be introduced in the future, and is not backward compatible.

Applications using CiscoFeatureReason should expect to receive new reasons in later releases and must implement default behavior to maintain the Application's backward compatibility.

Applications that use CiscoFeatureReason should expect to receive new reasons in later releases and must implement default behavior to maintain backward-compatibility.

Public interface CiscoFeatureReason

static int

REASON_REFER

Reason returned for events that are sent for REFER by Cisco Unified Communications Manager.

static int

REASON_REPLACE

Reason returned for events that are sent for REPLACE by Cisco Unified Communications Manager.


SIP 3XX Redirection

The SIP Redirect server receives SIP requests and responds with 3xx(redirection) responses, which direct the client to contact an alternate set of SIP addresses. This enhancement supports the Cisco Unified Communications Manager Redirection (3xx) Call Control primitive in compliance with RFC 3261. The Cisco Unified Communications Manager Redirection primitive processes SIP 3xx responses and does sequential hunting to each contact address from the 3xx response. Cisco Unified Communications Manager Redirection primitive also handles feature interactions that result from performing this operation. Cisco Unified JTAPI exposes new reason codes in all CallEvs, which indicate when connection and terminalConnection are created and destroyed as a result of this primitive.

LastRedirectAddress may change if feature interactions like JTAPI Redirect or CallForwardNoAnswer occur when the Redirection primitive is hunting for a target. If the target does not answer and Cisco Unified Communications Manager Redirect takes control of the call to send it to next target, lastRedirectAddress is set to the party who originally sent the SIP 3xx response.

If a diversion header is present in the SIP 3xx response, the 3xx primitive uses the first value of the diversion header for lastRedirectParty, and JTAPI applications will see the diversion header element as lastRedirectAddress.

To maintain backward compatibility, JTAPI exposes the new API CiscoCallEv.getCiscoFeatureReason() in the CiscoCallEv interface, which contains the reason as CM_REDIRECTION.


Note Applications should be aware that new feature-specific reason codes could be returned from this API, and applications should provide default behavior for unrecognized reason codes.


The following sections describe the interface changes for SIP 3XX Redirection.

Public interface CiscoFeatureReason

static int

REASON_CM_REDIRECTION 

This reason indicates that event is a result of 3xx response from the CM_REDIRECTION primitive in Cisco Unified Communications Manager.


CiscoCallEv

int

getCiscoFeatureReason()

A feature specific reason for this event. Applications should make sure to handle unrecognized reasons and provide default behavior as this interface may not be backward compatible as new reasons might be added in the future.


Terminal and Address Restrictions

This enhancement restricts applications from controlling and monitoring a certain set of terminals and addresses when the administrator configures them as restricted in Cisco Unified Communications Manager Administration.

The administrator can configure a particular line on a device (address on a particular terminal) as restricted. If a terminal is added into the restricted list in Cisco Unified Communications Manager Administration, all addresses on that terminal are also marked as restricted in JTAPI. If an application comes up after the configuration is completed, it can know whether a particular terminal or address is restricted from checking the interface CiscoTerminal.isRestricted() and CiscoAddress.isRestricted(Terminal). For shared lines, applications can query the interface CiscoAddress.getRestrictedAddrTerminals(), which indicates whether an address is restricted on any terminals.

If a line (address on a terminal) is added into the restricted list after an application comes up, the applications will see CiscoAddrRestrictedEv. If the address has any observers, applications will see CiscoAddrOutOfService. When a line is removed from the restricted list, applications will see CiscoAddrActivatedEv. If an address has any observers, applications see CiscoAddrInServiceEv. If an application tries to add observers on an address after it is restricted, a PlatformException gets thrown. However, if any observers are added before the address is restricted, they will remain as is, but applications cannot get any events on these observers unless the address is removed from the restricted list. Applications can also choose to remove observers from an address.

If a device (terminal) is added to the restricted list after an application comes up, the application will see CiscoTermRestrictedEv. If the terminal has any observers, the application will see CiscoTermOutOfService. If a terminal is added to the restricted list, JTAPI also restricts all addresses that belong to that terminal and applications will see CiscoAddrRestrictedEv. If a terminal is removed from the restricted list, applications will see CiscoTermActivatedEv and CiscoAddrActivatedEv for the corresponding addresses. If an application tries to add observers on a terminal after it is added to the restricted list, a PlatformException is thrown. However, if any observers are added before the terminal is restricted, they will remain as is, but applications cannot get any events on these observers unless the terminal is removed from the restricted list

If a shared line is added to the restricted list after an application comes up, the application will see CiscoAddrRestrictedOnTerminalEv. If any address observers exist on the address, the application will see CiscoAddrOutOfServiceEv for that terminal. If all shared lines are added to the restricted list, when the last one is added, applications will see CiscoAddrRestrictedEv. If a shared line is removed from the restricted list after the application comes up, applications will see CiscoAddrActivatedOnTerminalEv. If  any observers exist on the address, the application will see CiscoAddrInServiceEv for that terminal. If all shared lines in the control list are removed from the restricted list, applications will see CiscoAddrActivatedEv when the last one is removed, and all addresses on terminals will receive InService events.

If all shared lines in the control list are marked as restricted, and an application tries to add observers, a platform exception is thrown. If a few shared lines are in the restricted list, while others are not, when an application adds an observer on the address. only non-restricted lines will go in service.

If any active calls are present when an address or terminal is added to the restricted list and reset, applications will see connection and TerminalConnections get disconnected.

If no addresses or terminals are added to the restricted list, this feature is backward compatible with earlier versions of JTAPI: no new events are delivered to applications.

The following sections describe the interface changes for address and terminal restrictions.

CiscoTerminal

boolean

isRestricted() 

Indicates whether a terminal is restricted. If the terminal is restricted, all associated addresses on this terminal are also restricted. Returns true if the terminal is restricted; returns false if it is not restricted.


CiscoAddress

javax.telephony.
Terminal[]

getRestrictedAddrTerminals()

Returns an array of terminals on which this address is restricted. If none are restricted, this method returns null.

In shared lines, a few lines on terminals may be restricted. This method returns all the terminals on which this particular address is restricted. Applications cannot see any call events for restricted lines. If a restricted line is involved in a call with any other control device, an external connection gets created for the restricted line.

boolean

isRestricted(javax.telephony.Terminal terminal)

Returns true if any address on this terminal is restricted.
Returns false if no addresses on this terminal are restricted.


public interface CiscoRestrictedEv extends CiscoProvEv { 
	public static final int ID = com.cisco.jtapi.CiscoEventID.CiscoRestrictedEv;

	/**
	 * The following define the cause codes for restricted events
	 */
	
	public final static int CAUSE_USER_RESTRICTED = 1;
	
	public final static int CAUSE_UNSUPPORTED_PROTOCOL = 2;
	
	}

This is the base class for restricted events and defines the cause codes for all restricted events. CAUSE_USER_RESTRICTED indicates the terminal or address is marked as restricted. CAUSE_UNSUPPORTED_PROTOCOL indicates that the device in the control list is using a protocol that is not supported by Cisco Unified JTAPI. Existing Cisco Unified IP 7960 and 7940 phones that are running SIP fall in this category.

CiscoAddrRestrictedEv

Public interface CiscoAddrRestrictedEv extends CiscoRestrictedEv. Applications will see this event when a line or an associated device is designated as restricted from Cisco Unified Communications Manager Administration. For restricted lines, the address will go out of service and will not come back in service until it is activated again. If an address is restricted, addCallObserver and addObserver will throw an exception. For shared lines, if a few shared lines are restricted, and others are not, no exception is thrown, but restricted shared lines will not receive any events. If all shared lines are restricted, an exception is thrown when adding observers. If an address is restricted after adding observers, applications will see CiscoAddrOutOfServiceEv, and when the address is activated, the address will go in service.

CiscoAddrActivatedEv

Public interface CiscoAddrActivatedEv extends CiscoProvEv. Applications will see this event whenever a line or an associated device is in the control list and is removed from the restricted list in the Cisco Unified Communications Manager Administration. If any observers exist on the address, applications will see CiscoAddrInServiceEv. If no observers exist, applications can try to add observers, and the address will go in service.

CiscoAddrRestrictedOnTerminalEv

Public interface CiscoAddrRestrictedOnTerminalEv extends CiscoRestrictedEv. If a user has a shared address in the control list, and if one of the lines is added into the restricted list, this event will be sent. Interface getTerminal() returns the terminal on which the address is restricted. Interface getAddress() returns the address that is restricted.

javax.telephony.Address

getAddress() 

javax.telephony.Terminal

getTerminal() 

CiscoAddrActivatedOnTerminal

Public interface CiscoAddrActivatedOnTerminalEv extends CiscoProvEv. When a shared line or a device that has a shared line is removed from the restricted list, this event will be sent. The interface getTerminal() returns the terminal that is being added to the address. The interface getAddress() returns the address on which the new terminal is added.

javax.telephony.Address

getAddress() 

javax.telephony.Terminal

getTerminal() 

CiscoTermRestrictedEv

Public interface CiscoTermRestrictedEv extends CiscoRestrictedEv. Applications will see this event when a device is added into restricted list from Cisco Unified Communications Manager Administration after the application launches. Applications will not be able to see events for restricted terminals or addresses on those terminals. If a terminal is restricted when it is in InService state, applications will get this event and terminal and corresponding addresses will move to the out-of-service state.

CiscoTermActivatedEv

Public interface CiscoTermActivatedEv extends CiscoRestrictedEv.

javax.telephony.Terminal

getTerminal()

Returns the terminal that is activated and is removed from the restricted list.


CiscoOutOfServiceEv

static int

CAUSE_DEVICE_RESTRICTED

Indicates whether an event is sent because a device is restricted.

static int

CAUSE_LINE_RESTRICTED

Indicates whether an event is sent because a line is restricted.


CiscoCallEv

static int

CAUSE_DEVICE_RESTRICTED

Indicates whether an event is sent because a device is restricted.

static int

CAUSE_LINE_RESTRICTED 

Indicates whether an event is sent because a line is restricted.


Unicode Support

Cisco Unified Communications Manager release 5.0 supports unicode display names on unicode-enabled IP phones. You can configure ASCII names and unicode names for display names. JTAPI receives all names in unicode and ASCII formats and provides two new interfaces, getCurrentCalledPartyUnicodeDisplayName and getCurrentCallingPartyUnicodeDisplayName, to allow applications to get display names in unicode. It also provides the ability to get unicode display names during call progress.

JTAPI receives the encoding capability of application controlled IP phones in device registered and device in service events from CTI, locale and language group information in device info response, and provides interfaces to applications to get the locale, alternate script, and unicode capability of IP phones. CiscoTerminal and CiscoTermInServiceEv interfaces are enhanced to provide this information for phones that are in the application control list when the CiscoTerminal is in the inservice state.

JTAPI receives the alternate script information of all parties in the call and provides interfaces to applications to get the language group of the current calling and current called party. Two interfaces, getCurrentCallingPartyLanguageGroup and getCurrentCalledPartyLanguageGroup, are available on CiscoCall to get this information. Applications also receive both ASCII and UCS-2 encoded unicode display names for the current calling and called addresses.

Unicode support for JTAPI also includes

CiscoCall interface changes

CiscoLocales interface changes

CiscoTerminal / CiscoTerminalInServiceEv interface changes

Applications might need to reconfigure their username/password after upgrading to Release 5.0.

The following sections describe the interface changes for unicode support.

Interface CiscoCall changes

The following new methods on CiscoCall let applications get the unicode display names and the corresponding locales.

/**
	 * This interface returns the unicode display name of the current called party 
	 * in the call.
	 */
	public String getCurrentCalledPartyUnicodeDisplayName();

	/**
	 * This interface returns the locale of the current called party unicode
	 * display name. CiscoLocales interface lists the supported locales.
	 */
	public int getCurrentCalledPartyUnicodeDisplayNamelocale();

	/**
	 * This interface returns the unicode display name of the current calling party
	 * in the call.
	 */
	public String getCurrentCallingPartyUnicodeDisplayName ();

	/**
	 * This interface returns the locale of the current called party
	 * unicode display name
	 */
	public int getCurrentCallingPartyUnicodeDisplayNamelocale();

CiscoLocales

The CiscoLocales interface lists all the locales that Cisco Unified JTAPI supports.


Note For a list of all supported locales in the most recent release, see the "man" page for CiscoLocales.


public interface CiscoLocales
{
	public static final int LOCALE_ENGLISH_UNITED_STATES;
	public static final int LOCALE_FRENCH_FRANCE; 
	public static final int LOCALE_GERMAN_GERMANY;
	public static final int LOCALE_RUSSIAN_RUSSIA ;
	public static final int LOCALE_SPANISH_SPAIN ;
    	public static final int LOCALE_ITALIAN_ITALY ;
    	public static final int LOCALE_DUTCH_NETHERLAND ;
    	public static final int LOCALE_NORWEGIAN_NORWAY ;
    	public static final int LOCALE_PORTUGUESE_PORTUGAL; 
	public static final int LOCALE_SWEDISH_SWEDEN ;
    	public static final int LOCALE_DANISH_DENMARK 
	public static final int LOCALE_JAPANESE_JAPAN; 
	public static final int LOCALE_HUNGARIAN_HUNGARY ;
    	public static final int LOCALE_POLISH_POLAND ;
    	public static final int LOCALE_GREEK_GREECE ;
    	public static final int LOCALE_TRADITIONAL_CHINESE_CHINA;
    	public static final int LOCALE_SIMPLIFIED_CHINESE_CHINA;
    	public static final int LOCALE_KOREAN_KOREA;
}

CiscoTerminalInServiceEv Interface

int

getLocale() 

This method returns the current locale information for this terminal.

int

getSupportedEncoding () 

This method returns true if this terminal supports unicode.


CiscoTerminal Interface

int

getLocale()

This method returns the current locale information for this terminal. The CiscoTerminal must be in the CiscoTerminal.IN_SERVICE state to access this method.

int

getSupportedEncoding ()

This method returns the unicode capability of this Terminal. The CiscoTerminal must be in the CiscoTerminal.IN_SERVICE state to access this method.


getSupportedEncoding () returns one of the following results that are defined in CiscoTerminal.

/** 
  * Indicates the <Code>CiscoTerminal.getSupportedEncoding ()</CODE>
  * for this Terminal is UNKNOWN
*/ 
 public final static int UNKNOWN_ENCODING = 0;

/** 
  * Indicates the <Code>CiscoTerminal.getSupportedEncoding ()</CODE>
  * for this is NOT_APPLICABLE.
  * This is valid for only CiscoMediaTerminals and RoutePoints
*/ 
 public final static int NOT_APPLICABLE = 1;

/** 
  * Indicates the <Code>CiscoTerminal.getSupportedEncoding ()</CODE> for this
  * Terminal is ASCII and this terminal supports only ASCII_ENCODING
*/ 
 public final static int ASCII_ENCODING = 2;

/** 
  * Indicates the <Code>CiscoTerminal.getSupportedEncoding ()</CODE>
  * for this Terminal is UCS2UNICODE_ENCODING 
  */ 
 public final static int UCS2UNICODE_ENCODING = 3;

Linux and Solaris Installation

This feature provides a uniform install / uninstall procedure for the Cisco Unified JTAPI Client on Windows, Linux, and Solaris Platforms. In previous releases the Cisco Unified JTAPI Client installer was provided only for the Windows platform and Application users had to follow manual steps to install it on Linux and Solaris machines.

Cisco Unified JTAPI Install has been developed with InstalledShieldMultiPlatform (ISMP). The Linux and Solaris versions of the installer are provided as a binary file (.bin) and for Windows it is an executable (.exe) file. All three installers are available on the Cisco Unified Communications Manager plug-in page.

The following changes in upgrades and downgrades to/from this release are present in the JTAPI Client on the Windows platform:

The new installer does not support downgrades to previous releases. Application users must manually uninstall JTAPI prior to re-installing any previous version of the JTAPI client.

When you are upgrading from a previous release, the new installer prompts you to uninstall the current version and continues installation only after the previous version of the JTAPI client has been uninstalled.

Applications can bundle the JTAPIInstaller with their installation by using a silent install invocation. Applications that want to run the installer in silent mode can use one of the following commands:

Windows: CiscoJTAPIClient.exe -silent

Linux: CiscoJTAPIClient-linux.bin -silent

Solaris(Sparc): CiscoJTAPIClient-solarisSparc.bin -silent

Solaris(X86): CiscoJTAPIClient-solarisX86.bin -silent

Applications that want to use the JTAPIInstaller from the command line can use one of the following commands from the command prompt:

Windows: CiscoJTAPIClient.exe -console

Linux: CiscoJTAPIClient-linux.bin -console

Solaris (Sparc): CiscoJTAPIClient-solarisSparc.bin -console

Solaris (X86): CiscoJTAPIClient-solarisX86.bin -console

A character-input-based menu guides the installation procedure. The same options are available as in the GUI based installation. This type of installation is best suited to non-GUI platforms like Linux.

When a fresh install or an upgrade/downgrade is performed on a Linux platform, the JTAPIInstaller automatically detects the destination folders and does a silent install. However, if a previous version is present on the system, the installer does not know the applications path and installs the applications in a predetermined location by forcibly creating the folder.

For more information on the JTAPIInstaller, see Chapter 3, "Cisco Unified JTAPI Installation."

JRE 1.2 and JRE 1.3 Support Removal

This release of the CiscoJTAPIClient supports only JRE 1.4. There are no interface changes; however, the JRE 1.2 and 1.3 versions are no longer supported. This change is to support QoS, which is available only in the JDK1.4 version (and above). In addition, jtapi.jar contains Cisco encryption files that depend on the JRE 1.3 version (and above). This provides a stronger password encryption algorithm when it is sent over TCP to CTIManager. As part of this feature, JTAPI invokes the API provided by IMS (Identity Management System, a Cisco Unified Communications Manager component) to encrypt a password before sending it.

JRE 1.4 also enables Cisco Unified JTAPI to use additional JDK 1.4 APIs. Applications that use previous versions of JRE must install JDK 1.4 to use Cisco Unified JTAPI.


Note There are no interface changes to JTAPI Applications, however JTAPI.jar contains RSA's jsafe.jar (3.3) and Apache's log4j-1.2.8.jar files. If Applications are using any jar files that are not compatible with these versions of jsafe.jar (Version 3.3) and log4j-1.2.8.jar, then JTAPI or the Application may not work, depending on which one is in the classpath first


As part of this migration, JTAPIPreferences and sample applications dependency on MS-JVM was also removed. Two new configuration parameters were provided on the Advanced tab in the JTAPI Preferences dialog box:

JTAPI Post Condition Timeout

Use Progress As Disconnected

Superprovider and Change Notification

Superprovider enhancements for JTAPI in this release consist primarily of the following changes.

When the "Superprovider privilege" gets disabled from Cisco Unified Communications Manager Administration after a provider opens, JTAPI gets notified through a CTI Change Notification Event and cleans up all the devices that it has opened that are not in its control list.

JTAPI informs applications about the change using the "CiscoProviderCapabilityChangedEvent." This new event gets issued when the flag changes and indicates whether the flag has been enabled or disabled. When a device that is not in the control list is opened in the Superprovider mode, then moved to the control list, JTAPI moves the device into its control list.

When a normal application receives a "CiscoProviderCapabilityChangedEvent" with the flag set, it means the Superprovider privilege has been granted to it, and it can start acquiring devices not in its control list.

When a Superprovider application receives a "CiscoProviderCapabilityChangedEvent" with the Superprovider flag not set, it means that the Superprovider privilege has been removed for it. The following sequence of events then occurs:

Applications receive a Provider OOS event and all devices acquired/opened by it are closed.

Applications receive a CiscoTermRemovedEv for all devices not in the control list that have been acquired or opened.

Applications receive a Provider inService event when JTAPI succeeds in reconnecting to CTI as a normal user.

Applications receive device and line information.

Applications receive CiscoTermCreatedEv for all controlled devices that were open before the provider went OOS.

JTAPI notifies applications by using the "CiscoProviderCapabilityChangedEvent" when the "park DN monitoring" flag is changed from Cisco Unified Communications Manager Administration.

When an application receives this event with the flag set, it does a register feature for the controlling park DN.

When an application receives this event with the flag not set, JTAPI again informs applications by using a "CiscoProviderCapabilityChangedEvent" and closes all the park DN addresses.

JTAPI notifies applications by using the CiscoProviderCapabilityChangedEvent" when the "change calling party number" flag is changed from Cisco Unified Communications Manager Administration.

When an application receives this event with the flag set, it can change the calling party number.

When an application receives this event with the flag not set, it cannot change the calling party number.

Applications should not change the calling party number when this flag is disabled.

When a device that is not in the control list is opened or acquired by Superprovider, and is then deleted from Cisco Unified Communications Manager Administration, JTAPI closes the terminal object and sends a CiscoTermRemovedEvent to the application for that device.

Interface Changes

As a part of the Superprovider and change notification enhancements, JTAPI exposes the following API to applications. The JTAPI implementation for Superprovider and the handling of certain Provider capabilities has changed as a result. Superprovider enhancements for JTAPI in this release consist of the JTAPI QBE interface, changes in JTAPI behavior, and the new API which is exposed to applications.

JTAPI delivers CiscoProviderCapabilityChangedEv to the applications, with the following format. Applications should be able to receive and process this new event from JTAPI.

public interface CiscoProviderCapabilityChangedEv {
	public CiscoProviderCapabilities getCapability ();
}

CiscoProviderCapabilities have the following new methods for setting calling party modify privilege for the provider:

	public boolean canModifyCallingParty();
   	public void setCanModifyCallingParty(boolean value);

CiscoProviderCapabilityChangedEv is delivered to the applications with the appropriate flag values.

After this, the following sequence of events occurs:

JTAPI sends provider OOS events to the application and device/line OOS to devices and lines in the control list that are open.

JTAPI then tries to reconnect to CTI.

If reconnect succeeds, JTAPI sends a provider inService event and reopens all the devices in the control list that were previously open.

If reconnect does not succeed, JTAPI shuts down the provider and sends a ProviderClosedEvent.

If Superprovider privilege is added, JTAPI sends a CiscoProviderCapabilityChangedEv to the applications with the appropriate flag values.

If the MonitorParkDN flag is enabled, JTAPI sends a CiscoProviderCapabilityChangedEv with the monitor park DN flag set to true.

If the MonitorParkDN flag is disabled, JTAPI sends a CiscoProviderCapabilityChangedEv with the monitor park DN flag set to false.

JTAPI also closes all the park DN addresses and delivers a CiscoAddrRemovedEv to applications.

When the ModifyCgPn flag is changed, JTAPI sets a flag in the provider object that is checked during redirect scenarios, and applications are accordingly allowed or denied permission to change the calling party.

JTAPI also delivers a CiscoProviderCapabilityChangedEv with the flag set to modify CgPn.

CiscoProvider Interface

boolean

hasSuperproviderChanged()

Tells the application whether the Superprovider privilege changed.

boolean

hasModifyCallingPartyChanged()

Tells the application whether the ModifyCgPn privilege changed.

boolean

hasMonitorParkDNChanged()

Tells the application whether the Park DN monitoring privilege changed.


Alternate Script Support

Certain IP phone types support an alternate language script other than the default script that corresponds to the phone-configurable locale. For example, the Japanese phone locale has two written scripts. Some phone types support only the default "Katakana" script, while other phones types support both the default script and the alternate "Kanji" script. Because applications can send text information to the phone for display purposes, they need to know what alternate script a phone supports, if any.

The new getAltScript() method provides alternate script information for an observed device. Currently there is only one known alternate script: "Kanji" for the Japanese locale.

JTAPI provides a new method for CiscoTerminal to provide alternate script information.

java.lang.String

getAltScript()

Only one alternate script, "Kanji" for the Japanese locale, is currently supported. An empty string return value indicates there is no alternate script configured or the terminal does not support an alternate script.


The alternate script feature does not impact JTAPI backward compatibility.

Half-Duplex Media Support

Currently JTAPI media events CiscoRTPInputStarted, CiscoRTPOutputStarted, CiscoRTPInputStopped and CiscoRTPOutputStopped do not indicate whether media is half duplex (receive only / transmit only) or full duplex (both receive and transmit).

This enhancement adds the capability to provide this information in a JTAPI media event. JTAPI provides an interface on the above media events to query whether media is half duplex or full duplex.

The half duplex media support feature does not impact JTAPI backward compatibility.

A new interface getMediaConnectionMode() is added to Cisco Unified JTAPI RTP events. This interface will return the following values depending on the media:

CiscoMediaConnectionMode.NONE

CiscoMediaConnectionMode.RECEIVE_ONLY

CiscoMediaConnectionMode.TRANSMIT_ONLY

CiscoMediConnectionMode.TRANSMIT_AND_RECEIVE.

CiscoRTPInputStarted/StoppedEv should only return RECEIVE_ONLY and TRANSMIT_AND_RECEIVE. The interface should not return NONE or TRANSMIT_ONLY. If that happens, applications should ignore the event or log an error.

CiscoRTPOutputStarted/StoppedEv should only return TRANSMIT_ONLY and TRANSMIT_AND_RECEIVE. The interface should not return values NONE or RECEIVE_ONLY. If that happens, applications should ignore the event or log an error.

CiscoMediaOpenLogicalChannedEv should only return RECEIVE_ONLY and TRANSMIT_AND_RECEIVE. The interface should not return values NONE or TRANSMIT_ONLY. If that happens, applications should ignore the event or log an error.

public interface CiscoRTPInputStartedEv

int

getMediaConnectionMode() 

Returns CiscoMediaConnectionMode


public interface CiscoRTPOutputStartedEv

int

getMediaConnectionMode()

Returns CiscoMediaConnectionMode


public interface CiscoRTPInputStoppedEv

int

getMediaConnectionMode()

Returns CiscoMediaConnectionMode


public interface CiscoRTPOutputStoppedEv

int

getMediaConnectionMode()

Returns CiscoMediaConnectionMode


Recording and Silent Monitoring

This feature lets applications record and silently monitor calls. The caller represents the end point, which calls or receives a call from the monitor target or the recording initiator. The monitor target is the party to monitor (the agent), and the monitoring party is the monitor initiator (the supervisor).

The recording feature lets applications record conversations on any observed address. There are three recording configurations available:

No recording

Automatic recording

The system initiates a recording session, and streams media to the configured recording device whenever a call goes to a connected state.

Application-controlled recording

If application-controlled recording is configured on an address, the application can start and stop recording. The call must exist in the connected state before the application can start recording.

The administrator can set up any one of these recording configurations on a line.

On the successful setup of a recording session that is triggered by either auto recording or an application request, the system sends two audio streams to the recording device: the audio from the recording initiator and the audio from the caller.

The silent monitoring feature lets applications listen to a live conversation between two other parties. The monitor initiator cannot talk to either the monitor target or the caller.

Only an application request can initiate monitoring. The application must send a monitor request for each call that it wants to monitor. The system can only monitor calls that are in a connected state. On the successful completion of a monitor request, the audio stream between the monitor target and the caller streams to the monitor initiator. The monitor target will receive a tone

If the monitor target is configured to receive a tone

If the application requests a tone when it starts the monitor

The recording and silent monitoring features do not support secured calls. Ensure security is disabled on devices that are monitor targets or recording initiators.

Two user groups in Cisco Unified Communications Manager Administration support the recording and silent monitoring feature. Applications can record and monitor calls if they belong to the Standard CTI Allow Call Recording and Standard CTI Allow Call Monitor user groups respectively. The system delivers recording- and monitoring-related events to all call observers. Application see these events if they do not belong to the two special groups.

"Monitor" and "Recording" are reserved words that should not be configured as display names for any lines in the system. Other reserved words are "Conference," "Park Number," "Barge," and "CBarge."

When a monitoring session is established, the terminal observer on the monitoring initiator receives Cisco RTP events. Although the media for a silent monitoring call flows only in one direction, getMediaConnectionMode() would return CiscoMediaConnectionMode.TRANSMIT_AND_RECEIVE instead of CiscoMediaConnectionMode.RECEIVE_ONLY. Applications should expect to see the same behavior in CiscoMediaOpenLogicalChannelEv if a CTIPort is used as the monitor initiator.

When a monitoring call (the call used by the monitor initiator) is conferenced, the final call does not have any connection to the monitor target. When the monitor initiator conferences another party into a monitoring call, both parties can hear the audio between the monitor target and the caller.

The following interfaces extend TermConnEv and are delivered to callobserver. For shared lines, the system delivers these events to call observers on the address or terminal of the talking terminal connections. Applications see no events if they only the terminal whose connection is in the INUSE or BRIDGED state.

CiscoTermConnRecordingStartedEv

CiscoTermConnRecordingStartedEv

Indicates the start of recording and is delivered to the call observer of the recording initiator. Auto recording configuration or by an application request can trigger recording.

CiscoTermConnRecordingEndEv

CiscoTermConnRecordingEndEv

Indicates the end of recording and is delivered to the recording initiator.

CiscoTermConnMonitoringStartEv

CiscoTermConnMonitoringStartEv

Indicates the start of monitoring and is delivered to the call observer on the monitor target. Using getMonitorType() on this event will return the monitor type.

CiscoTermConnMonitoringEndEv

CiscoTermConnMonitoringEndEv

Indicates the end of monitoring and is delivered to the call observer on the monitor target.

CiscoTermConnMonitorInitiatorInfoEv

Exposes monitor initiator information and is delivered to the call observer of the monitor target. This interface has one method:

CiscoMonitorInitiatorInfo getCiscoMonitorInitiatorInfo ()

Returns a CiscoMonitorInitiatorInfo that exposes the terminal name and address of the monitor initiator.

CiscoTermConnMonitorTargetInfoEv

Exposes monitor target information and is delivered to the call observer of monitor target. This interface has one method:

CiscoMonitorInitiatorInfo getCiscoMonitorTargetInfo()

Returns a CiscoMonitorInitiatorInfo that exposes the terminal name and address of the monitor target.

Two new error codes notify applications about monitoring failures:

CTIERR_PRIMARY_CALL_INVALID would be returned by CiscoException.getErrorCode() for exceptions that occurred when a monitoring request fails due to the call going idle or getting transferred.

CTIERR_PRIMARY_CALL_STATE_INVALID would be returned when the monitoring request fails due to the call transitioning to a different state where monitoring cannot be invoked.

This release introduces a new AddressType, MONITORING_TARGET. JTAPI creates a connection on an address of this type for a monitoring target address, CiscoAddress.getType() returns this value.


Tip This feature is backward compatible. Applications will not see any new events unless this feature is configured and used on one of the application-controlled addresses. The administrator can enable this feature by adding JTAPI application users to the Standard CTI Allow Call Recording and Standard CTI Allow Call Monitor user groups.


For detailed information about these interface changes, see the following topics:

CiscoJtapiException

CiscoAddress

CiscoCall

CiscoMediaTerminalConnection

CiscoMediaTerminalConnectionCapabilities

CiscoMonitorTargetInfo

CiscoMonitorInitiatorInfo

CiscoProvider

CiscoProviderCapabilities

CiscoProviderCapabilityChangedEv

CiscoProviderObserver

CiscoRecorderInfo

CiscoTerminalConnection

CiscoTermConnMonitorInitiatorInfoEv

CiscoTermConnMonitorTargetInfoEv

CiscoTermConnRecordingTargetInfoEv

Intercom

The Intercom feature allows one user to call another user and have the call answered automatically with one-way media from the caller to the called party, regardless of whether the called party is busy or idle. The called user can press the talkback softkey (unmarked key) on their phone display, or the called user can invoke the join() JTAPI API, that is provided on TerminalConnection, to start talking to the caller. Only a specially-configured intercom address on the phone can initiate an intercom call. JTAPI creates a new type of address object named CiscoIntercomAddress for intercom addresses that are configured on the phone. The application can get all of the CiscoIntercomAddress that are present in the provider domain by calling the interface getIntercomAddresses () on CiscoProvider.

An intercom call can be initiated from the JTAPI interface by calling the CiscoIntercomAddress.ConnectIntercom () interface. The application provides an intercom target DN for this interface. If the intercom target DN is preconfigured or preset by the application, the application can get the target DN by calling the CiscoIntercomAddress.getTargetDN() interface; otherwise, the application must provide a valid intercom target for the call to be successful.

An intercom call is autoanswered at the intercom target; JTAPI will move TerminalConnection/CallCtlTerminalConnection at the intercom target to the Passive/Bridged state. The application can invoke a join () interface on the TerminalConnection of the intercom target to initiate talk back. If join () is successful, the TerminalConnection/CallCtlTerminalConnection of the intercom target will move to an Active/Talking state. For an intercom call, JTAPI only supports the following interfaces:

Call.drop ()

Connection.disconnect ()

CallCtlTerminalConnection.join ()

The application cannot perform any feature operations on an intercom call. JTAPI will throw an exception if the application invokes redirect, consult, transfer, conference, or park for a Connection on a CiscoIntercomAddress. The application will also receive an exception if it tries to invoke setForwarding (), getForwarding (), cancelForwarding (), unPark (), setRingerStatus (), setMessageWaiting (), getMessageWaiting (), setAutoAcceptStatus (), or getAutoAcceptStatus () on CiscoIntercomAddress.

Applications can get the value of a configured intercom target DN and the label on a CiscoIntercomAddress from the provided API. JTAPI provides two types of APIs: one to return the default and another to return the current value set for the intercom target. The default value is the intercom target DN and label that are preconfigured through Cisco Unified Communications Manager Administration. The current value is the interim target DN and label that are set by the application. If the application has not set the any value, the current value will be same as the default value. Applications can invoke the API setIntercomTarget () on CiscoIntercomAddress to set the intercom target DN, label, and unicode label. Only one application is allowed to set the intercom target, label, and unicode label for an intercom address. If two applications try to set the value, the first succeeds, and the second receives an exception. When a intercom target DN and label changes, JTAPI provides a CiscoAddressIntercomInfoChangedEv to the AddressObserver that is added to CiscoIntercomAddress. If the application has set an intercom target DN and label, and a JTAPI or CTI failover or failback occurs, JTAPI or CTI will restore the previously set value of the intercom target DN, label, and unicode label. If the JTAPI or CTI cannot restore the intercom target DN, label, or unicode label, JTAPI provides a CiscoAddrIntercomInfoRestorationFailedEv to the AddressObserver on CiscoIntercomAddress. In the case of an application failure, or if for any reason the application goes down, the target DN, label, and unicode label will reset to the default. JTAPI provides the interface resetIntercomTarget () on the CiscoIntercomAddress to reset the intercom target.

Auto-answer always stays enabled for CiscoIntercomAddress. The application can invoke the method getAutoAnswerEnabled () on CiscoAddress to get the auto-answer capability of an address.

For an intercom target that is connected with one-way media to the Intercom initiator, the device state would be set to CiscoTermDeviceStateWhisper. This is a new device state for the Terminal object. In this state, the Terminal can initiate a new call or receive a new incoming call. If the application enables a filter to receive this device state, the application receives CiscoTermDeviceStateWhisperEv. The application can enable a filter by calling setDeviceStateWhisperEvFilter() on CiscoTermEvFilter. The DeviceStates DEVICESTATE_ACTIVE, DEVICESTATE_HELD, DEVICESTATE_ALERTING all override DEVICESTATE_WHISPER; if one call exists in either the active, held, or alerting state, and another in whisper, the DeviceState will be DEVICESTATE_ACTIVE, DEVICESTATE_HELD, or DEVICESTATE_ALERTING, respectively.


Note The Cisco JTAPI implements the javax.telephony.TerminalConnection interface join() to let the intercom target talk back to the initiator. The system implements this interface for CiscoIntercomAddresses only. If applications invoke this interface for regular shared lines in a passive or bridged state, JTAPI throws a MethodNotImplimented exception.



Tip This feature is backward compatible if the application-controlled devices (Terminals) do not have intercom lines configured on them. Applications can disable the intercom feature by not having an intercom line configured on the application-controlled devices (terminals).


For detailed information about these interface changes, see the following topics:

CiscoIntercomAddress

CiscoAddrIntercomInfoRestorationFailedEv

CiscoAddress

CiscoCall

CiscoProvider

CiscoTermEvFilter

CiscoTerminal

CiscoTerminalConnection

CiscoTermDeviceStateWhisperEv

Arabic and Hebrew Language Support

This version of the Cisco JTAPI supports the Arabic and Hebrew languages, which users may select during installation and in the Cisco JTAPI Preferences user interface. For more information about supported locales and languages, see the "man" page for CiscoLocales.


Tip This feature is backward compatible.


Do Not Disturb

Do-Not-Disturb gives phone users the ability to go into a Do Not Disturb (DND) state on the phone when they are away from their phones or do not want to answer the incoming calls. The DND softkey enables and disables this feature.

From the user pages, users can configure the following settings for DND:

DND Option-Ringer off

DND Incoming Call Alert-beep only/flash only/disable

DND Timer-value between 0-120 minutes. It specifies a "period in minutes to remind the user that DND is active".

DND status-on/off


Note The Application can only enable or disable the DND status.


The Application can set the DND status by invoking a new interface on CiscoTerminal.

JTAPI will also query the application about any change in the DND status when DND status is set by phone, Cisco Unified Communications Manager Administration, or application.

The application must enable the filter in CiscoTermEvFilter to receive the preceding notification.

The application can also query for the DND status through a new interface on CiscoTerminal.

The application can also query for the DND option through a new interface on CiscoTerminal.


Note This feature applies to phones and CTI ports. It does not apply to Route points.


In the case of emergency calls (made by a CER application) landing on an application that has DND enabled, the system overrides the DND settings and presents the call to the application. A new parameter, FeaturePriority, in the redirect() and selectRoute() APIs on CiscoCall, CiscoConnection, and CiscoRouteSession, respectively, makes this possible. The CER application that initiates the emergency call sets FeaturePriority as FeaturePriority_Emergency. The application will set the feature priority only for emergency calls. In the case of normal calls, applications will either not set the feature priority at all or set it to FeaturePriority_Normal. Applications will not set FeaturePriority_Emergency in case of normal calls. When initiating feature calls such as Intercom, applications need to specify FEATUREPRIORITY_URGENT.


Note The connect() API on CiscoCall does not support the FeaturePriority parameter.


The application will receive an exception if it tries to perform a getDNDStatus(), setDNDStatus() or getDNDOption() before the device is in service.

A Post condition has been added to DND to handle a DB update failure or device out-of-service situations if they occur after the setDNDStatus() request is sent. If a DB update failure or device out-of-service condition occurs after the setDNDStatus() request is sent, setDNDStatus() delivers a CiscoTermDNDStatusChangedEv to the application. If this event is not received, a post-condition time-out occurs, and the following exception is thrown: could not meet post conditions of setDNDStatus().


Tip This feature is backward compatible. Applications will see new events if this feature is configured. You can filter the new events through the TerminalEventFilter interface (CiscoTermEvFilter). By default this filter is disabled and the system does not deliver the new events.


For additional information, see the following topics:

CiscoTerminal

CiscoTermDNDStatusChangedEv

CiscoTermEvFilter

CiscoCall

CiscoConnection

CiscoRouteSession

CiscoTermInServiceEv

Secure Conferencing

This feature informs applications whether a call is secure, allowing for secure conference calls. When the overall security status of the call changes, secure conferencing provides applications with a notification in the form of an event on the call. Applications receive the overall call security status of the call in the CiscoCallSecurityStatusChangedEv when the overall call security status changes. When a terminal goes to the talking state, JTAPI provides the call security status information to the applications. Applications can query the security status of the call by using a new interface on CiscoCall. The system makes the security status information available to applications when the applications start monitoring an existing call.

In shared address scenarios, the system also reports CiscoCallSecurityStatusChangedEv to the RIU parties. The OverallCallSecurityStatus matches the status reported on the active terminals. For example, in a three-party conference with A (Encrypted), B (Encrypted), C (Authenticated), and C' (Authenticated), the system reports CiscoCallSecurityStatusChangedEv with OverallCallSecurityStatus = Authenticated to C and C'. The system delivers this event on a per-call basis.

SRTP key information will continue to be sent for encrypted parties whether or not the OverallCallSecurityStatus is Encrypted. For example, in a three-party conference with A (Encrypted), B (Encrypted), and C (non-secure), the OverallCallSecurityStatus of the conference call is NotAuthenticated. However, the media connecting A, B, and the conference bridge will continue to be Encrypted because they are encrypted parties. Thus, A and B will receive SRTP keys despite the OverallCallSecurityStatus.


Tip This feature is backward compatible. The new parameter "EnableSecurityStatusChangedEv" in the jtapi.ini file controls the new event CiscoCallSecurityStatusChangedEv generated by the secure conferencing feature. Applications can turn on this parameter by adding the line "EnableSecurityStatusChangedEv=1" to the jtapi.ini file to receive this new event. By default, this parameter does not appear in the jtapi.ini file, so event notification is disabled. The setCallSecurityStatusChangedEv( ) interface on com.cisco.jtapi.extensions.CiscoJtapiProperties lets applications set this ini parameter programmatically.


For additional information, see CiscoCallSecurityStatusChangedEv.

SIP Phone Support

In release 5.0, JTAPI supported an initial feature set on SIP phones. The 6.0 release adds support for the following functionality on SIP phones:

Park for SIP Phones

Unpark for SIP Phones


Tip The order of events for consult calls is different for SIP and SCCP phones. Consider the following scenario:


a. Terminal A initiates a call to the shared line B/B'.

b. The shared line initiates a consult call to Terminal C.

If the shared line is a SIP device, the call events are:

B (active) receives: OnHold -> Select -> NewCall

B' (remote-in-use) receives: Select -> NewCall -> OnHold

However, if the shared line is a SCCP device, the call events are Select -> OnHold -> NewCall on both terminals.

If the application is only monitoring B', call.getConsultingTerminalConnection() may return null.

Cisco Unified IP 7931G Phone Interaction

You can configure Cisco Unified IP 7931G phones in two modes:

NoRollOver

RollOver (across the same DN or across different DNs).

When Cisco Unified IP 7931G phones are configured in NoRollOver mode, they operate like regular SCCP phones, and in this mode transfers or conferences cannot be made across the different addresses. JTAPI will support controlling and monitoring of a 7931G phone when it is configured in NoRollOver mode.

In RollOver mode, Cisco Unified IP 7931G phones support transfer or conference across different addresses. In this mode, JTAPI does not allow controlling and monitoring of a Cisco Unified IP 7931G phone. Applications see such terminal/addresses as restricted. If a Cisco Unified IP 7931G phone is in the control list of an application user and the phone configuration changes from NoRollOver to RollOver mode, JTAPI sends a CiscoAddrRestrictedEv event for addresses on the Cisco Unified IP 7931G phone and sends a CiscoTermRestrictedEv for terminals, with cause CiscoRestrictedEv.CAUSE_UNSUPPORTED_DEVICE_CONFIGURATION.

However, if the phone configuration changes from RollOver to NoRollOver mode, JTAPI sends a CiscoAddrActivatedEv event for addresses on the Cisco Unified IP 7931G phone and sends a CiscoTermActivatedEv for terminals.

If a Cisco Unified IP 7931G phone that is configured in RollOver mode transfers or conferences to JTAPI-controlled addresses, JTAPI applications will not see a common controller in the final and the consult call. This would provide different behavior to the JTAPI application. Depending on how the JTAPI application is processing information that is provided in events, applications may require changes to handle JTAPI events for this transfer or conference scenario.

You can disable transfers and conferences across the line by configuring the Cisco Unified IP 7931G phone to NoRollOver mode through the phone configuration window of Cisco Unified Communications Manager Administration.

There are two new cause codes for the CiscoRestrictedEv interface. When the terminal or address is restricted because a Cisco Unified IP 7931G phone is configured in RollOverMode, JTAPI sends CiscoAddrRestrictedEv with cause CiscoRestrictedEv.UNSUPPORTED_DEVICE_CONFIGURATION. This release also introduces a default cause code CAUSE_UNKNOWN, which applications should handle.


Tip This feature is backward compatible. You can disable this feature by configuring all Cisco Unified IP 7931G phones in a cluster in NoRollOver mode or by not having any Cisco Unified IP 7931G phones in a Cisco Unified Communications Manager cluster. If any phone in a Cisco Unified Communications Manager cluster is configured with RollOver mode, it may cause changes to the behavior of JTAPI-controlled addresses and terminals.


For more information, see CiscoRestrictedEv.

Version Format Change

In release 6.0, the Cisco JTAPI version changes from a 4-digit format to a 5-digit format similar to the format used by Cisco Unified Communications Manager. The JTAPI version will remain similar to the Cisco Unified Communications Manager version. New interfaces let applications get the extended version number. See CiscoJtapi Version.


Tip This feature is backward compatible.


Querying the Calling Party IP Address

Extensions to CallCtlConnOfferedEv and RouteEvent provide a method for retrieving the IP address of the calling party. This feature provides the calling party IP address to the destination side of basic calls, consultation calls for transfer and conference, and basic redirect and forwarding. The system does not support other scenarios and feature interactions, including those where the calling party changes. This feature only supports IP phones as calling party devices, although IP address of other calling devices may also be provided. See CiscoCallCtlConnOfferedEv and CiscoRouteEvent.


Tip This feature is backward compatible.


Multilevel Precedence and Preemption (MLPP) Support

Cisco Unified Communications Manager enables the use of supplementary services by phones that are configured for MLPP. Cisco Unified Communications Manager does this by maintaining the precedence level for calls.

JTAPI does not provide the precedence level of applications.

Non-Controller Adding of Parties to Conferences

Any party in a conference can now add participants into the conference. In previous releases, only the conference controller could add participants.

CiscoConferenceStartEv contains an identifier for the requestor party.

The method getConferenceControllerAddress returns the terminal connection of the requestor.

The new method getOriginalConferenceControllerAddress() for CiscoConferenceStartEv returns the terminal connection of the original controller.

Conference Chaining

The conference chaining feature lets applications join two separate conference calls together. JTAPI applications see chained conference calls represented as two separate calls. When conference calls are chained, JTAPI creates a new connection for the conference chain and provides the CiscoConferenceChainAddedEv event on CallCtlCallObserver. When the conference chain is removed from the call, JTAPI disconnects the conference chain connection and provides the CiscoConferenceChainRemovedEv event on CallCtlCallObserver. From CiscoConferenceChainAdded/RemovedEv, applications can obtain CiscoConferenceChain, which provides a link for all the conference chain connections.

Figure 1-11 shows parties A, B, and C in conference call GC1 and parties C, D, and E in conference call GC2.

Figure 1-11 Calls Prior to Chaining

After the conference chain is created, the calls will look like Figure 1-12:

Figure 1-12 Calls After Chaining

Applications may get all of the participants of a chained conference from the CiscoChainedConference object, which provides conference chain connections from all the conference calls that are chained together. By browsing through the connections list, applications can get a list of all the chained conference calls; however, applications need to have at least one participant of each conference observed.


Note For any conference scenario that involves chaining conferences or adding parties to a chained conference call, JTAPI will not provide ConferenceStarted/Ended event.


For more information, see the following topics:

CiscoCall (for the new getConferenceChain() interface)

CiscoConferenceChain

CiscoConferenceChainAddedEv

CiscoConferenceChainRemovedEv

Forwarding on No Bandwidth & Unregistered DN

This feature enhances the forwarding logic to handle the No Bandwidth & Unregistered DN cases:

No Bandwidth: When a call cannot be delivered to a remote destination due to no bandwidth, the system reroutes the call to the AAR Destination Mask or Voice Mail. The user makes these configuration changes from the directory number window of the Cisco Unified Communications Manager GUI.

Unregistered DN: When a call is placed to an unregistered DN, the system delivers the call to a DN that is configured for Call Forward on No Answer (CFNA), as in releases prior to release 6.0.

When a call is forwarded due to Call Forward No Bandwidth (CFNB) to another cluster destination over a trunk/gateway using QSIG then call history might get lost. For example, if Phone A calls Phone B, which is in a low bandwidth location, with CFNB set to forward calls to Phone C, which is in a different cluster, and the QSIG protocol is used for this intercluster forwarding, then the original called party and the last redirecting party might not get passed to the destination party.

Directed Call Park

This feature allows the user to park a call by transferring the call to a user-selected park code.

Examples

A calls B; B transfers the call to a dPark DN. On completion of the transfer, the A to B call is parked at the specified dPark DN. A will receive MOH (if configured). When C unparks the call (by dialing the prefix code and park code), A and C connect.

If A calls the dPark DN directly, A connects to the dPark DN and the system marks this dPark DN as busy. A stays connected to this dPark DN until park reversion.

If C does not unpark the call at the dPark DN, the call park reverses back to the DN that parked the call (B), and A and B connect again. B can again try to d-Park to another dPark DN. When park reversion occurs, Cisco Unified Communications Manager JTAPI passes a new reason code to the application.

CTI sends the dPark number to Cisco Unified Communications Manager JTAPI in the form "Park Number : (<Prefix Code>)<DPark DN>". Cisco Unified Communications Manager JTAPI parses this and exposes both "Prefix Code" and "DPark DN" to applications.

When a call is unparked, the parked party and unparking party both receive a CPIC event with the reason given by CTI, and the parked party connects to the unparking party.

When party A calls a dPark DN and party B also calls the same dPark DN, the system can connect either A or B to the dPark DN, and the other party will be disconnected.

Cisco Unified Communications Manager JTAPI Support

Cisco Unified Communications Manager JTAPI supports this feature. When the system transfers a call to a directed call park DN (dparked), the application sees a connection created for directed call park DN, and the call control connection state is CallControlConnection.QUEUED. The system delivers CiscoTransferstart and end events. An application can use the new interface on CiscoConnection to get the prefix code needed to unpark the call.

Performance and Scalability

This feature provides the same performance impact as the existing transfer feature.

Voice MailBox Support

This feature exposes voice mailbox numbers, which let Cisco Unified Communications Manager JTAPI applications forward calls from a directory number to the correct voice mailbox.

The Cisco Unified Communications Manager Administrator can associate a voicemail profile for each directory number. When the voicemail option is enabled for any forward setting, and if the corresponding forward is enabled, the call rolls down to the voicemail pilot number that is associated with the voicemail profile.

The voicemail profile contains voicemail pilot number and voicemailboxmask fields. Voicemailboxmask specifies the mask that is used to format the voicemail box number for auto-registered phones. When forwarding a call to a voice messaging system from a directory line on an auto-registered phone, Cisco Unified Communications Manager applies this mask to the number that is configured in the Voice Mail Box field for that directory line.

For example, if you specify a mask of 972813XXXX, the voice mailbox number for directory number 7253 becomes 9728137253. If you do not enter a mask, the voice mailbox number matches the directory number (7253 in this example).

Cisco Unified Communications Manager JTAPI Support

To support this feature, Cisco Unified Communications Manager JTAPI exposes voicemail box numbers for called party, lastRedirected party and originalCalled party. These voicemailbox fields are exposed on CiscoPartyInfo, which is exposed on CiscoCall object. If voicemail is not configured for a party, then Cisco Unified Communications Manager JTAPI will return empty Strings for voicemailbox fields.

In prior releases Cisco Unified Communications Manager JTAPI did not expose voicemailbox fields to applications, so Cisco Unified Communications Manager JTAPI voicemailbox applications could not determine whether a voicemailboxmask was configured for a voicemail profile, which could result in a voicemailbox number that is different from the directory number.

The new interfaces for CiscoCall are:

getCalledPartyInfo()

getCurrentCalledPartyInfo()

getLastRedirectedPartyInfo()

The new interface for CiscoPartyInfo is getVoiceMailbox().

Performance and Scalability

This feature does not increase the traffic from the Cisco Unified Communications Manager JTAPI layer to the application layer. However, there could be small performance impact because of additional fields passed over the network.

Privacy On Hold

This feature enhances the privacy of private held calls. When privacy is enabled, only the phone that placed a call on hold can retrieve that call, and the calling name and number are not displayed.

The feature provides a shared address the ability to determine whether other shared addresses may barge into a call. When privacy is enabled, other shared address cannot barge into the call. Privacy is a terminals property. On IP phones there is a Privacy feature button to enable and disable the privacy feature. Privacy can be dynamically enabled and disabled for the active calls on the terminal. When Privacy is on for a call, the TerminalConnection state available to other shared addresses is set to "In Use." If Privacy status is changed during the CallProgress, CiscoTermConnPrivacyChangedEvent is delivered to the application.

In prior releases, if Privacy is enabled and the call is put on hold, then all TerminalConnections will be in TermConnHeld state and any other shared Address terminalConnection can unhold the call. In Cisco Unified Communications Manager 4.2, if the "Enforce Privacy on Held Calls" service parameter is enabled, and if Privacy is enabled for a call, then putting the call on hold does not change the terminalConnections of other shared addresses and they remain in the "In Use" state.

Performance and Scalability

There is no performance impact with this feature because there is no additional traffic generated between Cisco Unified JTAPI, applications, and Cisco Unified Communications Manager.

CiscoRTPHandle Interface on Cisco RTP Events

The following interfaces are enhanced to allow applications to get a CiscoRTPHandle from the events:

CiscoRTPInputStartedEv

CiscoRTPInputStoppedEv

CiscoRTPOutputStartedEv

CiscoRTPOutputStoppedEv

CiscoRTPHandle represents the calleg ID of the call in Cisco Unified Communications Manager and stays the same as long as the call is active on the terminal. At any particular terminal/address, although the call and the associated GCID can change, CiscoRTPHandle will remain constant.

Hold Reversion

The Hold Reversion feature provides applications with a notification, when Cisco Unified Communications Manager notifies an address about the presence of a held call, when the call has been ONHOLD for a certain amount of time. Applications receive this notification as the CiscoCallCtlTermConnHeldReversionEv call control terminal connection event on their call observers on the particular address which has put the call ONHOLD. This notification is provided only once for the applications for the held call.

The event is sent only to the terminal connection of the terminal where the call was put on hold. If the address represents a shared line address, other terminal connections of the shared line address will not receive the event.

To receive this event, applications must add a call observer to the address. The cause for this event will be CAUSE_NORMAL. If the call observer is added after the hold reversion timer has expired and the notification has already been sent to the phone, applications will receive CiscoCallCtlTermConnHeldReversionEv with cause CAUSE_SNAPSHOT.

For more information, see CiscoCallCtlTermConnHeldReversionEv.

Translation Pattern Support

If a callingparty transformation mask is configured for a translation pattern that is applied to a JTAPI application-controlled Address, the application may see extra connections created and disconnected when both the calling and called party are observed. A Connection is created for a transformed calling party instead of the actual calling party and CiscoCall.getCurrentCallingParty() would return the transformed calling party, when only the called party is observed. In general, JTAPI might not be able to create the appropriate Connection in the Call, and might not be able to provide correct information for currentCalling, currentCalled, calling, called, and lastRedirecting parties.

For example, consider a translation pattern X that is configured with a calling party transformation mask Y and calledparty transformation mask B. If A calls X, the call goes to B. In this scenario:

If the application is observing only B, JTAPI creates a Connection for Y and B, and CiscoCall.getCurrentCallingParty() would return Address Y.

If the application is observing both A and B, a Connection for A and B gets created, a Connection for Y gets temporarily created and dropped, and CiscoCall.getCurrentCallingParty() would return Address Y.

There could be other inconsistencies in the calling information if further features get performed on a basic call. Cisco recommends that you not configure a callingparty transformation mast for a translation pattern that might get applied to JTAPI application-controlled addresses.