Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 9.0(1)
Cisco Unified JTAPI Extensions
Downloads: This chapterpdf (PDF - 2.47MB) The complete bookPDF (PDF - 13.1MB) | Feedback

Cisco Unified JTAPI Extensions

Table Of Contents

Cisco Unified JTAPI Extensions

Class Hierarchy

CiscoAddressCallInfo

Declaration

Constructors

Fields

Methods

Inherited Methods

Related Documentation

CiscoG711MediaCapability

Declaration

Constructors

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoG723MediaCapability

Declaration

Constructors

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoG729MediaCapability

Declaration

Constructors

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoGSMMediaCapability

Declaration

Constructors

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoJtapiVersion

Declaration

Constructors

Fields

Methods

Inherited Methods

Related Documentation

CiscoMediaCapability

Declaration

Subclasses

Constructors

Fields

Methods

Inherited Methods

Related Documentation

CiscoRegistrationException

Declaration

Implemented Interfaces

Constructors

Methods

Inherited Methods

Related Documentation

CiscoRTPParams

Declaration

Constructors

Fields

Methods

Inherited Methods

Related Documentation

CiscoUnregistrationException

Declaration

Implemented Interfaces

Constructors

Fields

Methods

Inherited Methods

Related Documentation

CiscoWideBandMediaCapability

Declaration

Constructors

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

Interface Hierarchy

CiscoAddrActivatedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrActivatedOnTerminalEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrAddedToTerminalEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrAutoAcceptStatusChangedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrCreatedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrMonitorTerminatedEv

Declaration

Methods

Related Documentation

CiscoAddress

Superinterfaces

Subinterfaces

Fields

Methods

Inherited Methods

Related Documentation

CiscoAddressObserver

Superinterfaces

Declaration

Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrEv

Superinterfaces

Subinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrEvFilter

Fields

Methods

Inherited Methods

Parameters

Value Range

Related Documentation

CiscoAddrInServiceEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrIntercomInfoChangedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrIntercomInfoRestorationFailedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrPickupGroupChangedEv

Declaration

Methods

New Error Code

CiscoAddrOutOfServiceEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrParkStatusEv

Declaration

Fields

Inherited Fields

Methods

Value Ranges

Related Documentation

CiscoAddrRecordingConfigChangedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrRemovedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrRemovedFromTerminalEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrRestrictedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrRestrictedOnTerminalEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoAddrVoiceMailPilotChangedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoBaseMediaTerminal

Declaration

Superinterfaces

Fields

Inherited Fields

Methods

Inherited Methods

Parameters

Data Types

Range of Values

CiscoCall

Superinterfaces

Subinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Parameters

Conference Controller

Telephone Call Argument

Other Shared Participants

The Transfer Controller

The New Connection

Related Documentation

CiscoCallChangedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoCallConsultCancelledEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoCallCtlConnOfferedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoCallCtlTermConnHeldReversionEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoCallEv

Superinterfaces

Subinterfaces

Declaration

Fields

Inherited Fields

Methods

Related Documentation

CiscoCallFeatureCancelledEv

Declaration

Methods

Related Documentation

CiscoCallID

Superinterfaces

Declaration

Fields

Methods

Inherited Methods

Related Documentation

CiscoMediaCallSecurityIndicator

Declaration

Fields

Methods

Related Documentation

CiscoCallSecurityStatusChangedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoConferenceChain

Declaration

Fields

Methods

Related Documentation

CiscoConferenceChainAddedEv

All Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoConferenceChainRemovedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoConferenceEndEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoConferenceStartEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoConnection

All Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Documentation

CiscoConnectionID

Superinterfaces

Declaration

Fields

Methods

Inherited Methods

Related Documentation

CiscoConnectionUniqueIDChangedEv

Declaration

Methods

Related Documentation

CiscoConsultCall

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoConsultCallActiveEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoEv

Superinterfaces

Subinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoFeatureReason

Declaration

Fields

Related Documentation

CiscoHuntConnection

Declaration

Methods

Related Documentation

CiscoIntercomAddress

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoIsacMediaCapability

Superinterfaces

Declaration

Constuctors

Fields

Inherited Fields

Methods

Inherited Methods

CiscoJtapiException

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoMediaStreamStartedEv

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

CiscoMediaStreamEndedEv

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

CiscoJtapiPeer

Superinterfaces

Declaration

Fields

Methods

Inherited Methods

Related Documentation

CiscoJtapiPeerImpl

Declaration

Fields

Methods

CiscoJtapiProperties

Declaration

Fields

Methods

User/InstanceID Hashtable

Related Documentation

CiscoLocales

Declaration

Fields

Methods

Related Documentation

CiscoMediaConnectionMode

Declaration

Fields

Methods

Related Documentation

CiscoMediaEncryptionAlgorithmType

Superinterfaces

Fields

Related Documentation

CiscoMediaEncryptionKeyInfo

Declaration

Fields

Methods

Related Documentation

CiscoMediaOpenIPPortEv

Declaration

Superinterfaces

Fields

Inherited Fields

Methods

Inherited Methods

CiscoMediaOpenLogicalChannelEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoMediaSecurityIndicator

Declaration

Fields

Related Documentation

CiscoMediaTerminal

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoMonitorInitiatorInfo

Declaration

Fields

Methods

Related Documentation

CiscoMonitorTargetInfo

Declaration

Fields

Methods

Related Documentation

CiscoObjectContainer

Subinterfaces

Declaration

Fields

Methods

Related Documentation

CiscoOutOfServiceEv

Superinterfaces

Subinterfaces

Declaration

Fields

Inherited Fields

Methods

Related Documentation

CiscoPartyInfo

Declaration

Fields

Methods

Related Documentation

CiscoPickupGroup

Declaration

Methods

Related Documentation

CiscoProvCallParkEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoProvEv

Superinterfaces

Subinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

CiscoProvFeatureEv

Superinterfaces

Subinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoProvFeatureID

Declaration

Fields

Methods

Related Documentation

CiscoProvPickupCallAlertEv

Declaration

Methods

CiscoProvTerminalIPAddressChangedEv

Declaration

Fields

Methods

Related Documentation

CiscoProvTerminalRegisteredEv

Declaration

Fields

Methods

Related Documentation

CiscoProvTerminalUnRegisteredEv

Declaration

Fields

Methods

Related Documentation

CiscoProvider

Superinterfaces

Declaration

Fields

Inherited Fields

New Error Codes

Methods

Inherited Methods

Related Documentation

CiscoProviderCapabilities

Superinterfaces

Declaration

Methods

Inherited Methods

Related Documentation

CiscoProviderCapabilityChangedEv

Declaration

Fields

Methods

Related Documentation

CiscoProviderObserver

Superinterfaces

Declaration

Methods

Inherited Methods

Related Documentation

CiscoProvTerminalCapabilityChangedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoProvTerminalRemoteDestinationChangedEv

Methods

CiscoRecorderInfo

Declaration

Fields

Methods

Range of Values

Related Documentation

CiscoRemoteDestinationInfo

Methods

CiscoRemoteTerminal

Declaration

Methods

Parameters

Data type

New Error Codes

Sample Code

CiscoRestrictedEv

Superinterfaces

Subinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRouteAddress

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRouteEvent

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRouteSession

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRouteTerminal

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRouteUsedEvent

Superinterfaces

Declaration

Fields

Methods

Inherited Methods

Related Documentation

CiscoRTPBitRate

Declaration

Fields

Methods

Related Documentation

CiscoRTPHandle

Declaration

Fields

Methods

Related Documentation

CiscoRTPInputKeyEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRTPInputProperties

Declaration

Fields

Methods

Related Documentation

CiscoRTPInputStartedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRTPInputStoppedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRTPOutputKeyEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRTPOutputProperties

Declaration

Fields

Methods

Related Documentation

CiscoRTPOutputStartedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRTPOutputStoppedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRTPOutputKeyEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRTPOutputProperties

Declaration

Fields

Methods

Related Documentation

CiscoRTPOutputStartedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRTPOutputStoppedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoRTPPayload

Declaration

Fields

Methods

Related Documentation

CiscoSynchronousObserver

Declaration

Fields

Methods

Related Documentation

CiscoTermActivatedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermButtonPressedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermConnMonitoringEndEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermConnMonitoringStartEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermConnMonitorInitiatorInfoEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermConnMonitorTargetInfoEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermConnPrivacyChangedEv

Declaration

Fields

Methods

Related Documentation

CiscoTermConnRecordingEndEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermConnRecordingStartEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermConnRecordingTargetInfoEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Related Documentation

CiscoTermConnSelectChangedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermCreatedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermDataEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermDeviceStateActiveEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermDeviceStateAlertingEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermDeviceStateHeldEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermDeviceStateIdleEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermDeviceStateWhisperEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermDNDOptionChangedEv

Superinterfaces

Fields

Methods

CiscoTermDNDStatusChangedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermEv

Superinterfaces

Subinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermEvFilter

Declaration

Fields

Methods

Related Documentation

CiscoTerminal

Superinterfaces

Subinterfaces

Declaration

Fields

Methods

Inherited Fields

Data Type

Related Documentation

CiscoTerminalConnection

Superinterfaces

Declaration

Fields

Inherited Fields

Parameters

New Error Codes

Methods

Inherited Methods

Related Documentation

CiscoTerminalObserver

Superinterfaces

Declaration

Fields

Methods

Inherited Methods

Related Documentation

CiscoTerminalProtocol

Superinterfaces

Fields

Related Documentation

CiscoTermInServiceEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermOutOfServiceEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermRegistrationFailedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermRemovedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermRestrictedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermSnapshotCompletedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTermSnapshotEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTone

Superinterfaces

Fields

CiscoToneChangedEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTransferEndEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoTransferStartEv

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoUrlInfo

Declaration

Fields

Methods

Related Documentation

ComponentUpdater

Declaration

Methods

Related Documentation

ProviderPickupNotificationRegistrationClosedEv

Declaration

Methods

New Reason Code

Related Documentation


Cisco Unified JTAPI Extensions


The Cisco Unified JTAPI extension consists of a set of classes and interfaces that expose the additional functionality not readily exposed in JTAPI 1.2 specification but are available in Cisco Unified Communications Manager. Developers can use the extensions to create new applications or modify existing extensions to create new methods.

This chapter describes the extensions (interfaces and classes) that are available for implementation in a Cisco Unified Communications Manager and contains the following sections:

Class Hierarchy

Interface Hierarchy

Class Hierarchy

The following class hierarchy is contained in the com.cisco.jtapi.extensions package.

hierarchy.java.lang.Object

com.cisco.jtapi.extensions.CiscoAddressCallInfo

com.cisco.jtapi.extensions.CiscoJtapiVersion

com.cisco.jtapi.extensions.CiscoMediaCapability

com.cisco.jtapi.extensions.CiscoG711MediaCapability

com.cisco.jtapi.extensions.CiscoG723MediaCapability

com.cisco.jtapi.extensions.CiscoG729MediaCapability

com.cisco.jtapi.extensions.CiscoGSMMediaCapability

com.cisco.jtapi.extensions.CiscoWideBandMediaCapability

com.cisco.jtapi.extensions.CiscoRTPParams

java.lang.Throwable (implements java.io.Serializable)

java.lang.Exception

     com.cisco.jtapi.extensions.CiscoRegistrationException

     com.cisco.jtapi.extensions.CiscoUnregistrationException

CiscoAddressCallInfo

Class History

Cisco Unified Communications Manager Release
Description

7.1 (2)

Added the history table to track changes.


Declaration

public class CiscoAddressCallInfo extends java.lang.Object

java.lang.Object

          com.cisco.jtapi.extensions.CiscoAddressCallInfo

Constructors

CiscoAddressCallInfo (int inumActiveCalls, int imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold)

CiscoAddressCallInfo (int inumActiveCalls, int imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold, CiscoCall[] icalls)

Fields

None

Methods

Table 6-1 CiscoAddressCallInfo Methods 

Interface
Method
Description

CiscoCall[]

getCalls()

Returns the array of Cisco calls on the CiscoAddress.

int

getMaxActiveCalls()

Returns the maximum number of active calls supported on the CiscoAddress, as an integer.

int

getMaxCallsOnHold()

Returns the maximum number of calls that can be put on hold on the CiscoAddress, as an integer.

int

getNumActiveCalls()

Returns the number of active calls on the CiscoAddress, as an integer.

int

getNumCallsOnHold()

Returns the number of held calls on the CiscoAddress, as an integer.


Inherited Methods

From Class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Related Documentation

None

CiscoG711MediaCapability

The CiscoG711MediaCapability object specifies the properties for a G.711 encoded RTP stream. Applications that support G.711 media termination use this object to specify their preferred packet size when registering a CiscoMediaTerminal. The default packet size is thirty milliseconds.

Class History

Cisco Unified Communications Manager Release
Description

7.1(x)

Added history table to track changes.


Declaration

public class CiscoG711MediaCapability extends CiscoMediaCapability

java.lang.Object

          com.cisco.jtapi.extensions.CiscoMediaCapability

                    com.cisco.jtapi.extensions.CiscoG711MediaCapability

Constructors

Table 6-2 Constructors in CiscoG711MediaCapability

Interface
Constructor
Description

public

CiscoG711MediaCapability(int rtpPacketFrameSize)

Constructs a CiscoG711MediaCapability.

public

CiscoG711MediaCapability()

Constructs a CiscoG711MediaCapability.


Fields

Table 6-3 Fields in CiscoG711MediaCapability

Interface
Field
Description

public static final int

FRAMESIZE_TWENTY_MILLISECOND_PACKET

RTP Packet Framesize: Twenty millisecond RTP packet.

public static final int

FRAMESIZE_THIRTY_MILLISECOND_PACKET

RTP Packet Framesize: Thirty millisecond RTP packet.

public static final int

FRAMESIZE_SIXTY_MILLISECOND_PACKET

RTP Packet Framesize: Sixty millisecond RTP packet.


Inherited Fields

From Class com.cisco.jtapi.extensions.CiscoMediaCapability

G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, GSM_80_MILLISECONDS, WIDEBAND_256K_10_MILLISECONDS

Methods

None

Inherited Methods

From Class com.cisco.jtapi.extensions.CiscoMediaCapability

getMaxFramesPerPacket, getPayloadType, isSupported, toString

From Class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Related Documentation

See Constant Field Values.

CiscoG723MediaCapability

The CiscoG723MediaCapability object specifies the properties for a G.723 encoded RTP stream. Applications that support G.723 media termination use this object to specify their preferred packet size and bit rate when registering a CiscoMediaTerminal. The default packet size is thirty milliseconds and the default bit rate is 6.4k.

Class History

Cisco Unified Communications Manager Release
Description

7.1x

Added history table to track changes.


Declaration

public class CiscoG723MediaCapability extends CiscoMediaCapability

java.lang.Object

          com.cisco.jtapi.extensions.CiscoMediaCapability

                     com.cisco.jtapi.extensions.CiscoG723MediaCapability

Constructors

Table 6-4 Constructors in CiscoG723MediaCapability

Interface
Constructor
Description

public

CiscoG723MediaCapability(int rtpPacketFrameSize, int bitRate)

Constructs a CiscoG723MediaCapability.


Fields

Table 6-5 Fields in CiscoG723MediaCapability 

Interface
Field
Description

public static final int

FRAMESIZE_TWENTY_MILLISECOND_PACKET

RTP Packet Framesize: Twenty millisecond RTP packet.

public static final int

FRAMESIZE_THIRTY_MILLISECOND_PACKET

RTP Packet Framesize: Thirty millisecond RTP packet.

public static final int

FRAMESIZE_SIXTY_MILLISECOND_PACKET

RTP Packet Framesize: Sixty millisecond RTP packet.


Inherited Fields

From Class com.cisco.jtapi.extensions.CiscoMediaCapability

G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, GSM_80_MILLISECONDS, WIDEBAND_256K_10_MILLISECONDS

Methods

Table 6-6 Methods in CiscoG723MediaCapability

Interface
Method
Description

public int

getBitRate()

Returns the bit rate specified by this capability object. Returns: a bit rate from the RTPBitRate interface.

public java.lang.String

toString()

Overwrites the Object.toString() method. Overrides: toString in class CiscoMediaCapability.


Inherited Methods

From Class com.cisco.jtapi.extensions.CiscoMediaCapability

getMaxFramesPerPacket, getPayloadType, isSupported

From Class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Related Documentation

See Constant Field Values.

CiscoG729MediaCapability

The CiscoG729MediaCapability object specifies the properties for a G.729 encoded RTP stream. Applications that support G.729 media termination use this object to specify their preferred packet size when registering a CiscoMediaTerminal. The default packet size is thirty milliseconds.

Class History

Cisco Unified Communications Manager Release
Description

7.1x

Added history table to track changes.


Declaration

public class CiscoG729MediaCapability extends CiscoMediaCapability

java.lang.Object

          com.cisco.jtapi.extensions.CiscoMediaCapability

                    com.cisco.jtapi.extensions.CiscoG729MediaCapability

Constructors

Table 6-7 Constructors in G729MediaCapability

Constructor
Description

CiscoG729MediaCapability(int payload, int rtpPacketFrameSize)

Constructs a CiscoG729MediaCapability.


Fields

Table 6-8 Fields in CiscoG729MediaCapability

Interface
Fields
Description

static int

FRAMESIZE_SIXTY_MILLISECOND_PACKET

RTP Packet Framesize: Sixty millisecond RTP packet.

static int

FRAMESIZE_THIRTY_MILLISECOND_PACKET

RTP Packet Framesize: Thirty millisecond RTP packet.

static int

FRAMESIZE_TWENTY_MILLISECOND_PACKET

RTP Packet Framesize: Twenty millisecond RTP packet.

static int

FRAMESIZE_TWENTY_MILLISECOND_PACKET

RTP Packet Framesize: Twenty millisecond RTP packet .


Inherited Fields

From Class com.cisco.jtapi.extensions.CiscoMediaCapability

G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, GSM_80_MILLISECONDS, WIDEBAND_256K_10_MILLISECONDS

Methods

None

Inherited Methods

From Class com.cisco.jtapi.extensions.CiscoMediaCapability

getMaxFramesPerPacket, getPayloadType, isSupported, toString

From Class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Related Documentation

See Constant Field Values.

CiscoGSMMediaCapability

The CiscoGSMMediaCapability object specifies the properties for a GSM encoded RTP stream. Applications that support GSM media termination use this object to specify their preferred packet size when registering a CiscoMediaTerminal. The default packet size is thirty milliseconds.

Class History

Cisco Unified Communications Manager Release
Description

7.1x

Added history table to track changes.


Declaration

public class CiscoGSMMediaCapability extends CiscoMediaCapability

java.lang.Object

          com.cisco.jtapi.extensions.CiscoMediaCapability

                    com.cisco.jtapi.extensions.CiscoGSMMediaCapability

Constructors

Table 6-9 Constructors in CiscoGSMMediaCapability

Interface
Constructor
Description

public

CiscoGSMMediaCapability()

Constructs a CiscoGSMMediaCapability

public

CiscoGSMMediaCapability(int rtpPacketFrameSize)

Constructs a CiscoGSMMediaCapability.


Fields

Table 6-10 Fields in CiscoGSMMediaCapability

Interface
Field
Description

static int

FRAMESIZE_EIGHTY_MILLISECOND_PACKET

RTP Packet Framesize: Eighty millisecond RTP packet


Inherited Fields

From Class com.cisco.jtapi.extensions.CiscoMediaCapability

G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, GSM_80_MILLISECONDS, WIDEBAND_256K_10_MILLISECONDS

Methods

None

Inherited Methods

From Class com.cisco.jtapi.extensions.CiscoMediaCapability

getMaxFramesPerPacket, getPayloadType, isSupported, toString

From Class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Related Documentation

None

CiscoJtapiVersion

This class gives the version information of the installed Cisco JTAPI. Programs can get the version number using the accessor methods. Cisco Jtapi Version is in a.b(x.y) format where "a" indicates the major version, "b" indicates the minor version, "x" indicates the revision number, and "y" indicates the build number .

Class History

Cisco Unified Communications Manager Release
Description

7.1x

Added history table to track changes.


Declaration

public class CiscoJtapiVersion extends java.lang.Object

java.lang.Object

          com.cisco.jtapi.extensions.CiscoJtapiVersion

Constructors

public CiscoJtapiVersion() None

Fields

None

Methods

Table 6-11 Methods in CiscoJtapiVersion 

Interface
Method
Description

java.lang.String

getBuildDescription()

Returns "release" if it is a release version or debug if it is not a release version.

int

getBuildNumber()

Returns the build number of the version.

int

getExtendedBuildNumber()

Returns the extended build number of the version.

int

getMajorVersion()

Returns the major version number.

int

getMinorVersion()

Returns the minor version number.

int

getRevisionNumber()

Returns the revision number of the version.

public java.lang.String

getVersion()

Returns the version information in a.b(x.y)-z format without a name.

public java.lang.String

toString()

Returns the version information in a.b(x.y)-z format. Overrides toString in class java.lang.Object.


Inherited Methods

From Class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Related Documentation

None

CiscoMediaCapability

The CiscoMediaCapability object specifies the properties of a particular media format that an application can support for CiscoMediaTerminals that it registers. Because CiscoMediaCapability is an abstract class, applications may only construct its subclasses directly.

Class History

Cisco Unified Communications Manager Release
Description

7.1x

Added history table to track changes.


Declaration

public class CiscoMediaCapability extends java.lang.Object

java.lang.Object

          com.cisco.jtapi.extensions.CiscoMediaCapability

Subclasses

CiscoG711MediaCapability, CiscoG723MediaCapability, CiscoG729MediaCapability, CiscoGSMMediaCapability, CiscoWideBandMediaCapability

Constructors

Table 6-12 Constructors in CiscoMediaCapability

Interface
Constructor
Description

public

CiscoMediaCapability(int payloadType, int maxFramesPerPacket)

Constructs a CiscoMediaCapability object for the specified payload type and packet size (in milliseconds).


Fields

Table 6-13 Fields in CiscoMediaCapability 

Interface
Field
Description

static

G711_64K_30_MILLISECONDS

G.711 capability with default parameters.

static

G723_6K_30_MILLISECONDS

G.723 capability with default parameters.

static

G729_30_MILLISECONDS

G.729 capability with default parameters.

static

GSM_80_MILLISECONDS

GSM capability with default parameters.

static

WIDEBAND_256K_10_MILLISECONDS

Wideband capability with default parameters.


Methods

Table 6-14 Methods in CiscoMediaCapability 

Interface
Method
Description

int

getMaxFramesPerPacket(

Returns the packet size (in milliseconds) that this object specifies.The maxFramesPerPacket parameter is a carryover from the H.245 protocol definition.

Cisco Unified Communications Manager does not use this field as the number of frames per RTP packet, but rather as the number of milliseconds of audio per RTP packet that the device can receive.

Third-party IP phones may use different (higher) rates even though these rates may not be exceeded to and or from Cisco Unified IP phones.

int

getPayloadType()

Returns a payload type from the RTPPayload interface that this object specifies.

boolean

isSupported()

Returns whether the payload of this object is supported or not. True if the payloadType is supported, or otherwise false

java.lang.String

toString()

Overrides toString in class java.lang.Object.


Inherited Methods

From Class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Related Documentation

See CiscoG711MediaCapability, CiscoG723MediaCapability, CiscoG729MediaCapability, CiscoGSMMediaCapability, CiscoWideBandMediaCapability, CiscoRTPBitRate, and CiscoRTPPayload.

CiscoRegistrationException

The CiscoMediaTerminal.register method throws this exception when the registration process fails for any reason. For example, registration would fail if the Provider were OUT_OF_SERVICE or if the device were already registered.

Class History

Cisco Unified Communications Manager Release
Description

7.1x

Added history table to track changes.


Declaration

public class CiscoRegistrationException extends java.lang.Exception

java.lang.Object

          java.lang.Throwable

                    java.lang.Exception

                              com.cisco.jtapi.extensions.CiscoRegistrationException

Implemented Interfaces

java.io.Serializable

Constructors

Table 6-15 Constructors in CiscoRegistrationException

Interface
Constructor
Description

public

CiscoRegistrationException(java.lang.String description)

Takes the description of the exception as a parameter.


Methods

None

Inherited Methods

From Class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

From Class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Related Documentation

See CiscoMediaTerminal.register(java.net.InetAddress, int, com.cisco.jtapi.extensions.CiscoMediaCapability[]).

CiscoRTPParams

You can use the CiscoRTPParams class to specify a dynamic RTP address and port number for a media terminal on a per-call basis. Applications can pass this object in setRTPParams() of CiscoMediaTerminal. These parameters are only valid for a particular call.

Class History

Cisco Unified Communications Manager Release
Description

7.1x

Added history table to track changes.


Declaration

public class CiscoRTPParams extends java.lang.Object

java.lang.Object

Constructors

CiscoRTPParams (java.net.InetAddress, rtpAddress, int rtpPort)

Fields

None

Methods

Table 6-16 Methods in CiscoRTPParams

Interface
Method
Description

java.net.InetAddress

getRTPAddress()

Returns the Internet address for the inbound RTP stream of the associated call.

java.lang.String

getRTPAddressHostName()

Returns the IP host name for the inbound RTP stream of the associated call.

byte[]

getRTPByteAddress()

Returns the Internet address in byte format for the inbound RTP stream.

int

getRTPPort()

Returns the UDP port for the inbound RTP stream.

java.lang.String

toString()

Returns a String in the format "IP address/port number." Overrides toString in class java.lang.Object.


Inherited Methods

From Class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Related Documentation

See CiscoTerminal and CiscoMediaTerminal.

CiscoUnregistrationException

The CiscoMediaTerminal.unregister method throws this exception when the unregistration process fails. For example, registration fails if the Provider is OUT_OF_SERVICE or the Terminal is already unregistered.

Class History

Cisco Unified Communications Manager Release
Description

7.1x

Added history table to track changes.


Declaration

public class CiscoUnregistrationException extends java.lang.Exception

java.lang.Object

         java.lang.Throwable

                  java.lang.Exception

                           com.cisco.jtapi.extensions.CiscoUnregistrationException

Implemented Interfaces

java.io.Serializable

Constructors

Table 6-17 Constructors in CiscoUnregistrationException

Interface
Constructor
Description

public

CiscoUnregistrationException()(java.lang.String description)

None


Fields

None

Methods

None

Inherited Methods

From Class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

From Class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Related Documentation

See CiscoMediaTerminal.unregister(), Serialized Form.

CiscoWideBandMediaCapability

The CiscoWideBandMediaCapability object specifies the properties for a wide band encoded RTP stream. Applications that support wide band media termination use this object to specify their preferred packet size when registering a CiscoMediaTerminal. The default packet size is ten milliseconds.

Class History

Cisco Unified Communications Manager Release
Description

7.1x

Added history table to track changes.


Declaration

public class CiscoWideBandMediaCapability extends CiscoMediaCapability

java.lang.Object

          com.cisco.jtapi.extensions.CiscoMediaCapability

                    com.cisco.jtapi.extensions.CiscoWideBandMediaCapability

Constructors

Table 6-18 Constructors in CiscoWideBandMediaCapability

Interface
Constructor
Description

public

CiscoWideBandMediaCapability(int packetsize)

Constructs a CiscoWideBandMediaCapability object with the specified packet size. The default is ten-millisecond packet size.

Parameters

packetsize—The RTP packet Framesize.


Fields

Table 6-19 Fields in CiscoWideBandMedicaCapability

Interface
Field
Description

static int

FRAMESIZE_TEN_MILLISECOND_PACKET

RTP Packet Framesize: Ten millisecond RTP packet


Inherited Fields

From Class com.cisco.jtapi.extensions.CiscoMediaCapability

G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, GSM_80_MILLISECONDS, WIDEBAND_256K_10_MILLISECONDS

Methods

None

Inherited Methods

From Class com.cisco.jtapi.extensions.CiscoMediaCapability

getMaxFramesPerPacket, getPayloadType, isSupported, toString

From Class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Related Documentation

See Constant Field Values.

Interface Hierarchy

The following interface hierarchy is contained in the com.cisco.jtapi.extensions package hierarchy.

javax.telephony.Address

com.cisco.jtapi.extensions.CiscoAddress (also extends      com.cisco.jtapi.extensions.CiscoObjectContainer)

com.cisco.jtapi.extensions.CiscoIntercomAddress

javax.telephony.callcenter.RouteAddress

com.cisco.jtapi.extensions.CiscoRouteAddress

javax.telephony.AddressObserver

com.cisco.jtapi.extensions.CiscoAddressObserver

javax.telephony.Call

javax.telephony.callcontrol.CallControlCall

com.cisco.jtapi.extensions.CiscoCall (also extends      com.cisco.jtapi.extensions.CiscoObjectContainer)

          com.cisco.jtapi.extensions.CiscoConsultCall

com.cisco.jtapi.extensions.CiscoCallCtlTermConnHeldReversionEv

com.cisco.jtapi.extensions.CiscoConferenceChain

com.cisco.jtapi.extensions.CiscoFeatureReason

com.cisco.jtapi.extensions.CiscoJtapiException

com.cisco.jtapi.extensions.CiscoJtapiProperties

com.cisco.jtapi.extensions.CiscoLocales

com.cisco.jtapi.extensions.CiscoMediaSecurityIndicator

com.cisco.jtapi.extensions.CiscoMediaConnectionMode

com.cisco.jtapi.extensions.CiscoMediaEncryptionAlgorithmType

com.cisco.jtapi.extensions.CiscoMediaEncryptionKeyInfo

com.cisco.jtapi.extensions.CiscoMediaSecurityIndicator

com.cisco.jtapi.extensions.CiscoMonitorInitiatorInfo

com.cisco.jtapi.extensions.CiscoMonitorTargetInfo

com.cisco.jtapi.extensions.CiscoObjectContainer

com.cisco.jtapi.extensions.CiscoAddress (also extends javax.telephony.Address)

com.cisco.jtapi.extensions.CiscoIntercomAddress

com.cisco.jtapi.extensions.CiscoCall (also extends javax.telephony.callcontrol.CallControlCall)

com.cisco.jtapi.extensions.CiscoConsultCall

com.cisco.jtapi.extensions.CiscoCallID

com.cisco.jtapi.extensions.CiscoConnection (also extends      javax.telephony.callcontrol.CallControlConnection)

com.cisco.jtapi.extensions.CiscoConnectionID

com.cisco.jtapi.extensions.CiscoConsultCall

com.cisco.jtapi.extensions.CiscoIntercomAddress

com.cisco.jtapi.extensions.CiscoJtapiPeer (also extends javax.telephony.JtapiPeer,      com.cisco.services.tracing.TraceModule)

com.cisco.jtapi.extensions.CiscoMediaTerminal

com.cisco.jtapi.extensions.CiscoProvider

com.cisco.jtapi.extensions.CiscoRouteTerminal

com.cisco.jtapi.extensions.CiscoTerminal (also extends javax.telephony.Terminal)

com.cisco.jtapi.extensions.CiscoMediaTerminal

com.cisco.jtapi.extensions.CiscoRouteTerminal

com.cisco.jtapi.extensions.CiscoTerminalConnection (also extends      javax.telephony.callcontrol.CallControlTerminalConnection)

com.cisco.jtapi.extensions.CiscoPartyInfo

com.cisco.jtapi.extensions.CiscoProvFeatureID

com.cisco.jtapi.extensions.CiscoProviderCapabilityChangedEv

com.cisco.jtapi.extensions.CiscoRecorderInfo

com.cisco.jtapi.extensions.CiscoRTPBitRate

com.cisco.jtapi.extensions.CiscoRTPHandle

com.cisco.jtapi.extensions.CiscoRTPInputProperties

com.cisco.jtapi.extensions.CiscoRTPOutputProperties

com.cisco.jtapi.extensions.CiscoRTPPayload

com.cisco.jtapi.extensions.CiscoSynchronousObserver

com.cisco.jtapi.extensions.CiscoTermConnPrivacyChangedEv

com.cisco.jtapi.extensions.CiscoTermEvFilter

com.cisco.jtapi.extensions.CiscoTerminalProtocol

com.cisco.jtapi.extensions.CiscoTone

com.cisco.jtapi.extensions.CiscoUrlInfo

javax.telephony.Connection

javax.telephony.callcontrol.CallControlConnection

com.cisco.jtapi.extensions.CiscoConnection (also extends      com.cisco.jtapi.extensions.CiscoObjectContainer)

javax.telephony.events.Ev

javax.telephony.events.AddrEv

com.cisco.jtapi.extensions.CiscoAddrEv (also extends com.cisco.jtapi.extensions.CiscoEv)

     com.cisco.jtapi.extensions.CiscoAddrAutoAcceptStatusChangedEv

     com.cisco.jtapi.extensions.CiscoAddrInServiceEv

     com.cisco.jtapi.extensions.CiscoAddrIntercomInfoChangedEv

     com.cisco.jtapi.extensions.CiscoAddrIntercomInfoRestorationFailedEv

     com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv (also extends      com.cisco.jtapi.extensions.CiscoOutOfServiceEv)

     com.cisco.jtapi.extensions.CiscoAddressRecordingConfigChangedEv

javax.telephony.callcontrol.events.CallCtlEv

javax.telephony.callcontrol.events.CallCtlCallEv (also extends javax.telephony.events.CallEv)

     javax.telephony.callcontrol.events.CallCtlConnEv (also extends           javax.telephony.events.ConnEv)

          javax.telephony.callcontrol.events.CallCtlConnOfferedEv

               com.cisco.jtapi.extensions.CiscoCallCtlConnOfferedEv

javax.telephony.events.CallEv

javax.telephony.events.CallActiveEv

     com.cisco.jtapi.extensions.CiscoConsultCallActiveEv (also extends           com.cisco.jtapi.extensions.CiscoCallEv)

javax.telephony.callcontrol.events.CallCtlCallEv (also extends      javax.telephony.callcontrol.events.CallCtlEv)

     javax.telephony.callcontrol.events.CallCtlConnEv (also extends           javax.telephony.events.ConnEv)

          javax.telephony.callcontrol.events.CallCtlConnOfferedEv

               com.cisco.jtapi.extensions.CiscoCallCtlConnOfferedEv

     com.cisco.jtapi.extensions.CiscoCallEv (also extends com.cisco.jtapi.extensions.CiscoEv)

     com.cisco.jtapi.extensions.CiscoCallChangedEv

     com.cisco.jtapi.extensions.CiscoCallSecurityStatusChangedEv

     com.cisco.jtapi.extensions.CiscoConferenceChainAddedEv

     com.cisco.jtapi.extensions.CiscoConferenceChainRemovedEv

     com.cisco.jtapi.extensions.CiscoConferenceEndEv

     com.cisco.jtapi.extensions.CiscoConferenceStartEv

     com.cisco.jtapi.extensions.CiscoConsultCallActiveEv (also extends           javax.telephony.events.CallActiveEv)

     com.cisco.jtapi.extensions.CiscoToneChangedEv

     com.cisco.jtapi.extensions.CiscoTransferEndEv

     com.cisco.jtapi.extensions.CiscoTransferStartEv

javax.telephony.events.ConnEv

javax.telephony.callcontrol.events.CallCtlConnEv (also extends      javax.telephony.callcontrol.events.CallCtlCallEv)

         javax.telephony.callcontrol.events.CallCtlConnOfferedEv

                com.cisco.jtapi.extensions.CiscoCallCtlConnOfferedEv

javax.telephony.events.TermConnEv

com.cisco.jtapi.extensions.CiscoTermConnMonitoringEndEv

com.cisco.jtapi.extensions.CiscoTermConnMonitoringStartEv

com.cisco.jtapi.extensions.CiscoTermConnMonitorInitiatorInfoEv

com.cisco.jtapi.extensions.CiscoTermConnMonitorTargetInfoEv

com.cisco.jtapi.extensions.CiscoTermConnRecordingEndEv

com.cisco.jtapi.extensions.CiscoTermConnRecordingStartEv

com.cisco.jtapi.extensions.CiscoTermConnRecordingTargetInfoEv

com.cisco.jtapi.extensions.CiscoTermConnSelectChangedEv

com.cisco.jtapi.extensions.CiscoEv

com.cisco.jtapi.extensions.CiscoAddrActivatedEv

com.cisco.jtapi.extensions.CiscoAddrActivatedOnTerminalEv

com.cisco.jtapi.extensions.CiscoAddrAddedToTerminalEv

com.cisco.jtapi.extensions.CiscoAddrAutoAcceptStatusChangedEv

com.cisco.jtapi.extensions.CiscoAddrCreatedEv

com.cisco.jtapi.extensions.CiscoAddrEv (also extends javax.telephony.events.AddrEv)

com.cisco.jtapi.extensions.CiscoAddrAutoAcceptStatusChangedEv

com.cisco.jtapi.extensions.CiscoAddrInServiceEv

com.cisco.jtapi.extensions.CiscoAddrIntercomInfoChangedEv

com.cisco.jtapi.extensions.CiscoAddrIntercomInfoRestorationFailedEv

com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv (also extends       com.cisco.jtapi.extensions.CiscoAddrEv,       com.cisco.jtapi.extensions.CiscoOutOfServiceEv)

com.cisco.jtapi.extensions.CiscoAddressRecordingConfigChangedEv

com.cisco.jtapi.extensions.CiscoAddrInServiceEv

com.cisco.jtapi.extensions.CiscoAddrIntercomInfoChangedEv

com.cisco.jtapi.extensions.CiscoAddrIntercomInfoRestorationFailedEv

com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv (also extends       com.cisco.jtapi.extensions.CiscoAddrEv)

com.cisco.jtapi.extensions.CiscoAddressRecordingConfigChangedEv

com.cisco.jtapi.extensions.CiscoAddrRemovedEv

com.cisco.jtapi.extensions.CiscoAddrRemovedFromTerminalEv

com.cisco.jtapi.extensions.CiscoAddrRestrictedEv

com.cisco.jtapi.extensions.CiscoAddrRestrictedOnTerminalEv

com.cisco.jtapi.extensions.CiscoCallChangedEv

com.cisco.jtapi.extensions.CiscoCallEv (also extends javax.telephony.events.CallEv)

com.cisco.jtapi.extensions.CiscoCallChangedEv

com.cisco.jtapi.extensions.CiscoCallSecurityStatusChangedEv

com.cisco.jtapi.extensions.CiscoConferenceChainAddedEv

com.cisco.jtapi.extensions.CiscoConferenceChainRemovedEv

com.cisco.jtapi.extensions.CiscoConferenceEndEv

com.cisco.jtapi.extensions.CiscoConferenceStartEv

com.cisco.jtapi.extensions.CiscoConsultCallActiveEv (also extends      javax.telephony.events.CiscoCallEv)

com.cisco.jtapi.extensions.CiscoToneChangedEv

com.cisco.jtapi.extensions.CiscoTransferEndEv

com.cisco.jtapi.extensions.CiscoTransferStartEv

com.cisco.jtapi.extensions.CiscoCallSecurityStatusChangedEv

com.cisco.jtapi.extensions.CiscoConferenceChainAddedEv

com.cisco.jtapi.extensions.CiscoConferenceChainRemovedEv

com.cisco.jtapi.extensions.CiscoConferenceEndEv

com.cisco.jtapi.extensions.CiscoConferenceStartEv

com.cisco.jtapi.extensions.CiscoConsultCallActiveEv (also extends      javax.telephony.events.CallActiveEv, com.cisco.jtapi.extensions.CiscoCallEv)

com.cisco.jtapi.extensions.CiscoMediaOpenLogicalChannelEv

com.cisco.jtapi.extensions.CiscoOutOfServiceEv

com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv (also extends           com.cisco.jtapi.extensions.CiscoAddrEv)

com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv (also extends           com.cisco.jtapi.extensions.CiscoTermEv)

com.cisco.jtapi.extensions.CiscoProvCallParkEv

com.cisco.jtapi.extensions.CiscoProvFeatureEv (also extends javax.telephony.events.ProvEv)

com.cisco.jtapi.extensions.CiscoAddrActivatedEv

com.cisco.jtapi.extensions.CiscoAddrActivatedOnTerminalEv

com.cisco.jtapi.extensions.CiscoAddrAddedToTerminalEv

com.cisco.jtapi.extensions.CiscoAddrCreatedEv

com.cisco.jtapi.extensions.CiscoAddrRemovedEv

com.cisco.jtapi.extensions.CiscoAddrRemovedFromTerminalEv

com.cisco.jtapi.extensions.CiscoAddrRestrictedEv

com.cisco.jtapi.extensions.CiscoAddrRestrictedOnTerminalEv

com.cisco.jtapi.extensions.CiscoProvCallParkEv

com.cisco.jtapi.extensions.CiscoProvFeatureEv

com.cisco.jtapi.extensions.CiscoProvCallParkEv

com.cisco.jtapi.extensions.CiscoRestrictedEv

com.cisco.jtapi.extensions.CiscoAddrRestrictedEv

com.cisco.jtapi.extensions.CiscoAddrRestrictedOnTerminalEv

com.cisco.jtapi.extensions.CiscoTermActivatedEv

com.cisco.jtapi.extensions.CiscoTermCreatedEv

com.cisco.jtapi.extensions.CiscoTermRemovedEv

com.cisco.jtapi.extensions.CiscoTermRestrictedEv

com.cisco.jtapi.extensions.CiscoProvFeatureEv

com.cisco.jtapi.extensions.CiscoProvCallParkEv

com.cisco.jtapi.extensions.CiscoRestrictedEv

com.cisco.jtapi.extensions.CiscoAddrRestrictedEv

com.cisco.jtapi.extensions.CiscoAddrRestrictedOnTerminalEv

com.cisco.jtapi.extensions.CiscoRTPInputKeyEv

com.cisco.jtapi.extensions.CiscoRTPInputStartedEv

com.cisco.jtapi.extensions.CiscoRTPInputStoppedEv

com.cisco.jtapi.extensions.CiscoRTPOutputKeyEv

com.cisco.jtapi.extensions.CiscoRTPOutputStartedEv

com.cisco.jtapi.extensions.CiscoRTPOutputStoppedEv

com.cisco.jtapi.extensions.CiscoTermActivatedEv

com.cisco.jtapi.extensions.CiscoTermButtonPressedEv

com.cisco.jtapi.extensions.CiscoTermCreatedEv

com.cisco.jtapi.extensions.CiscoTermDataEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateActiveEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateAlertingEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateHeldEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateWhisperEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateWhisperEv

com.cisco.jtapi.extensions.CiscoTermDNDStatusChangedEv

com.cisco.jtapi.extensions.CiscoTermEvFilter (also extends javax.telephony.events.TermEv)

com.cisco.jtapi.extensions.CiscoMediaOpenLogicalChannelEv

com.cisco.jtapi.extensions.CiscoRTPInputKeyEv

com.cisco.jtapi.extensions.CiscoRTPInputStartedEv

com.cisco.jtapi.extensions.CiscoRTPInputStoppedEv

com.cisco.jtapi.extensions.CiscoRTPOutputKeyEv

com.cisco.jtapi.extensions.CiscoRTPOutputStartedEv

com.cisco.jtapi.extensions.CiscoRTPOutputStoppedEv

com.cisco.jtapi.extensions.CiscoTermButtonPressedEv

com.cisco.jtapi.extensions.CiscoTermDataEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateActiveEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateAlertingEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateHeldEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateIdleEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateWhisperEv

com.cisco.jtapi.extensions.CiscoTermDNDStatusChangedEv

com.cisco.jtapi.extensions.CiscoTermInServiceEv

com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv(also extends         com.cisco.jtapi.extensions.CiscoOutOfServiceEv)

com.cisco.jtapi.extensions.CiscoTermRegistrationFailedEv

com.cisco.jtapi.extensions.CiscoTermSnapshotCompletedEv

com.cisco.jtapi.extensions.CiscoTermSnapshotEv

com.cisco.jtapi.extensions.CiscoTermInServiceEv

com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv (extends           com.cisco.jtapi.extensions.CiscoOutOfServiceEv, com.cisco.jtapi.extensions.CiscoTermEv)

com.cisco.jtapi.extensions.CiscoTermRegistrationFailedEv

com.cisco.jtapi.extensions.CiscoTermRemovedEv

com.cisco.jtapi.extensions.CiscoTermRestrictedEv

com.cisco.jtapi.extensions.CiscoTermSnapshotCompletedEv

com.cisco.jtapi.extensions.CiscoTermSnapshotEv

com.cisco.jtapi.extensions.CiscoToneChangedEv

com.cisco.jtapi.extensions.CiscoTransferEndEv

com.cisco.jtapi.extensions.CiscoTransferStartEv

javax.telephony.events.ProvEv

com.cisco.jtapi.extensions.CiscoProvEv (also extends com.cisco.jtapi.extensions.CiscoEv)

com.cisco.jtapi.extensions.CiscoAddrActivatedEv

com.cisco.jtapi.extensions.CiscoAddrActivatedOnTerminalEv

com.cisco.jtapi.extensions.CiscoAddrAutoAcceptStatusChangedEv

com.cisco.jtapi.extensions.CiscoAddrCreatedEv

com.cisco.jtapi.extensions.CiscoAddrRemovedEv

com.cisco.jtapi.extensions.CiscoAddrRemovedFromTerminalEv

com.cisco.jtapi.extensions.CiscoAddrRestrictedEv

com.cisco.jtapi.extensions.CiscoAddrRestrictedOnTerminalEv

com.cisco.jtapi.extensions.CiscoProvCallParkEv

com.cisco.jtapi.extensions.CiscoProvFeatureEv

     com.cisco.jtapi.extensions.CiscoProvCallParkEv

com.cisco.jtapi.extensions.CiscoRestrictedEv

     com.cisco.jtapi.extensions.CiscoAddrRestrictedEv

     com.cisco.jtapi.extensions.CiscoAddrRestrictedOnTerminalEv

com.cisco.jtapi.extensions.CiscoTermActivatedEv

com.cisco.jtapi.extensions.CiscoTermCreatedEv

com.cisco.jtapi.extensions.CiscoTermRemovedEv

com.cisco.jtapi.extensions.CiscoTermRestrictedEv

javax.telephony.events.TermEv

com.cisco.jtapi.extensions.CiscoTermEv (also extends com.cisco.jtapi.extensions.CiscoEv)

com.cisco.jtapi.extensions.CiscoMediaOpenLogicalChannelEv

com.cisco.jtapi.extensions.CiscoRTPInputKeyEv

com.cisco.jtapi.extensions.CiscoRTPInputStartedEv

com.cisco.jtapi.extensions.CiscoRTPInputStoppedEv

com.cisco.jtapi.extensions.CiscoRTPOutputKeyEv

com.cisco.jtapi.extensions.CiscoRTPOutputStartedEv

com.cisco.jtapi.extensions.CiscoRTPOutputStoppedEv

com.cisco.jtapi.extensions.CiscoTermButtonPressedEv

com.cisco.jtapi.extensions.CiscoTermDataEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateActiveEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateAlertingEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateHeldEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateIdleEv

com.cisco.jtapi.extensions.CiscoTermDeviceStateWhisperEv

com.cisco.jtapi.extensions.CiscoTermDNDStatusChangedEv

com.cisco.jtapi.extensions.CiscoTermInServiceEv

com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)

com.cisco.jtapi.extensions.CiscoTermRegistrationFailedEv

com.cisco.jtapi.extensions.CiscoTermSnapshotCompletedEv

com.cisco.jtapi.extensions.CiscoTermSnapshotEv

javax.telephony.JtapiPeer

com.cisco.jtapi.extensions.CiscoJtapiPeer (also extends         com.cisco.jtapi.extensions.CiscoObjectContainer, com.cisco.services.tracing.TraceModule)

javax.telephony.Provider

com.cisco.jtapi.extensions.CiscoProvider (also extends       com.cisco.jtapi.extensions.CiscoObjectContainer)

javax.telephony.capabilities.ProviderCapabilities

com.cisco.jtapi.extensions.CiscoProviderCapabilities

javax.telephony.ProviderObserver

com.cisco.jtapi.extensions.CiscoProviderObserver

javax.telephony.callcenter.RouteSession

com.cisco.jtapi.extensions.CiscoRouteSession

javax.telephony.callcenter.events.RouteSessionEvent

javax.telephony.callcenter.events.RouteEvent

com.cisco.jtapi.extensions.CiscoRouteEvent

javax.telephony.callcenter.events.RouteUsedEvent

com.cisco.jtapi.extensions.CiscoRouteUsedEvent

javax.telephony.Terminal

com.cisco.jtapi.extensions.CiscoTerminal (also extends            com.cisco.jtapi.extensions.CiscoObjectContainer)

com.cisco.jtapi.extensions.CiscoMediaTerminal

com.cisco.jtapi.extensions.CiscoRouteTerminal

javax.telephony.TerminalConnection

javax.telephony.callcontrol.CallControlTerminalConnection

com.cisco.jtapi.extensions.CiscoTerminalConnection (also extends               com.cisco.jtapi.extensions.CiscoObjectContainer)

javax.telephony.TerminalObserver

com.cisco.jtapi.extensions.CiscoTerminalObserver

com.cisco.services.tracing.TraceModule

com.cisco.jtapi.extensions.CiscoJtapiPeer (also extends         com.cisco.jtapi.extensions.CiscoObjectContainer, javax.telephony.JtapiPeer)

CiscoAddrActivatedEv

If an address is controlled and the restriction status changes to active, the system sends the CiscoAddrActivatedEv event to the application. Applications see this event whenever an Address or associated Terminal is in the control list. If any observers exist on the address already, applications see CiscoAddrInServiceEv. If no observers are present, applications can try to add observers, and the address will go in service.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Declaration

public interface CiscoAddrActivatedEv extends CiscoProvEv

Fields

Table 6-20 Fields in CiscoAddrActivatedEv

Interface
Field

static int

ID


Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-21 Methods in CiscoAddrActivatedEv

Interface
Method
Description

javax.telephony.Address

getAddress()

Returns the Address which is activated.


Inherited Methods

From Interface javax.telephony.events.ProvEv

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values for more information.

The CiscoCallCtlConnOfferedEv interface extends the CallCtlConnOfferedEv interface to let applications obtain the IP Address of the calling party Terminal. The IP Address information might not be available for all calling party devices. A return value of 0 (or null) indicates that the information is not available.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.callcontrol.events.CallCtlCallEv, javax.telephony.callcontrol.events.CallCtlConnEv, javax.telephony.callcontrol.events.CallCtlConnOfferedEv, javax.telephony.callcontrol.events.CallCtlEv, javax.telephony.events.CallEv, javax.telephony.events.ConnEv, javax.telephony.events.Ev

Declaration

public interface CiscoCallCtlConnOfferedEv extends javax.telephony.callcontrol.events.CallCtlConnOfferedEv

Fields

None

Inherited Fields

From Interface javax.telephony.callcontrol.events.CallCtlConnOfferedEv

None

From Interface javax.telephony.callcontrol.events.CallCtlEv

CAUSE_ALTERNATE, CAUSE_BUSY, CAUSE_CALL_BACK, CAUSE_CALL_NOT_ANSWERED, CAUSE_CALL_PICKUP, CAUSE_CONFERENCE, CAUSE_DO_NOT_DISTURB, CAUSE_PARK, CAUSE_REDIRECTED, CAUSE_REORDER_TONE, CAUSE_TRANSFER, CAUSE_TRUNKS_BUSY, CAUSE_UNHOLD

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-22 Methods in CiscoCallCtlConnOfferedEv

Interface
Method
Description

java.net.InetAddress

getCallingPartyIpAddr()

Returns the IP address of the calling party, or 0 (or null) if the IP Address is not available.


Inherited Methods

From Interface javax.telephony.callcontrol.events.CallCtlCallEv

getCalledAddress, getCallingAddress, getCallingTerminal, getLastRedirectedAddress

From Interface javax.telephony.callcontrol.events.CallCtlEv

getCallControlCause

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.ConnEv

getConnection

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

None

CiscoAddrActivatedOnTerminalEv

The CiscoAddrActivatedOnTerminalEv event gets sent when a shared line gets activated or a Terminal which has shared line gets activated.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Declaration

public interface CiscoAddrActivatedOnTerminalEv extends CiscoProvEv

Fields

None

Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-23 Methods in CiscoAddrActivatedOnTerminalEv

Interface
Method
Description

javax.telephony.Address

getAddress()

Returns the address that is marked unrestricted on the terminal.

javax.telephony.Terminal

getTerminal()

Returns the terminal on which the address got activated (i.e. marked unrestricted).


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.ProvEv

getProvider

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values for more information.

CiscoAddrAddedToTerminalEv

The system sends CiscoAddrAddedToTerminalEv when:

A user adds a Terminal into the control list that contains a shared line, the system sends this event to the application. If a user has an address in the control list, and you add a new Terminal with the same address in control list, this event gets sent.

An Extension Mobility (EM) user logs into a Terminal with a profile that contains a shared line, this event notifies that a new Terminal has been added to an already existing address.

A new shared line gets added to a Terminal in a user control list, the system sends this event to the application.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Declaration

public interface CiscoAddrAddedToTerminalEv extends CiscoProvEv

Fields

Table 6-24 Fields in CiscoAddrAddedToTerminalEv

Interface
Field

static int

ID


Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-25 Methods in CiscoAddrAddedToTerminalEv

Interface
Method
Description

javax.telephony.Address

getAddress()

Returns the address on which the new terminal is added.

javax.telephony.Terminal

getTerminal()

Returns the terminal that gets added to the Address.


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.ProvEv

getProvider

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values for more information.

CiscoAddrAutoAcceptStatusChangedEv

The system sends CiscoAddrAutoAcceptStatusChangedEv to applications whenever the AutoAccept status for the Address on the Terminal changes. If an Address has multiple Terminals, this event gets sent for the Address AutoAccept status on each individual Terminal.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, javax.telephony.events.Ev

Declaration

public interface CiscoAddrAutoAcceptStatusChangedEv extends CiscoAddrEv

Fields

Table 6-26 CiscoAddrAutoAcceptStatusChangedEv Fields

Interface
Field

static int

ID


Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUTUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_R_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-27 Methods for CiscoAddrAutoAcceptStatusChangedEv

Interface
Method
Description

int

getAutoAcceptStatus()

Returns the AutoAccept Status of the Address on the Terminal. Returns CiscoAddress.AUTOACCEPT_OFF or CiscoAddress.AUTOACCEPT_ON

CiscoTerminal

getTerminal()

Returns the Terminal at which the AutoAccept status for this address is changing.


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.AddrEv

getAddress

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See getAutoAcceptStatus and CiscoAddress.getAutoAcceptStatus(Terminal terminal).

CiscoAddrCreatedEv

The CiscoAddrCreatedEv event gets sent when an Address gets added to the provider domain.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Declaration

public interface CiscoAddrCreatedEv extends CiscoProvEv

Fields

Table 6-28 Fields in CiscoAddrCreatedEv

Interface
Field

ID

static final int ID


Inherited Fields

From interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-29 Methods in CiscoAddrCreatedEv

Interface
Method
Description

getAddress

javax.telephony.Address getAddress()

Returns the address which got added to the provider domain. Returns the address that is added to the provider domain.


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.ProvEv

getProvider

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values.

CiscoAddrMonitorTerminatedEv

When a monitor session is terminated, the Supervisor who had initiated the session will be notified with this event.

Cisco Unified Communications Manager Release Number
Description

8.0(1)

New interface


Interface History

Declaration

pubic interface CiscoAddrMonitorTerminatedEv extends CiscoAddrEv 

Methods

Table 6-30 Methods in CiscoAddrMonitorTerminatedEv

Interface
Method
Description

Int

getTransactionID()

 

Address

getMonitorTargetAddress()

 

String

getMonitorTargetDevieName()

 

Int

getMonitorTargetCalllegHandle()

 

String

getMonitorInitiatorDeviceName()

 

Int

getCause()

 

Related Documentation

CiscoAddress

The CiscoAddress interface extends the Address interface with additional Cisco Unified Communications Manager capabilities.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1, 2)

Added voice and fax message counts for the Enhanced Message Waiting Indication (MWI) feature for supported phones only.

7.1(3)

Updated for Terminal and Address Capability settings changes.

8.0(1)

Enhanced with the following:

New APIs getPickupGroup() to enable applications to get information about the Pickup Group the Address belongs to

New address type to indicate that the address represents hunt pilot.

New field that will represent a new kind of recording type, device-based recording.

9.0(1)

A new constant, SELECTIVE_RECORDING, is added. Two constants, APPLICATION_CONTROLLED_RECORDING, and DEVICE_CONTROLLED_RECORDING, are deprecated. Applications that upgrade to Release 9.0 or later releases should use the new SELECTIVE_RECORDING constant and not the deprecated APPLICATION_CONTROLLED_RECORDING and DEVICE_CONTROLLED_RECORDING constants. In Release 9.0 or later releases Unified CM and JTAPI never return the DEVICE_CONTROLLED_RECORDING constant.


Superinterfaces

javax.telephony.Address, CiscoObjectContainer

Subinterfaces

CiscoIntercomAddress

Fields

Table 6-31 Fields in CiscoAddress

Interface
Field
Description

Static int

APPLICATION_CONTROLLED_RECORDING

Application controlled Recording is configured on the Address.

Static int

AUTO_RECORDING

Auto Recording is configured on the Address.

Static int

AUTOACCEPT_OFF

AutoAccept is off.

Static int

AUTOACCEPT_ON

AutoAccept is on.

Static int

AUTOANSWER_OFF

AutoAnswer is off.

Static int

AUTOANSWER_UNKNOWN

AutoAnswer status is unknown.

Static int

AUTOANSWER_WITHHEADSET

AutoAnswer is allowed with a headset.

static int

AUTOANSWER_WITHSPEAKERSET

AutoAnswer is allowed with a speaker set.

public static final int

DEVICE_CONTROLLED_RECORDING

This value will be used to specify a new recording type. This type is used when the recording profile is configured on the device, and is thus "device controlled"

static int

EXTERNAL

This represents an external address with a valid name.

static int

EXTERNAL_UNKNOWN

This represents an external address with an unknown name.

static int

IN_SERVICE

The address is in service.

static int

INTERNAL

This is an internal address.

static int

MONITORING_TARGET

This represents an address with a monitoring target or agent.

static int

NO_RECORDING

Recording is off on the Address.

static int

OUT_OF_SERVICE

The address is out-of-service.

static int

RINGER_DEFAULT

Sets the ringer status to the configured value.

static int

RINGER_DISABLE

Disables the ringer for the address.

static int

RINGER_ENABLE

Enables the ringer for the address.

static int

SELECTIVE_RECORDING

This constant is added to replace the deprecated constants APPLICTION_CONTROLLED_RECORDING and DEVICE_CONTROLLED_RECORDING

static int

UNKNOWN

This represents an address with an unknown name.


Methods

Table 6-32 Methods in CiscoAddress 

Interface
Method
Description

void

clearCallConnections()

Use this interface to clear any phantom calls on the address.

Throws

javax.telephony.PrivilegeViolationException—Use this interface to clear any phantom calls on the address.

CiscoAddressCallInfo

getAddressCallInfo
(javax.telephony.Terminal terminal)

Use this interface to get information about calls that are present at the Terminal.

String

getAsciiLabel(Terminal term)

This method returns the ASCII label configured for this address on Terminal term.

Throws InvalidStateException, MethodNotSupportedException, InValidParameterException.

int

getAutoAcceptStatus(javax.telephony.Terminal terminal)

Returns the AutoAccept status of the Address on the Terminal.

Throws

javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException

Returns the AutoAccept status of the Address on the Terminal. It may return one of the following constants:

CiscoAddress.AUTOACCEPT_OFF

CiscoAddress.AUTOACCEPT_ON

Pre-Conditions

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

(getState() == IN_SERVICE

Parameters

terminal - The Terminal on which the AutoAccepts

int

getAutoAnswerStatus(javax.telephony.Terminal term)

This interface returns the AutoAnswer status of this Address on given Terminal.

Throws

javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException

If return value is AUTOANSWER_OFF, that means AutoAnswer is disabled. If return value is AUTOANSWER_WITHHEADSET, that means AutoAnswer is enabled with HEADSET. If return value is AUTOANSWER_WITHSPEAKERSET, that means AutoAnswer is enabled with SPEAKERSET. If return value is AUTOANSWER_UNKNOWN, that means AutoAnswer status is UNKNOWN.

Pre-Conditions

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

(getState() == IN_SERVICE

Parameters

term - Terminal at which AutoAnswer is checked

Returns one of the following values:

CiscoAddress.AUTOANSWER_OFF

CiscoAddress.AUTOANSWER_
WITHHEADSET

CiscoAddress.AUTOANSWER_
WITHSPEAKERSET

CiscoAddress.AUTOANSWER_UNKNOWN

Throws

javax.telephony.InvalidStateException - The Provider or Address is not"IN_SERVICE".

javax.telephony.PlatformException - If Address is not on Terminal term

javax.telephony.MethodNotSupportedException - If Address is an External Address

int

getBusyTrigger(Terminal term)

This method returns the busy trigger configured for this address on terminal term.

Throws InvalidStateException, InvalidArgumentException, MethodNotSupportedException.

int

getButtonPosition(Terminal term)

This method returns the button position of the address on terminal term.

Throws InvalidStateException, InvalidArgumentException, MethodNotSupportedException.

javax.telephony.Terminal[]

getInServiceAddrTerminals()

Use this interface to find out which Shared Lines are in service. In Shared Lines, the same Address appears on different Terminals.

Returns: Terminal[]—An array of Terminals on which the Address is in service.

int

getMaxCalls(Terminal term)

This new method returns the maximum calls configured for an address on a terminal. This method throws InvalidStateException if the associated terminal is not registered to Cisco Unified Communication Manager. It throws InvalidArgumentException if terminal does not have this address. MethodNotSupportedException is be thrown if address is not in Provider

java.lang.String

getPartition()

It returns the partition associated with an Address.

CiscoPickupGroup

getPickupGroup()

This method returns a CiscoPickupGroup object that represents the Pickup Group DN and Partition that this Address belongs to.

int

getRecordingConfig(javax.
telephony.Terminal term)

Returns the configured recording type on this Address.

Throws

javax.telephony.PlatformException,javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException

Returns

int—The configured recording type on this Address.

CiscoAddess.NO_RECORDING —The call cannot be recorded.

CiscoAddress.AUTO_RECORDING—Cisco Unified Communications Manager records all answered calls to/from this address.

CiscoAddress.APPLICATION_CONTROLLED_RECORDING—Calls get recorded only when the application initiates recording.

Throws

javax.telephony.InvalidStateException - The Provider or Address is not"IN_SERVICE".

javax.telephony.PlatformException - If Address is not on Terminal term

javax.telephony.MethodNotSupportedException - If Address is an External Address

int

getRegistrationState()

Deprecated.

This method has been replaced by the getState() method. Returns the state of this address can be any of the following constants:

CiscoAddress.OUT_OF_SERVICE

CiscoAddress.IN_SERVICE

javax.telephony.
Terminal[]

getRestrictedAddrTerminals
()

Returns the array of Terminals on which this Address is restricted. In shared lines, few lines on Terminals may be restricted.

Applications cannot see any call events for restricted Addresses. If a restricted Address is involved in a call with any other controlled Terminal, the system creates a Connection for the restricted Address, but there is not any TerminalConnection for the restricted Address.

Returns: Terminal[]—An array of Terminals on which this Address is restricted. If none is restricted, this method returns null.

int

getState()

Returns the state of this address. The state may be any of the following constants:

CiscoAddress.OUT_OF_SERVICE

CiscoAddress.IN_SERVICE

int

getType()

Returns the following address constants:

CiscoAddress.INTERNAL

CiscoAddress.EXTERNAL

CiscoAddress.EXTERNAL_UNKNOWN

CiscoAddress.UNKNOWN

CiscoAddress.MONITORING_TARGET

CiscoAddress.HUNT_PILOT, if address is in a CiscoHuntConnection.

CiscoAddress.HUNT_PILOT, if address represents hunt pilot.

String

getUnicodeLabel(Terminal term)

This method returns the Unicode label configured for this address on Terminal term.

Throws InvalidStateException, MethodNotSupportedException, InValidParameterException.

int

getVoiceMailPilot()

This method returns the voice mail pilot of the address.

Throws InvalidStateException, MethodNotSupportedException.

boolean

isRestricted(javax.telephony.Terminal terminal)

This method returns true if this Address on Terminal is restricted.; false if not restricted.

void

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

This method lets an application enable AutoAccept for this Address on CiscoMediaTerminal and/or CiscoRouteTerminal.

Throws

javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException

This method lets an application enable AutoAccept for this Address on CiscoMediaTerminal and/or CiscoRouteTerminal.

Addresses on CiscoTerminal other than CiscoMediaTerminal or CiscoRouteTerminal will always have AutoAccept on. If the Terminal passed in the parameter is not a CiscoMediaTerminal or CiscoRouteTerminal, this method throws an exception.

For a CiscoMediaTerminal that shares an Address with CiscoTerminal, Cisco recommends enabling AutoAccept on CiscoMediaTerminal.

Pre-Conditions

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

(getState() == IN_SERVICE

Post-Conditions

Enables or Disables auto accept status

Parameters

autoAcceptStatus - can be either CiscoAddress.AUTOACCEPT_OFF or CiscoAddress.AUTOACCEPT_ON. If autoAcceptStatus is AUTOACCEPT_ON, it will enable AutoAccept for Address on Terminal. If autoAcceptStatus is AUTOACCEPT_OFF, it will disable AutoAccept for Address on Terminal.

terminal - The Terminal on which AutoAccept will be enabled

   

Throws

javax.telephony.InvalidStateException - The Provider or Address is not "In_Service".

javax.telephony.PlatformException - The Terminal does not have this Address.

javax.telephony.MethodNotSupportedException - If the Terminal is not CiscoMediaTerminal or CiscoRouteTerminal.

void

setMessageWaiting(java.lang.String destination, boolean enable)

Specifies whether the message-waiting indicator should be activated or deactivated for the Address specified by the destination. If enable is true, message-waiting gets activated if not already activated. If enable is false, message-waiting gets deactivated if not already deactivated.

Throws

javax.telephony.MethodNotSupportedException, javax.telephony.InvalidStateException,javax.telephony.PrivilegeViolationException

Pre-Conditions

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

Post-Conditions

Enables or disables the Message Waiting Indicator depending on the enable status.

Note This implementation currently does not enforce the post-conditions as specified in CallControlAddress as follows: this.getMessageWaiting() == enable

CallCtlAddrMessageWaitingEv gets delivered for this Address.

   

Parameters

destination - DN/Address message-waiting indicator is activated/deactivated

enable - True to activate message-waiting, false to deactivate

Throws

javax.telephony.MethodNotSupportedException—This method is not supported by the given implementation.

javax.telephony.InvalidStateException

Note The Provider is not "in service."

javax.telephony.PrivilegeViolationException

Note The Provider user has insufficient privileges to invoke the message-waiting indicator for this destination.

void

setRingerStatus(int status)

Changes the ringer status on this address.

Throws

javax.telephony.MethodNotSupportedException, javax.telephony.InvalidStateException, javax.telephony.InvalidArgumentException

Accepts one of the following constants:

CiscoAddress.RINGER_DEFAULT

CiscoAddress.RINGER_DISABLE

CiscoAddress.RINGER_ENABLE

void

setMessageSummary
(boolean enable, boolean voiceCounts, int totalNewVoiceMsgs, int totalOldVoiceMsgs, boolean highPriorityVoiceCounts, int newHighPriorityVoiceMsgs, int oldHighPriorityVoiceMsgs, boolean faxCounts, int totalNewFaxMsgs, int totalOldFaxMsgs, boolean highPriorityFaxCounts, int newHighPriorityFaxMsgs, int oldHighPriorityFaxMsgs)

Use this interface to set the message-waiting indicator along with voice/fax message waiting counts If enable is true, message-waiting gets activated if not already activated. If enable is false, message-waiting gets deactivated if not already deactivated.

Pre-conditions

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

Post-conditions

Enables or disables the Message Waiting Indicator and sets message waiting counts.

   

Parameters

enable - True to activate message-waiting, false to deactivate

voiceCounts - indicates if voice message counts are provided

totalNewVoiceMsgs - specifies the total number of new voice messages waiting

totalOldVoiceMsgs - specifies the total number of old voice messages waiting

highPriorityVoiceCounts - indicates if high priority voice message counts are provided

newHighPriorityVoiceMsgs - specifies the number of new high priority voice messages waiting

oldHighPriorityVoiceMsgs - specifies the number of old high priority voice messages waiting

faxCounts - indicates if fax message counts are provided

totalNewFaxMsgs - specifies the total number of new fax messages waiting

totalOldFaxMsgs - specifies the total number of old fax messages waiting

highPriorityFaxCounts - indicates if high priority fax message counts are provided

newHighPriorityFaxMsgs - specifies the number of new high priority fax messages waiting

oldHighPriorityFaxMsgs - specifies the number of old high priority fax messages waiting

Throws

javax.telephony.MethodNotSupportedException - This method is not supported by the given implementation.

javax.telephony.InvalidStateException - The Provider is not "in service."

javax.telephony.PrivilegeViolationException - The Provider user has insufficient privileges to set the message-waiting indicator or message counts for this destination.

void

setMessageSummary(java.lang.String destination, boolean enable, boolean voiceCounts, int totalNewVoiceMsgs, int totalOldVoiceMsgs, boolean highPriorityVoiceCounts, int newHighPriorityVoiceMsgs, int oldHighPriorityVoiceMsgs, boolean faxCounts, int totalNewFaxMsgs, int totalOldFaxMsgs, boolean highPriorityFaxCounts, int newHighPriorityFaxMsgs, int oldHighPriorityFaxMsgs)

Use this interface to set the message-waiting indicator along with voice/fax message waiting counts for the Address specified by the destination

Pre-conditions

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

Post-conditions

Enables or disables the Message Waiting Indicator and sets message waiting counts.

Parameters

destination - DN/Address whose message-waiting indicator should be activated/deactivated

enable - True to activate message-waiting, false to deactivate

voiceCounts - indicates if voice message counts are provided

totalNewVoiceMsgs - specifies the total number of new voice messages waiting

totalOldVoiceMsgs - specifies the total number of old voice messages waiting

highPriorityVoiceCounts - indicates if high priority voice message counts are provided

newHighPriorityVoiceMsgs - specifies the number of new high priority voice messages waiting

oldHighPriorityVoiceMsgs - specifies the number of old high priority voice messages waiting

faxCounts - indicates if fax message counts are provided

totalNewFaxMsgs - specifies the total number of new fax messages waiting

totalOldFaxMsgs - specifies the total number of old fax messages waiting

highPriorityFaxCounts - indicates if high priority fax message counts are provided

newHighPriorityFaxMsgs - specifies the number of new high priority fax messages waiting

oldHighPriorityFaxMsgs - specifies the number of old high priority fax messages waiting


Inherited Methods

From Interface javax.telephony.Address

addCallObserver, addObserver, getAddressCapabilities, getCallObservers, getCapabilities, getConnections, getName, getObservers, getProvider, getTerminals, removeCallObserver, removeObserver

From Interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Related Documentation

See Also Constant Field Values for more information.

CiscoAddressObserver

Applications implement this interface to receive CiscoAddrEv events such as CiscoAddrInServiceEv 0 CiscoAddrOutOfServiceEv when observing Addresses via the Address.addObserver method.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.AddressObserver

Declaration

public interface CiscoAddressObserver extends javax.telephony.AddressObserver

Fields

None

Methods

None

Inherited Methods

From Interface javax.telephony.AddressObserver

addressChangedEvent

Related Documentation

See CiscoAddrInServiceEv, CiscoAddrOutOfServiceEv for more information.

CiscoAddrEv

The CiscoAddrEv interface extends the JTAPI core javax.telephony.events.AddrEv interface and serves as the base interface for all Cisco extended JTAPI Address events. Every Address related event in this package extends this interface, directly or indirectly.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.events.AddrEv, CiscoEv, javax.telephony.events.Ev

Subinterfaces

CiscoAddrAutoAcceptStatusChangedEv, CiscoAddrInServiceEv, CiscoAddrIntercomInfoChangedEv, CiscoAddrIntercomInfoRestorationFailedEv, CiscoAddrOutOfServiceEv, CiscoAddrRecordingConfigChangedEv

Declaration

public interface CiscoAddrEv extends CiscoEv, javax.telephony.events.AddrEv

Fields

None

Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

None

Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.AddrEv

getAddress

From interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See javax.telephony.events.AddrEv for more information.

CiscoAddrEvFilter

CiscoAddrEvFilter provided for applications to set filters for address events. The application can use the following APIs to enable/disable the filters to receive the event notifications on address or to check the value set of the filter. Application can enable the filter, if it wishes to receive the new event (CiscoAddrParkStatusEv), for the rest of the events the filter values are true by default.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Added this event for Park Monitoring and Assisted DPark Support feature.

7.1.(3)

Interface is enhanced to allow application set filter on address to enable and disable CiscoAddrVoiceMailPilotChangedEv.

8.0(1)

Enhanced with the following:

getCiscoAddrMonitoringTerminatedEvFilter()

setCiscoAddrMonitoringTerminatedEvFilter()

By default the filter will be set to `true' and CiscoMonitoringTerminatedEv will be delivered. To stop receiving this event applications need to set the filter to false.


Fields

None

Methods

Table 6-33 Methods in CiscoAddrEvFilter

Interface
Method
Description

boolean

getCiscoAddrParkStatusEvFilter()

Application can invoke this API to know status of the filter for CiscoAddrParkStatusEv. Default value returned is false.

boolean

getCiscoAddrIntercomInfo
ChangedEvFilter()

Application can invoke this API to know the stutus of the filter for CiscoAddrIntercomInfoChangedEv. Default value is true.

boolean

getCiscoAddrIntercomInfo
RestorationFailedEvFilter()

Application can invoke this API to know the status of the filter for CiscoAddrIntercomInfoRestorationFailedEv. Default value is true.

boolean

getCiscoAddrMonitoringTerminatedEvFilter()

This interface can be used to get the CiscoAddrMonitoringTerminatedEv filter status.

boolean

getCiscoAddrPickupGroupChangedEvFilter()

This interface can be used to get CiscoAddrPickupGroupChangedEv filter status.

boolean

getCiscoAddrRecordingConfig
ChangedEvFilter()

Application can invoke this API to get the status of the filter for the CiscoAddrRecordingConfigChangedEv. The default value is true.

boolean

getCiscoAddrVoiceMailPilotChangedEvFilter()

This method returns true if voice mail pilot changed event filter is turned on else false.

void

setCiscoAddrIntercomInfo
ChangedEvFilter(boolean filter value)

Application can invoke this API to set the status of the filter for CiscoAddrIntercomInfoChangedEv.

void

setCiscoAddrIntercomInfoRestorationFailedEvFilter(boolean
filter value)

Application can invoke this API to set the status of the filter for CiscoAddrIntercomInfoRestorationFailedEv.

void

setCiscoAddrMonitorTerminatedEvFilter(Boolean filterValue)

This interface is provided for enabling/disabling the CiscoAddrMonitoringTerminatedEv filter status.

Void

setCiscoAddrParkStatusEvFilter
(Boolean filterValue)

Application can invoke this API to set the status of the filter for CiscoAddrParkStatusEv.

void

setCiscoAddrPickupGroupChangedEvFilter(boolean filterValue)

This interface is provided for enabling/disabling the CiscoAddrPickupGroupChangedEv filter for the Address.

void

setCiscoAddrRecordingConfig
ChangedEvFilter(boolean filter value)

Application can invoke this API to set the value of the filter for CiscoAddrRecordingConfigChangedEv.

void

setCiscoAddrVoiceMailPilotChangedEvFilter(boolean filterValue)

This method enables or disables the address voice mail changed event. When this filter is turned on CiscoAddrVoiceMailPilotChangedEv is delivered to address observer when voice mail configuration is changed.


Sample Code:

CiscoAddress caddr = (CiscoAddress) provider.getAddress("2000");
	If ( caddr != null ){
		CiscoAddrEvFilter filter = caddr.getFilter();
		filter.setCiscoAddrVoiceMailPilotChangedEvFilter(true); 
		caddr.addObserver(myAddrObserver);
	}
 
   
try {
          JtapiPeer peer = JtapiPeerFactory.getJtapiPeer ( null );
 
   
         MyProviderObserver providerObserver = new MyProviderObserver ();
         provider = peer.getProvider ( ipaddress;login=useid;passwd=password );
         if ( provider != null ) {
		provider.addObserver ( providerObserver );
		provInService.waitTrue();
		CiscoAddrEvFilter filter;
		CiscoAddress addr = provider.getAddress(S1, S1p);
		filter.setCiscoAddrMonitoringTerminatedEvFilter(false);
		addr.setFilter(filter);
System.out.println(" Current filter value is : "+ 
addr.getFilter().getCiscoAddrMonitoringTerminatedEvFilter());
}

Inherited Methods

None

Parameters

The set methods take a Boolean value as the parameter.

Value Range

The get methods return a Boolean value (true or false).

Related Documentation

See Constant Field Values.

CiscoAddrInServiceEv

The CiscoAddrInServiceEv indicates that the Address is now IN_SERVICE. With Shared Lines (where the same Address appears on different Terminals), applications may receive multiple CiscoAddressInService events for all the Terminals. Applications can use this interface to find out the Terminal on which the Address (or Shared Line) is going IN_SERVICE.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, javax.telephony.events.Ev

Declaration

public interface CiscoAddrInServiceEv extends CiscoAddrEv

Fields

Table 6-34 Fields in CiscoAddrInService

Interface
Field

Static int

ID


Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-35 Methods in CiscoAddrInService

Interface
Method
Description

getTerminal

CiscoTerminal getTerminal()

Returns the Terminal at which this Address is going IN_SERVICE.


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From interface javax.telephony.events.AddrEv

getAddress

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Related Documentation.getInServiceAddrTerminals() and Constant Field Values for more information.

CiscoAddrIntercomInfoChangedEv

The system sends the CiscoAddrIntercomInfoChangedEv event to the application whenever the target DN or intercom target label changes for a CiscoIntercomAddress. The system provides this event to all of the application observers that have been added to the CiscoIntercomAddress.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, javax.telephony.events.Ev

Declaration

public interface CiscoAddrIntercomInfoChangedEv extends CiscoAddrEv

Fields

Table 6-36 Fields in CiscoAddrIntercomInfoChangedEv

Interface
Field

Static Int

ID


Inherited Fields

From interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-37 Methods in CiscoAddrIntercomInfoChangedEv

Interface
Method
Description

getIntercomAddress

getIntercomAddress()

Returns the intercom address for which the information changed.


Inherited Methods

From interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From interface javax.telephony.events.AddrEv

getAddress

From interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See CiscoAddrEv and Constant Field Values for more information.

CiscoAddrIntercomInfoRestorationFailedEv

The system sends the CiscoAddrIntercomInfoRestorationFailedEv event to the application when JTAPI cannot restore the application set intercom target DN or the intercom target label for the CiscoIntercomAddress during failover or fallback. The system provides this event on the application observer for the application that set the intercom target DN or the intercom target label.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, javax.telephony.events.Ev

Declaration

public interface CiscoAddrIntercomInfoRestorationFailedEv extends CiscoAddrEv

Fields

Table 6-38 Fields in CiscoAddrIntercomInfoRestorationFailedEv

Interface
Field

Static int

ID


Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-39 Methods in CiscoAddrIntercomInfoRestorationFailedEv

Interface
Method
Description

CiscoIntercomAddress

getIntercomAddress()

This interface returns the Cisco IntercomAddress for which intercom information restoration failed.


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.AddrEv

getAddress

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values and CiscoAddrEv for additional information.

CiscoAddrPickupGroupChangedEv

CiscoAddrPickupGroupChangedEv is a new interface being added with Call Pickup feature development. This event is fired whenever a pickup group's information changes, and the line info gets updated. The line info will only be updated when the line is updated with the "apply config" button in the CUCM.

Cisco Unified Communications Manager Release Number
Description

8.0(1)

New interface


Interface History

Declaration

public interface CiscoAddrPickupGroupChangedEv extends CiscoProvEv

Methods

Table 6-40 Methods in CiscoAddrPickupGroupChangedEv

Interface
Method
Description

CiscoPickupGroup

getOldPickupGroup()

This method returns the old Pickup Group information for this event.

CiscoPickupGroup

getNewPickupGroup()

This method returns the new Pickup Group information for this event, what the pickup group has changed to.


New Error Code

CTIERR_PICKUPGROUP_CHANGED

CTIERR_PICKUPGROUP_DELETED

CiscoAddrOutOfServiceEv

The CiscoAddrOutOfServiceEv event notifies applications that an Address has gone OUT_OF_SERVICE. With Shared Lines(where the same Address appears on different Terminals), applications may receive multiple CiscoAddrOutOfServiceEv events for all the Terminals. Applications can use this interface to find out the Terminal on which the Address(or Shared Line) is going OUT_OF_SERVICE.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, CiscoOutOfServiceEv, javax.telephony.events.Ev

Declaration

public interface CiscoAddrOutOfServiceEv extends CiscoAddrEv, CiscoOutOfServiceEv

Fields

Table 6-41 Fields in CiscoAddrOutOfServiceEv

Interface
Field

Static int

ID


Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface com.cisco.jtapi.extensions.CiscoOutOfServiceEv

CAUSE_CALLMANAGER_FAILURE, CAUSE_CTIMANAGER_FAILURE, CAUSE_DEVICE_FAILURE, CAUSE_DEVICE_RESTRICTED, CAUSE_DEVICE_UNREGISTERED, CAUSE_LINE_RESTRICTED, CAUSE_NOCALLMANAGER_AVAILABLE, CAUSE_REHOME_TO_HIGHER_PRIORITY_CM, CAUSE_REHOMING_FAILURE

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-42 Methods in CiscoAddrOutOfServiceEv

Interface
Method
Description

CiscoTerminal

getTerminal()

Returns the Terminal at which this Address is going OUT_OF_SERVICE.


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.AddrEv

getAddress

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values and Related Documentation.getInServiceAddrTerminals() for more information.

CiscoAddrParkStatusEv

When parking a call using the Cisco Unified IP Phone, JTAPI reports park states by using this event. It is provided to all the applications, which have address observers added on the address, which has invoked park. This event gets delivered only when park gets invoked from Cisco Unified IP Phones.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Added interface for Park Monitoring and Assisted DPark feature.


Declaration

public interface CiscoAddrParkStatusEv extends CiscoAddrEv

Fields

Table 6-43 Fields in CiscoAddrParkStatusEv

Interface
Field
Description

static int

PARKED

Park status when the call is parked.

static int

REMINDER

Park status when the park monitoring reversion timer expires.

static int

RETRIEVED

Park status when the parked call is retrieved by the parker or a third party.

static int

FORWARDED

Park status when the parked call is forwarded when the park monitoring forward- no-retrieve timer expires.

static int

ABANDONED

Park status when the parked call is disconnected.


Inherited Fields

None

Methods

Table 6-44 Methods in CiscoAddrParkStatusEv

Interface
Method
Description

int

getParkState()

Returns the current park state of the parked call.

int

getTransactionID()

Returns an id which is unique for a particular parked call. Transaction ID would remain the same in the different park states for the same parked call.

CiscoCallID

getCiscoCallID()

Returns CiscoCallID.

String

getParkDN()

Returns the DN where call is parked.

String

getParkDNPartition()

Returns the partition of the Park DN.

String

getParkedParty()

Returns the DN of the parked party.

String

getParkedPartyPartition()

Returns the partition of the Parked party.

Terminal

getTerminal()

Returns the terminal on whose address this event is delivered.


Value Ranges

The following are values of fields:

PARKED: 2

REMINDER: 3

RETRIEVED: 4

ABANDONED: 5

FORWARDED: 6

Related Documentation

See Constant Field Values for more information.

CiscoAddrRecordingConfigChangedEv

The system delivers the CiscoAddrRecordingConfigChangedEv event to the Address Observer if the recording setting on the Address changes.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, javax.telephony.events.Ev

Declaration

public interface CiscoAddrRecordingConfigChangedEv extends CiscoAddrEv

Fields

Table 6-45 Fields in CiscoAddrRecordingConfigChangedEv

Interface
Field

static int

ID


Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-46 Methods in CiscoAddrRecordingConfigChangedEv

Interface
Method
Description

Int

getRecordingConfig()

Returns the new recording configuration on this Address. The value is one of the following:

CiscoAddress.NO_RECORDING

CiscoAddress.AUTO_RECORDING

CiscoAddress.APPLICATION_CONTROLLED
_RECORDING

javax.telephony.Terminal

getTerminal()

Returns the Terminal on which the recording configuration changed.


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.AddrEv

getAddress

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values and CiscoAddrEv for more information.

CiscoAddrRemovedEv

JTAPI sends the CiscoAddrRemovedEv event when an Address gets removed from the Provider domain.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Declaration

public interface CiscoAddrRemovedEv extends CiscoProvEv

Fields

Table 6-47 Fields in CiscoAddrRemovedEv

Interface
Field

static int

ID


Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-48 Methods in CiscoAddrRemovedEv

Field
Method
Description

javax.telephony.Address

getAddress()

Returns the Address that is removed from provider domain and the address which is removed from the user control list.


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.ProvEv

getProvider

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values for more information.

CiscoAddrRemovedFromTerminalEv

The system sends the CiscoAddrRemovedFromTerminalEv event under the following conditions:

When an Administrator removes a Terminal from the user control list that contains a Shared Line.

When an Extension Mobility (EM) user logs out from a Terminal with a profile that contains a Shared Line, this event notifies that one of the Terminals got removed from an existing Address.

When a Shared Line is removed from a Terminal that is in a user control list.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Declaration

public interface CiscoAddrRemovedFromTerminalEv extends CiscoProvEv

Fields

Table 6-49 Fields in CiscoAddrRemovedFromTerminalEv

Interface
Field

Static int

ID


Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-50 Methods in CiscoAddrRemovedFromTerminalEv

Interface
Method
Description

javax.telephony.Address

getAddress()

Returns the Address from which the Terminal got removed.

javax.telephony.Terminal

getTerminal()

Returns the Terminal that got removed from the Address.


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.ProvEv

getProvider

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Also Constant Field Values for more information.

CiscoAddrRestrictedEv

If an Address is observed and the restriction status is changed to restricted, the system sends this event to the application.

Applications will see this event whenever an Address or an associated Terminal is 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, the system does not throw an exception but the restricted shared lines will not receive any events. If all shared lines are restricted, an exception is thrown when application try adding observers. If an Address gets restricted after observers are added, applications will see CiscoAddrOutOfServiceEv, and when the Address is activated, the Address will go IN_SERVICE.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

CiscoEv, CiscoProvEv, CiscoRestrictedEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Declaration

public interface CiscoAddrRestrictedEv extends CiscoRestrictedEv

Fields

None

Inherited Fields

From Interface com.cisco.jtapi.extensions.CiscoRestrictedEv

CAUSE_UNKNOWN, CAUSE_UNSUPPORTED_DEVICE_CONFIGURATION, CAUSE_UNSUPPORTED_PROTOCOL, CAUSE_USER_RESTRICTED

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-51 Methods in CiscoAddrRestrictedEv

Interface
Method
Description

javax.telephony.Address

getAddress()

Returns the Address which is changed to Restricted on Cisco Unified Communications Manager.


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.ProvEv

getProvider

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Also Constant Field Values for more information.

CiscoAddrRestrictedOnTerminalEv

If the user has Shared lines in the control list, and one of those lines is marked restricted on Cisco Unified Communications Manager, the system sends this event.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

CiscoEv, CiscoProvEv, CiscoRestrictedEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Declaration

public interface CiscoAddrRestrictedOnTerminalEv extends CiscoRestrictedEv

Fields

Table 6-52 Fields in CiscoAddrRestrictedOnTerminalEv

Interface
Field

Static int

ID


Inherited Fields

From Interface com.cisco.jtapi.extensions.CiscoRestrictedEv

CAUSE_UNKNOWN, CAUSE_UNSUPPORTED_DEVICE_CONFIGURATION, CAUSE_UNSUPPORTED_PROTOCOL, CAUSE_USER_RESTRICTED

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-53 Methods in CiscoAddrRestricedOnTerminalEv

Interface
Method
Description

javax.telephony.Address

getAddress()

Returns the Address that is restricted.

javax.telephony.Terminal

getTerminal()

Returns the Terminal on which the Address is restricted.


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.ProvEv

getProvider

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values for more information.

CiscoAddrVoiceMailPilotChangedEv

This event indicates that the voice mail pilot configuration on address is changed and is delivered to address observer. Application needs to enable the corresponding filter in CiscoAddrEvFilter to receive this event.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(3)

New interface.


Sample Code:

class myAddrObserver  extends CiscoAddressObserver {
public synchronized void addressChangedEvent ( AddrEv [] eventList ) {
if ( eventList[i] instanceof CiscoAddrVoiceMailPilotChangedEv){
	CiscoAddrVoiceMailPilotChangedEv ev = (CiscoAddrVoiceMailPilotChangedEv) eventList[i];
	Address cAddr = ev.getAddress();
	String newVoiceMailPilot = ev.getVoiceMailPilot();
	System.out.println(" New voice mail pilot for " + ev.getAddress()  +   " is " +  
newVoiceMailPilot );
	}
}
}

Superinterfaces

NA

Declaration

NA

Fields

Table 6-54 Fields in CiscoAddrVoiceMailPilotChangedEv

Interface
Field
   

Inherited Fields

Methods

Table 6-55 Methods in CiscoAddrVoiceMailPilotChangedEv

Interface
Method
Description

String

getVoiceMailPilot()

This method returns the new voice mail pilot of the address.


Inherited Methods

Related Documentation

See Constant Field Values for more information.

CiscoBaseMediaTerminal

The CiscoBaseMediaTerminal interface extends the CiscoTerminal interface.

Interface History

Cisco Unified Communications Manager Release Number
Description

8.5(1)

New interface.


Declaration

public interface CiscoBaseMediaTerminal extends CiscoTerminal

Superinterfaces

NA

Fields

Table 6-56 Fields in CiscoBaseMediaTerminal

Interface
Field

Final static int

NO_MEDIA_REGISTRATION

Final static int

DYNAMIC_MEDIA_REGISTRATION

Final static int

DYNAMIC_MEDIA_REGISTRATION_FOR_GET_PORT_SUPPORT

Final static int

STATIC_MEDIA_REGISTRATION

Final static int

STATIC_MEDIA_REGISTRATION_FOR_GET_PORT SUPPORT


Inherited Fields

NA

Methods

Table 6-57 Methods in CiscoBaseMediaTerminal 

Interface
Method

int

getRegistrationType()

void

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

throws CiscoRegistrationException, PrivilegeViolationException;


Inherited Methods

NA

Parameters

register()

Java.net.InteAddress address

int port

CiscoMediaCapability[] capabilities

int[] algorithmIDs

Java.net.InteAddress address_v6

int activeAddressingMode

int registrationType

Data Types

Java.net.InteAddress address

int port

CiscoMediaCapability[] capabilities

int[] algorithmIDs

Java.net.InteAddress address v6

int activeAddressingMode

int registrationType

Range of Values

activeAddressingMode:
CiscoTerminal.IP_ADDRESSING_MODE_IPv4 or CiscoTerminal.IP_ADDRESSING_MODE_IPv6, or CiscoTerminal.IP_ADDRESSING_MODE_IPv4_v6

registrationType:
CiscoTerminal.NO_MEDIA_REGISTATION (applicable only for route points)
CiscoTerminal.DYNAMIC_MEDIA_REGISTRATION
CiscoTerminal.DYNAMIC_MEDIA_REGISTRATION_FOR_GET_PORT_SUPPORT
CiscoTerminal.STATIC_MEDIA_REGISTRATION
CiscoTerminal.STATIC_MEIDA_TERMINAL_FOR_GET_PORT_SUPPORT

CiscoCall

The CiscoCall interface extends the CallControlCall interface with additional Cisco Unified Communications Manager specific capabilities.

In Cisco Unified Communications Manager, every Call object comprises a set of call legs that share a common identifier: the global call handle. Connection objects represent call legs in JTAPI, and the Call object that relates a set of connections contains the global call handle that the underlying call legs share.

The global call handle within a CiscoCall is accessible by using CallManagerID and CallID properties. Taken together, the CallManagerID and CallID form the global call handle that Cisco Unified Communications Manager maintains. Consider this pair of properties as guaranteed to be unique among all ACTIVE Call objects, but when an ACTIVE call becomes INACTIVE, its CallManagerID and CallID may be reused to identify a newly created Call object. Therefore, an INACTIVE Call can have identical CallManagerID and CallID properties to those of a currently ACTIVE Call object.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Added new method called isConference() for Drop Any Party feature.

8.0(1)

Enhanced with the folllowing:

New methods that allow applications to get the Terminals associated with the current calling and current called parties on the call.

New API to indicate whether the call is created due to CallFwdAll key press or not.

Three new constants, CFWD_ALL_NONE, CFWD_ALL_SET, and CFWD_ALL_CLEAR, have been introduced for CiscoCall interface.

9.0(1)

Five new constants, CALL_RECORDING_TYPE_NONE, CALL_RECORDING_TYPE_AUTOMATIC, CALL_RECORDING_TYPE_APPLICATION_INITIATED_SILENT, CALL_RECORDING_TYPE_USER_INITIATED_FROM_APPLICATION, and CALL_RECORDING_TYPE_USER_INITIATED_FROM_DEVICE, are added.


Superinterfaces

javax.telephony.Call, javax.telephony.callcontrol.CallControlCall, CiscoObjectContainer

Subinterfaces

CiscoConsultCall

Declaration

public interface CiscoCall extends javax.telephony.callcontrol.CallControlCall, CiscoObjectContainer

Fields

Table 6-58 Fields in CiscoCall 

Interface
Field
Description

static int

CALL_RECORDING_TYPE_APPLICATION_INITIATED_SILENT

This constant is used when silent is the recording invocation type. Silent recording is the default value in releases prior to Release 9.0.

static int

CALL_RECORDING_TYPE_AUTOMATIC

This constant is used when recording is invoked automatically by Unified CM, as a result of the line configuration.

static int

CALL_RECORDING_TYPE_NONE

This constant is used when a call is not recorded.

static int

CALL_RECORDING_TYPE_USER_INITIATED_FROM_APPLICATION

This constant is used when user is the recording invocation type, and the request was invoked by an application.

static int

CALL_RECORDING_TYPE_USER_INITIATED_FROM_DEVICE

This constant is used when recording was invoked on the Cisco IP device.

Static int

CALLSECURITY_AUTHENTICATED

Call security status is authenticated.

Static int

CALLSECURITY_ENCRYPTED

Call security status is encrypted.

Static int

CALLSECURITY_NOTAUTHENTICATED

Call security status is not authenticated.

Static int

CALLSECURITY_UNKNOWN

Call security status is unknown.

public static final int

CFWD_ALL_NONE

When call is not created due to CallFwdAll soft key press. Value is 0.

public static final int

CFWD_ALL_SET

When call is created due to CallFwdAll key press to set CFA. Value is 64.

public static final int

CFWD_ALL_CLEAR

When call is created to CallFwdAll key press to clear/cancel CFA. Value is 128.

Static int

FEATUREPRIORITY_EMERGENCY

Feature priority is emergency

Static int

FEATUREPRIORITY_NORMAL

Feature priority is normal

Static int

FEATUREPRIORITY_URGENT

Feature priority is urgent

int

getCFwdAllKeyPressIndicator()

 

Static int

PLAYTONE_BOTHLOCALANDREMOTE

A tone plays to both the caller and the monitor target (agent) when this option gets used.

Static int

PLAYTONE_LOCALONLY

A tone plays only to the monitor target (agent) when this option gets used.

Static int

PLAYTONE_NOLOCAL_OR_REMOTE

When this option is used no tone plays to the monitor target (agent) or the caller.

Static int

PLAYTONE_REMOTEONLY

A tone plays only to the caller when this option gets used.

Static int

SILENT_MONITOR

This option indicates that silent monitor is requested.


Inherited Fields

From Interface javax.telephony.Call

ACTIVE, IDLE, INVALID

Sample Code

public class MyCallObserver implements implements CallObserver, CallControlCallObserver, 
MediaCallObserver {
public void callChangedEvent (CallEv[] evlist) {
        for(int i=0; evlist != null && i < evlist.length; i++){
	...
	...
	If ( evlisth[i] instance of TermConnActiveEv){
		CiscoCall thisCall =(CiscoCall) ((TermConnActiveEv) evlist[i]).getCall();
		int cfaStatus = thisCall.getCFWDAllKeyPressIndicator();
		if (cfaStatus == CiscoCall.CFWD_ALL_SET || cfaStatus == CiscoCall.CFWD_ALL_CLEAR){
		    System.out.println("Call is created due to CallFwdAll soft key press");
		}else {
		    System.out.println("Call is NOT created due to CallFwdAll soft key press");
		}
	}
        }
        ...
        ...
  }

Methods

Table 6-59 Methods in CiscoCall 

Interface
Method
Description

Void

conference(javax.telephony.Call[]otherCalls)

This interface conferences multiple calls together, resulting in the union of the participants of all the calls being placed on a single call.

javax.telephony.
Connection[]

connect (javax.telephony.Terminal origterm, javax.telephony.Address origaddr java.lang.String.dialedDigits int featurePriority)

This method overloads Call.connect().It takes a new parameter featurePriority. The featurePriority parameter may be:

CiscoCall.FEATUREPRIORITY_NORMAL

CiscoCall.FEATUREPRIORITY_URGENT

CiscoCall.FEATUREPRIORITY_
EMERGENCY

Throws: javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidPartyException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException

boolean

getCalledAddressPI()

Returns the Presentation Indicator(PI) that is associated with getCalledAddressPI.

CiscoPartyInfo

getCalledPartyInfo()

Returns the PartyInfo of the called party of the call.

CiscoCallID

getCallID()

CallID is a unique identifier among all ACTIVE calls with the same CallManagerID.

boolean

getCallingAddressPI()

Returns the Presentation Indicator(PI) that is associated with getCallingAddressPI.

int

getCallSecurityStatus()

This interface returns the SecurityStatus of the Call.

CiscoConference
Chain

getConferenceChain()

This interface returns a CiscoConferenceChain object if this Call is a chained conference Call.

javax.telephony.
Address

getCurrentCalledAddress()

Returns the current called Address for the call.

boolean

getCurrentCalledAddressPI()

Returns the Presentation Indicator(PI) that is associated with CurrentCalledAddress.

boolean

getCurrentCalledDisplayNamePI()

Returns the Presentation Indicator(PI) that is associated with getCurredCalledDisplayNamePI.

java.lang.String

getCurrentCalledPartyDisplayName()

This interface returns the display name of the called party in the call.

CiscoPartyInfo

getCurrentCalledPartyInfo()

Returns the PartyInfo of the current called party of the call.

java.lang.String

getCurrentCalledPartyUnicodeDisplayName()

Returns the Unicode display name of the called party in the call.

int

getCurrentCalledPartyUnicodeDisplayNamelocale()

Returns the locale of the current called party Unicode display name.

javax.telephony.
Address

getCurrentCallingAddress()

Returns the current calling Address for the call.

boolean

getCurrentCallingAddressPI()

Returns the Presentation Indicator(PI) that is associated with getCurrentCallingAddressPI.

boolean

getCurrentCallingDisplayNamePI()

Returns the Presentation Indicator(PI) that is associated with getCurrentCalledDisplayNamePI.

java.lang.String

getCurrentCallingPartyDisplayName()

This interface returns the display name of the calling party.

CiscoPartyInfo

getCurrentCallingPartyInfo()

Returns the PartyInfo of the current calling party of the call.

java.lang.String

getCurrentCallingPartyUnicodeDisplayName()

Returns the Unicode display name of the calling party in the call.

int

getCurrentCallingPartyUnicodeDisplayNamelocale()

Returns the locale of the current called party Unicode display name.

Terminal

getCurrentCallingTerminal()

This method returns a Terminal object that represents the terminal of the calling party on the call.

By default, if the terminal is not defined, these will return null. An example of when this would occur is when a phoen goes offhook, and a one-sided call is created. The CalledTerminal would be null in this scenario. The terminal for the called party is only set AFTER the called party answers a call.

Terminal

getCurrentCalledTerminal()

This method returns a Terminal object that represents the terminal of the called party on the call.

By default, if the terminal is not defined, these will return null. An example of when this would occur is when a phoen goes offhook, and a one-sided call is created. The CalledTerminal would be null in this scenario. The terminal for the called party is only set AFTER the called party answers a call.

java.lang.String

getGlobalizedCallingParty()

This will return the globalizedCallingParty

CiscoPartyInfo

getLastRedirectedPartyInfo()

Returns the PartyInfo of the last redirecting party of the call.

boolean

getLastRedirectingAddressPI()

Returns the Presentation Indicator(PI) that is associated with getLastRedirectingAddressPI.

CiscoPartyInfo

getLastRedirectingPartyInfo()

Deprecated. - use getLastRedirectedPartyInfo();

javax.telephony.
Address

getModifiedCalledAddress()

This interface returns the modified called Address for the call if called party is modified by using called party transformation pattern or other means.

javax.telephony.
Address

getModifiedCallingAddress()

This interface returns the modified calling Address for the call if an application modifies its calling party by using the selectRoute API or other means.

javax.telephony.
Connection[]

startMonitor(javax.telephony.Terminal 
MonitorInitiatorterminal, javax.telephony.Address 
MonitorInitiatoraddress, int monitorTargetcallid, java.lang.String monitorTargetDN, java.lang.String monitorTargetTerminalName, int monitorType, int playToneDirection)

If the application has the information about the call at the monitor target, the application can use this interface to monitor calls.

javax.telephony.
Connection[]

startMonitor(javax.telephony.Terminal 
MonitorInitiatorterminal, javax.telephony.Address MonitorInitiator
address, javax.telephony.TerminalConnection term
ConnofMonitorTarget, int monitorType, int PlayToneDirection)

If the application is observing the monitor target (agent) Address, the application can use the Terminal connection of the monitor target (agent) to initiate a monitor request.

javax.telephony.
Connection

transfer(java.lang.String address, java.lang.String facCode, java.lang.String cmcCode)

This method is similar to the CallControlCall.transfer(String address) interface except that it also takes facCode (Forced Authorization Code) and cmcCode (Client Matter Code) if the transfer Address requires these codes to offer the call.



Note In Cisco Unified JTAPI implementation, CallControlCall.getCalledAddress() returns the first called party of the call which is the original called party.


Inherited Methods

From Interface javax.telephony.callcontrol.CallControlCall

addParty, conference, consult, consult, drop, getCalledAddress, getCallingAddress, getCallingTerminal, getConferenceController, getConferenceEnable, getLastRedirectedAddress, getTransferController, getTransferEnable, offHook, setConferenceController, setConferenceEnable, setTransferController, setTransferEnable, transfer, transfer

From Interface interface javax.telephony.Call

addObserver, connect, getCallCapabilities, getCapabilities, getConnections, getObservers, getProvider, getState, removeObserver

From Interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Parameters

origterm -

origaddr -

dialedDigits -

featurePriority -

Conference Controller

For the conferencing feature to happen, a common participant must belong to all the Calls, as represented TerminalConnection of common participants on controller Terminal. These TerminalConnections are known as the conference controllers. At the most, only one of TerminalConnection on the Calls at controller Terminal would be in CallControlTerminalConnection.TALKING state, and hence, the TerminalConnection on the secondary Call should be in the CallControlTerminalConnection.HELD state. As a result of invokation of this method, all the conference controller TerminalConnection merge into one TerminalConnection.

Applications can set which Terminal would acts as the conference controller when a conference call gets set up by setting up Conference controller TerminalConnection via invoking CallControlCalll.setConferenceController() method. The CalControlCall.getConferenceController() method returns the current conference controller, or null if there is none. If no conference controller is set initially, the implementation chooses a suitable TerminalConnection when the conferencing feature is invoked.

Telephone Call Argument

All participants from the secondary Calls, passed as the argument to this method, move to the Call on which this method was invoked. That is, new Connections and TerminalConnections for the participant in the secondary Calls are created on this Call. The Connections and TerminalConnections on the secondary Calls get removed from the Call, and the Call moves to the Call.INVALID state.

Other Shared Participants

There may exist other Addresses and Terminals that are part of some calls in addition to the designated conference controller. In these instances, those participants that are shared between both Calls are merged into one. That is, the Connections and TerminalConnections on this Calls stay unchanged. The corresponding Connections and TerminalConnections on the secondary Calls get removed from that Call.

Pre-Conditions

1. Let tc1 be the conference controller on this Call

2. Let connection1 = tc1.getConnection()

3. Let tc2 to tcN be the conference controllers on otherCalls

4. (this.getProvider()).getState() == Provider.IN_SERVICE

5. this.getState() == Call.ACTIVE

6. tc1.getTerminal() == tc2.getTerminal()...=tcN.getTerminal

7. tc1.getCallControlState() == CallControlTerminalConnection.TALKING/HELD

8. tc2-tcN.getCallControlState() == CallControlTerminalConnection.HELD/TALKING

9. this != otherCalls

Post-Conditions

1. (this.getProvider()).getState() == Provider.IN_SERVICE

2. this.getState() == Call.ACTIVE

3. otherCall.getState() == INVALID

4. Let c[] be the Connections to be merged from otherCall

5. Let tc[] be the TerminalConnections to be merged from otherCall

6. Let new(c) be the set of new Connections created on this Call

7. Let new(tc) be the set of new TerminalConnections created on this Call

8. new(c) element of this.getConnections()

9. new(c).getCallState() == c.getCallState()

10. new(tc) element of (this.getConnections()).getTerminalConnections()

11. new(tc).getCallState() == tc.getCallState()

12. c[i].getCallControlState() == CallControlConnection.DISCONNECTED for all i

13. tc[i].getCallControlState() == CallControlTerminalConnection.DROPPED for all i

14. CallInvalidEv is delivered for otherCall

15. CallCtlConnDisconnectedEv/ConnDisconnectedEv is delivered for all c[i]

16. CallCtlTermConnDroppedEv/TermConnDroppedEv is delivered for all tc[i]

17. ConnCreatedEv is delivered for all new(c)

18. TermConnCreatedEv is delivered for all new(tc)

19. Appropriate events are delivered for all new(c) and new(tc)

Parameters

otherCalls - The Other Calls which are to be merged with this Call object.

Throws

javax.telephony.InvalidArgumentException - The Call object that is provided is not valid for the conference.

javax.telephony.InvalidStateException - Thismeans that the Provider is not "in service," the Call is not "active," or the conference controllers are not in the proper state.

javax.telephony.MethodNotSupportedException - The implementation does not support this method.

javax.telephony.PrivilegeViolationException - The application does not have the proper authority to invoke this method.

javax.telephony.ResourceUnavailableException - This means that an internal resource that is necessary for the successful invocation of this method is not available.

See also

ConnCreatedEv, TermConnCreatedEv, ConnDisconnectedEv, TermConnDroppedEv, CallInvalidEv, CallCtlConnDisconnectedEv, CallCtlTermConnDroppedEv

javax.telephony.Connection transfer(java.lang.String address java.lang.String facCode, java.lang.String cmcCode)

Throws for connect(Terminal, Address, String, CiscoRTPParams)

javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException, javax.telephony.InvalidPartyException, javax.telephony.MethodNotSupportedException, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailableException This method is similar to the CallControlCall.transfer(String address) interface except that it also takes facCode (Forced Authorization Code) and cmcCode (Client Matter Code) if the transfer Address requires these codes to offer the call. If only one of the codes is required, the other code may need to be a null value.

If the user enters no codes, or invalid codes, the call may not be offered and platformException may contain the following error codes:

CiscoJTAPIException.CTIERR_FAC_CMC_REASON_FAC_NEEDED CiscoJTAPIException.CTIERR_FAC_CMC_REASON_CMC_NEEDED CiscoJTAPIException.CTIERR_FAC_CMC_REASON_FAC_CMC_NEEDED CiscoJTAPIException.CTIERR_FAC_CMC_REASON_FAC_INVALID CiscoJTAPIException.CTIERR_FAC_CMC_REASON_CMC_INVALID

This overloaded version of this method transfers all participants currently on this Call, with the exception of the transfer controller participant, to another Address. This is often called a "single-step transfer" because the transfer feature places another call and performs the transfer simultaneously. The Address string argument to this method must be valid and complete.

The Transfer Controller

The transfer controller for this version of this method represents the participant on this Call around which the transfer is taking place and who drops off the Call after the transfer has completed. The transfer controller is a TerminalConnection that must be in the CallControlTerminalConnection.TALKING state.

Applications may control which TerminalConnection acts as the transfer controller via the CallControlCall.setTransferController() method. The CallControlCall.getTransferController() method returns the current transfer controller, or null if there is none. If no transfer controller is set, the implementation chooses a suitable TerminalConnection when the transfer feature gets invoked.

When the transfer feature gets invoked, the transfer controller moves into the CallControlTerminalConnection.DROPPED state. If it is the only TerminalConnection associated with its Connection, then its Connection moves into the CallControlConnection.DISCONNECTED state as well.

The New Connection

This method creates and returns a new Connection representing the party to which the Call was transferred. This Connection may be null if the Call has been transferred outside of the Provider domain and can no longer be tracked. This Connection must at least be in the CallControlConnection.IDLE state. The Connection state may have progressed beyond "idle" before this method returns, and should be reflected by an event. This new Connection will progress as any normal destination Connection on a call. Typical scenarios for this Connection are described by the Call.connect() method.

Pre-Conditions

1. Let tc be the transfer controller on this Call

2. (this.getProvider()).getState() == Provider.IN_SERVICE

3. this.getState() == Call.ACTIVE

4. tc.getCallControlState() == CallControlTerminalConnection.TALKING

Post-Conditions

1. Let newconnection be the Connection created and returned

2. Let connection == tc.getConnection()

3. (this.getProvider()).getState() == Provider.IN_SERVICE

4. this.getState() == Call.ACTIVE

5. tc.getCallControlState() == CallControlTerminalConnection.DROPPED

6. If connection.getTerminalConnections().length == 1, then connection.getCallControlState() == CallControlConnection.DISCONNECTED

7. newconnection is an element of this.getConnections(), if not null.

8. newconnection.getCallControlState() at least CallControlConnection.IDLE, if not null.

9. ConnCreatedEv is delivered for newconnection

10. CallCtlTermConnDroppedEv/TermConnDroppedEv is delivered for tc

11. CallCtlConnDisconnectedEv/ConnDisconnectedEv is delivered for connection if no other TerminalConnections

Parameters

address - The destination Address string(dialedDigits) to which the Call is being transferred.

facCode - The Force Authorization Code

cmcCode - The Client Matter Code

Returns

The new Connection associated with the destination, or null.

Throws

javax.telephony.InvalidArgumentException - The TerminalConnection provided as controlling the transfer is not valid or not part of this Call.

javax.telephony.InvalidStateException - This means that the Provider is not "in service," the Call is not "active," or the transfer controller is not "talking."

javax.telephony.InvalidPartyException - The destination Address is not valid or complete.

javax.telephony.MethodNotSupportedException - The implementation does not support this method.

javax.telephony.PrivilegeViolationException - The application does not have the proper authority to invoke this method.

javax.telephony.ResourceUnavailableException - An internal resource necessary for the successful invocation of this method is unavailable.

See Also

ConnCreatedEv, ConnDisconnectedEv, TermConnDroppedEv, CallCtlConnDisconnectedEv, CallCtlTermConnDroppedEv

getCurrentCalledAddressPI boolean getCurrentCalledAddressPI() Returns the Presentation Indicator(PI) that is associated with CurrentCalledAddress. If it returns true, the application can display this Address name to the end users. If it returns false, the application should not display this Address name to end users.

getCurrentCalledDisplayNamePI boolean getCurrentCalledDisplayNamePI() Returns the Presentation Indicator(PI) that is associated with getCurredCalledDisplayNamePI. If it returns true, the application can display this DisplayName to the end users. If it returns false, the application should not display this DisplayName to the end users.

getCurrentCallingAddressPI boolean getCurrentCallingAddressPI() Returns the Presentation Indicator(PI) that is associated with getCurrentCallingAddressPI. If it returns true, the application can display this Address name to the end users. If it returns false, the application should not display this Address name to the end users.

getCurrentCallingDisplayNamePI boolean getCurrentCallingDisplayNamePI() Returns the Presentation Indicator(PI) that is associated with getCurrentCalledDisplayNamePI. If it returns true, the application can display this DisplayName to the end users. If it returns false, the application should not display this DisplayName to the end users.

getLastRedirectingAddressPI boolean getLastRedirectingAddressPI() Returns the Presentation Indicator(PI) that is associated with getLastRedirectingAddressPI. If it returns true, the application can display this Address name to the end users. If it returns false, the application should not display this Address name to the end users.

getCalledAddressPI boolean getCalledAddressPI() Returns the Presentation Indicator(PI) that is associated with getCalledAddressPI. If it returns true, the application can display this Address name to the end users If it returns false, the application should not display this Address name to the end users.

getCallingAddressPI boolean getCallingAddressPI() Returns the Presentation Indicator(PI) that is associated with getCallingAddressPI. If it returns true, the application can display this Address name to the end users. If it returns false, the application should not display this Address name to the end users.

getCurrentCalledPartyUnicodeDisplayName java.lang.String getCurrentCalledPartyUnicodeDisplayName() Returns the Unicode display name of the called party in the call. It returns null if the display name is unknown.

getCurrentCalledPartyUnicodeDisplayNamelocale int getCurrentCalledPartyUnicodeDisplayNamelocale() Returns the locale of the current called party Unicode display name. CiscoLocale interface lists the supported locales.

getCurrentCallingPartyUnicodeDisplayName java.lang.String getCurrentCallingPartyUnicodeDisplayName() Returns the Unicode display name of the calling party in the call. It returns null if the display name is unknown.

getCurrentCallingPartyUnicodeDisplayNamelocale int getCurrentCallingPartyUnicodeDisplayNamelocale() Returns the locale of the current called party Unicode display name.

getCurrentCallingPartyInfo CiscoPartyInfo getCurrentCallingPartyInfo() Returns the PartyInfo of the current calling party of the call.

getCurrentCalledPartyInfo CiscoPartyInfo getCurrentCalledPartyInfo() Returns the PartyInfo of the current called party of the call.

getLastRedirectingPartyInfo CiscoPartyInfo getLastRedirectingPartyInfo() Deprecated. - use getLastRedirectedPartyInfo();

Returns the PartyInfo of the last redirecting party of the call.

getLastRedirectedPartyInfo CiscoPartyInfo getLastRedirectedPartyInfo() Returns the PartyInfo of the last redirecting party of the call.

getCalledPartyInfo CiscoPartyInfo getCalledPartyInfo() Returns the PartyInfo of the called party of the call.

javax.telephony.Connection[] startMonitor(javax.telephony.Terminal MonitorInitiatorterminal, javax.telephony.Address MonitorInitiatoraddress, javax.telephony.TerminalConnection termConnofMonitorTarget, int monitorType, int PlayToneDirection)

throws

javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidPartyException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException

If the application is observing the monitor target (agent) Address, the application can use the Terminal connection of the monitor target (agent) to initiate a monitor request. This interface places a call from an originating endpoint to monitor the call at the monitor target.

Pre-Conditions

1. (this.getProvider()).getState() == Provider.IN_SERVICE

2. this.getState() == Call.IDLE

3. ((CiscoProviderCapabilities)(this.getTerminal().getProvider().getProviderCapabilities()).canMonitor() == TRUE

4. TerminalConnection.getProvider() == this.getProvider()

Parameters

MonitorInitiatorterminal - - The originating Terminal

MonitorInitiatoraddress - - The originating Address

termConnofMonitorTarget - - The TerminalConnection of the target

monitorType - - The type of monitor. Use CiscoCall.SILENT_MONITOR.

PlayToneDirection - - Indicates whether the tone needs to be played to the target, the initiator, or both. This should be one of CiscoCall.PLAYTONE_NOLOCAL_OR_REMOTE, CiscoCall.PLAYTONE_LOCALONLY, CiscoCall.PLAYTONE_REMOTEONLY, or CiscoCall.PLAYTONE_BOTHLOCALANDREMOTE

Throws

javax.telephony.ResourceUnavailableException

javax.telephony.PrivilegeViolationException

javax.telephony.InvalidPartyException

javax.telephony.InvalidArgumentException

javax.telephony.InvalidStateException

javax.telephony.MethodNotSupportedException

Related Documentation

See CallControlCall for more information.

CiscoCallChangedEv

The system delivers the CiscoCallChangedEv event to the call observer for all supported features whenever the Global Call ID (GCID) of the call changes. CiscoCallChangedEv gets delivered when the GCID of the call changes due to path replacement (QSIG_PR) and for other features, including transfer, conference, barge, cbarge, and unpark. In the case of shared lines, multiple CiscoCallChangedEv events get delivered.

The system also delivers this event when two or more calls get merged into one. Transfer, conference, unpark, Barge, and CBarge will trigger this event. Application can invoke CiscoCallEv.getCiscoFeatureReason() to find the feature code that caused this event.

The system reports this event via the CallControlCallObserver interface.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev

Declaration

public interface CiscoCallChangedEv extends CiscoCallEv

Fields

Table 6-60 Fields in CiscoCallChangedEv

Interface
Field

static int

ID


Inherited Fields

From Interface com.cisco.jtapi.extensions.CiscoCallEv

CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, CAUSE_CTICCMSIP400BADREQUEST, CAUSE_CTICCMSIP401UNAUTHORIZED, CAUSE_CTICCMSIP402PAYMENTREQUIRED, CAUSE_CTICCMSIP403FORBIDDEN, CAUSE_CTICCMSIP404NOTFOUND, CAUSE_CTICCMSIP405METHODNOTALLOWED, CAUSE_CTICCMSIP406NOTACCEPTABLE, CAUSE_CTICCMSIP407PROXYAUTHENTICATIONREQUIRED, CAUSE_CTICCMSIP408REQUESTTIMEOUT, CAUSE_CTICCMSIP410GONE, CAUSE_CTICCMSIP411LENGTHREQUIRED, CAUSE_CTICCMSIP413REQUESTENTITYTOOLONG, CAUSE_CTICCMSIP414REQUESTURITOOLONG, CAUSE_CTICCMSIP415UNSUPPORTEDMEDIATYPE, CAUSE_CTICCMSIP416UNSUPPORTEDURISCHEME, CAUSE_CTICCMSIP420BADEXTENSION, CAUSE_CTICCMSIP421EXTENSTIONREQUIRED, CAUSE_CTICCMSIP423INTERVALTOOBRIEF, CAUSE_CTICCMSIP480TEMPORARILYUNAVAILABLE, CAUSE_CTICCMSIP481CALLLEGDOESNOTEXIST, CAUSE_CTICCMSIP482LOOPDETECTED, CAUSE_CTICCMSIP483TOOMANYHOOPS, CAUSE_CTICCMSIP484ADDRESSINCOMPLETE, CAUSE_CTICCMSIP485AMBIGUOUS, CAUSE_CTICCMSIP486BUSYHERE, CAUSE_CTICCMSIP487REQUESTTERMINATED, CAUSE_CTICCMSIP488NOTACCEPTABLEHERE, CAUSE_CTICCMSIP491REQUESTPENDING, CAUSE_CTICCMSIP493UNDECIPHERABLE, CAUSE_CTICCMSIP500SERVERINTERNALERROR, CAUSE_CTICCMSIP501NOTIMPLEMENTED, CAUSE_CTICCMSIP502BADGATEWAY, CAUSE_CTICCMSIP503SERVICEUNAVAILABLE, CAUSE_CTICCMSIP504SERVERTIMEOUT, CAUSE_CTICCMSIP505SIPVERSIONNOTSUPPORTED, CAUSE_CTICCMSIP513MESSAGETOOLARGE, CAUSE_CTICCMSIP600BUSYEVERYWHERE, CAUSE_CTICCMSIP603DECLINE, CAUSE_CTICCMSIP604DOESNOTEXISTANYWHERE, CAUSE_CTICCMSIP606NOTACCEPTABLE, CAUSE_CTICONFERENCEFULL, CAUSE_CTIDEVICENOTPREEMPTABLE, CAUSE_CTIDROPCONFEREE, CAUSE_CTIMANAGER_FAILURE, CAUSE_CTIPRECEDENCECALLBLOCKED, CAUSE_CTIPRECEDENCELEVELEXCEEDED, CAUSE_CTIPRECEDENCEOUTOFBANDWIDTH, CAUSE_CTIPREEMPTFORREUSE, CAUSE_CTIPREEMPTNOREUSE, CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_DPARK, CAUSE_DPARK_REMINDER, CAUSE_DPARK_UNPARK, CAUSE_EXCHANGEROUTINGERROR, CAUSE_FAC_CMC, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, CAUSE_OUTOFBANDWIDTH, CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QSIG_PR, CAUSE_QUALOFSERVNAVAIL, CAUSE_QUIET_CLEAR, CAUSE_RECOVERYONTIMEREXPIRY, CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUBSCRIBERABSENT, CAUSE_SUSPCALLBUTNOTTHISONE, CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, CAUSE_USERBUSY

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-61 Methods in CiscoCallChangedEv

Interface
Method
Description

CiscoConnection

getConnection()

Returns the CiscoConnection to the Address where the change occurred.

CiscoCall

getOriginalCall()

Returns the call that will go to INVALID state.

CiscoCall

getSurvivingCall()

Returns the call that will remain active after the callID change.

javax.telephony.
TerminalConnection

getTerminalConnection()

Returns the TerminalConnection where the change occurred. This value could be null if the call ID changes before the TerminalConnection gets created on the Address.


Inherited Methods

From Interface com.cisco.jtapi.extensions.CiscoCallEv

getCiscoCause, getCiscoFeatureReason

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values for more information.

CiscoCallConsultCancelledEv

This event notifies applications that a cancel operation has been invoked.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

New event for the Swap/Cancel - Transfer/Conference Behavior Change feature.


Superinterfaces

None

Declaration

public interface CiscoCallConsultCancelledEv

Fields

None

Inherited Fields

None

Methods

Table 6-62 Methods in CiscoCallConsultCancelledEv

Interface
Method
Description

CiscoCall

getConsultCall()

Returns the consult call for which consult operation is cancelled. If the consult call does not exist, it returns NULL.

The getCall() API on this call event returns the parent call.


Inherited Methods

None

Related Documentation

None.

CiscoCallCtlConnOfferedEv

The CiscoCallCtlConnOfferedEv interface extends the CallCtlConnOfferedEv interface to let applications obtain the IP Address of the calling party Terminal. The IP Address information might not be available for all calling party devices. A return value of 0 (or null) indicates that the information is not available.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.callcontrol.events.CallCtlCallEv, javax.telephony.callcontrol.events.CallCtlConnEv, javax.telephony.callcontrol.events.CallCtlConnOfferedEv, javax.telephony.callcontrol.events.CallCtlEv, javax.telephony.events.CallEv, javax.telephony.events.ConnEv, javax.telephony.events.Ev

Declaration

public interface CiscoCallCtlConnOfferedEv extends javax.telephony.callcontrol.events.CallCtlConnOfferedEv

Fields

None

Inherited Fields

From Interface javax.telephony.callcontrol.events.CallCtlConnOfferedEv

None

From Interface javax.telephony.callcontrol.events.CallCtlEv

CAUSE_ALTERNATE, CAUSE_BUSY, CAUSE_CALL_BACK, CAUSE_CALL_NOT_ANSWERED, CAUSE_CALL_PICKUP, CAUSE_CONFERENCE, CAUSE_DO_NOT_DISTURB, CAUSE_PARK, CAUSE_REDIRECTED, CAUSE_REORDER_TONE, CAUSE_TRANSFER, CAUSE_TRUNKS_BUSY, CAUSE_UNHOLD

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-63 Methods in CiscoCallCtlConnOfferedEv

Interface
Method
Description

java.net.InetAddress

getCallingPartyIpAddr()

Returns the IP address of the calling party, or 0 (or null) if the IP Address is not available.


Inherited Methods

From Interface javax.telephony.callcontrol.events.CallCtlCallEv

getCalledAddress, getCallingAddress, getCallingTerminal, getLastRedirectedAddress

From Interface javax.telephony.callcontrol.events.CallCtlEv

getCallControlCause

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.ConnEv

getConnection

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

None

CiscoCallCtlTermConnHeldReversionEv

The CiscoCallCtlTermConnHeldReversionEv event indicates that hold reversion notification has been received on the TerminalConnection from Cisco Unified Communications Manager.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.callcontrol.events.CallCtlCallEv, javax.telephony.callcontrol.events.CallCtlEv, javax.telephony.callcontrol.events.CallCtlTermConnEv, javax.telephony.events.CallEv, javax.telephony.events.Ev, javax.telephony.events.TermConnEv

Declaration

public interface CiscoCallCtlTermConnHeldReversionEv extends javax.telephony.callcontrol.events.CallCtlTermConnEv

Fields

Table 6-64 Fields in CiscoCallCtlTermConnHeldReversionEv

Interface
Field

static int

ID


Inherited Fields

From Interface javax.telephony.callcontrol.events.CallCtlEv

CAUSE_ALTERNATE, CAUSE_BUSY, CAUSE_CALL_BACK, CAUSE_CALL_NOT_ANSWERED, CAUSE_CALL_PICKUP, CAUSE_CONFERENCE, CAUSE_DO_NOT_DISTURB, CAUSE_PARK, CAUSE_REDIRECTED, CAUSE_REORDER_TONE, CAUSE_TRANSFER, CAUSE_TRUNKS_BUSY, CAUSE_UNHOLD

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

None

Inherited Methods

From Interface javax.telephony.callcontrol.events.CallCtlCallEv

getCalledAddress, getCallingAddress, getCallingTerminal, getLastRedirectedAddress

From Interface javax.telephony.callcontrol.events.CallCtlEv

getCallControlCause

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.TermConnEv

getTerminalConnection

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values for more information.

CiscoCallEv

The CiscoCallEv interface, which extends the JTAPI core javax.telephony.events.CallEv interface, serves as the base interface for all Cisco-extended JTAPI Call events. Every Call-related event in this package extends this interface, directly or indirectly.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.events.CallEv, CiscoEv, javax.telephony.events.Ev

Subinterfaces

CiscoCallChangedEv, CiscoCallSecurityStatusChangedEv, CiscoConferenceChainAddedEv, CiscoConferenceChainRemovedEv, CiscoConferenceEndEv, CiscoConferenceStartEv, CiscoConsultCallActiveEv, CiscoToneChangedEv, CiscoTransferEndEv, CiscoTransferStartEv

Declaration

public interface CiscoCallEv extends CiscoEv, javax.telephony.events.CallEv

Fields

Table 6-65 Fields in CiscoCallEv 

Interface
Field
Description

Static int

CAUSE_ACCESSINFORMATION
DISCARDED

This cause indicates that the network could not deliver access information to the remote user as requested.

Static int

CAUSE_BARGE

It indicates the call is a BARGE call.

staticint

CAUSE_BCBPRESENTLYAVAIL

This cause indicates that the user has requested a bearer capability which is implemented by the equipment which generated this cause but which is not available at this time.

static int

CAUSE_BCNAUTHORIZED

This cause indicates that the user has requested a bearer capability which is implemented by the equipment which generated this cause but the user is not authorized to use.

static int

CAUSE_BEARERCAPNIMPL

This cause indicates that the equipment sending this cause does not support the bearer capability requested.

static int

CAUSE_CALLBEINGDELIVERED

This cause indicates that the user has been awarded the incoming call and that the incoming call is being connected to a channel already established to that user for similar calls.

static int

CAUSE_CALLIDINUSE

This cause indicates that the network has received a call suspended request containing a call identity (including the null call identity) which is already in use for a suspended call within the domain of interfaces over which the call might be resumed.

static int

CAUSE_CALLMANAGER_FAILURE

This cause indicates the failure due to CALL Manager Failure.

static int

CAUSE_CALLREJECTED

This cause indicates that the equipment sending this cause does not wish to accept this call.

static int

CAUSE_CALLSPLIT

This cause indicates the call split, it could mean conference or transfer.

static int

CAUSE_CHANTYPENIMPL

This cause indicates that the equipment sending this cause does not support the channel type requested.

static int

CAUSE_CHANUNACCEPTABLE

This cause indicates that the channel most recently identified is not acceptable to the sending entity for use in this call.

static int

CAUSE_CTICCMSIP400BADREQUEST

This cause indicates the call is rejected due to bad request.

static int

CAUSE_CTICCMSIP401UNAUTHORIZED

This cause indicates the request is valid but is not authorized.

static int

CAUSE_CTICCMSIP402PAYMENT
REQUIRED

This cause indicates the payment is required for usage.

static int

CAUSE_CTICCMSIP403FORBIDDEN

This cause indicates the server understood the request, but is refusing to fulfill it..

static int

CAUSE_CTICCMSIP404NOTFOUND

This cause indicates the request URI cannot be located by the server.

static int

CAUSE_CTICCMSIP405METHODNOTALLOWED

This cause indicates the method specified in the Request-Line is understood, but not allowed for the address identified by the Request-URI.

static int

CAUSE_CTICCMSIP406NOTACCEPTABLE

This cause indicates the request cannot be proccessed due to requirements in the request cannot be met.

static int

CAUSE_CTICCMSIP407PROXY
AUTHENTICATIONREQUIRED

This cause indicates that requset is not authorized and proxy authentication is required for the operation.

static int

CAUSE_CTICCMSIP408REQUESTTIME
OUT

This cause indicates the time out error for the request.

static int

CAUSE_CTICCMSIP410GONE

This cause indicates the requested resource is no longer available at the server and no forwarding address is known.

static int

CAUSE_CTICCMSIP411LENGTH
REQUIRED

This cause indicates that an interworking message length is required.

static int

CAUSE_CTICCMSIP413REQUESTENTITYTOOLONG

This cause indicates that the server is refusing to process a request because the request entity-body is larger than the server is willing or able to process.

static int

CAUSE_CTICCMSIP414REQUESTURI
TOOLONG

This cause indicates that the server is refusing to service the request because the Request-URI is longer than the server is willing to interpret.

static int

CAUSE_CTICCMSIP415UNSUPPORTED
MEDIATYPE

This cause indicates the server is refusing to service the request because the message body of the request indicates the Media Type which is not supported by the server for the requested method.

static int

CAUSE_CTICCMSIP416UNSUPPORTED
URISCHEME

This cause indicates the server cannot process the request because the scheme of the URI in the Request-URI is unknown to the server.

static int

CAUSE_CTICCMSIP420BADEXTENSION

This cause indicates the server did not understand the protocol extension specified in a Proxy-Require or Require header field.

static int

CAUSE_CTICCMSIP421EXTENSTION
REQUIRED

This cause indicates the UAS needs a particular extension to process the request, but this extension is not listed in a Supported header field in the request.

static int

CAUSE_CTICCMSIP423INTERVALTOO
BRIEF

This cause indicates that the server is rejecting the request because the expiration time of the resource refreshed by the request is too short.

static int

CAUSE_CTICCMSIP480TEMPORARILY
UNAVAILABLE

This cause indicates the callee's end system was contacted successfully but the callee is currently unavailable (for example, is not logged in, logged in but in a state that precludes communication with the callee, or has activated the "do not disturb" feature).

static int

CAUSE_CTICCMSIP481CALLLEGDOES
NOTEXIST

This cause indicates the the UAS received a request that does not match any existing dialog or transaction.

static int

CAUSE_CTICCMSIP482LOOPDETECTED

This cause indicates that the server has detected a loop.

static int

CAUSE_CTICCMSIP483TOOMANYHOOPS

This cause indicates the server received a request that contains a Max-Forwards header field with the value zero (or less than actual hops).

static int

CAUSE_CTICCMSIP484ADDRESSIN
COMPLETE

This cause indicates that the server received a request with a Request-URI that was incomplete.

static int

CAUSE_CTICCMSIP485AMBIGUOUS

This cause indicates that the Request-URI was ambiguous.

static int

CAUSE_CTICCMSIP486BUSYHERE

This indicates that the callee's end system was contacted successfully, but the callee is currently not willing or able to take additional calls at this end system.

static int

CAUSE_CTICCMSIP487REQUEST
TERMINATED

This cause indicates the request was terminated by a BYE or CANCEL request.

static int

CAUSE_CTICCMSIP488NOTACCEPTABLEHERE

This cause indicates the same meaning as 606 (Not Acceptable), but only applies to the specific resource addressed by the Request-URI and the request may succeed elsewhere.

static int

CAUSE_CTICCMSIP491REQUEST
PENDING

This cause indicates the request was received by a UAS that had a pending request within the same dialog.

static int

CAUSE_CTICCMSIP493
UNDECIPHERABLE

This cause indicates that the request was received by a UAS that contained an encrypted MIME body for which the recipient does not possess or will not provide an appropriate decryption key.

static int

CAUSE_CTICCMSIP500SERVERINTERNALERROR

This cause indicates the server encountered an unexpected condition that prevented it from fulfilling the request.

static int

CAUSE_CTICCMSIP501NOT
IMPLEMENTED

This cause indicates the server does not support the functionality required to fulfill the request.

static int

CAUSE_CTICCMSIP502BADGATEWAY

This cause indicates the server, while acting as a gateway or proxy, received an invalid response from the downstream server it accessed in attempting to fulfill the request.

static int

CAUSE_CTICCMSIP503SERVICEUNAVAILABLE

This cause indicates the server is temporarily unable to process the request due to a temporary overloading or maintenance of the server.

static int

CAUSE_CTICCMSIP504SERVERTIMEOUT

This cause indicates the server did not receive a timely response from an external server it accessed in attempting to process the request.

static int

CAUSE_CTICCMSIP505SIPVERSIONNOTSUPPORTED

This cause indicates the server does not support, or refuses to support, the SIP protocol version that was used in the request.

static int

CAUSE_CTICCMSIP513MESSAGETOOLARGE

This cause indicates the server was unable to process the request since the message length exceeded its capabilities.

static int

CAUSE_CTICCMSIP600BUSYEVERYWHERE

This cause indicates the callee's end system was contacted successfully but the callee is busy and does not wish to take the call at this time.

static int

CAUSE_CTICCMSIP603DECLINE

This cause indicates the callee's machine was successfully contacted but the user explicitly does not wish to or cannot participate.

static int

CAUSE_CTICCMSIP604DOESNOTEXISTANYWHERE

This cause indicates the server has authoritative information that the user indicated in the Request-URI does not exist anywhere.

static int

CAUSE_CTICCMSIP606NOTACCEPTABLE

This cause indicates the user's agent was contacted successfully but some aspects of the session description such as the requested media, bandwidth, or addressing style were not acceptable.

static int

CAUSE_CTICONFERENCEFULL

This cause indicates the Conference Call is full and no more participants can be added to it.

static int

CAUSE_CTIDEVICENOTPREEMPTABLE

This cause indicates that the device cannot be preempted.

static int

CAUSE_CTIDROPCONFEREE

This cause indicates the disconnection because the party was dropped from conference.

static int

CAUSE_CTIMANAGER_FAILURE

This cause indicates the failure due to CTI Manager Failure.

static int

CAUSE_CTIPRECEDENCECALLBLOCKED

This cause indicates that there are no predictable circuits or that the called user is busy with a call of equal or higher preventable level.

static int

CAUSE_CTIPRECEDENCELEVELEXCEEDED

This cause indicates that the precedence level of the call has exceeded the authorized level.

static int

CAUSE_CTIPRECEDENCEOUTOFBANDWIDTH

This cause indicates the precedence call has hit low bandwidth and cannot proceed.

static int

CAUSE_CTIPREEMPTFORREUSE

This cause indicates that the call is being preempted and the circuit is reserved for reuse by the preempting exchange.

static int

CAUSE_CTIPREEMPTNOREUSE

This cause indicates the call is being preempted.

static int

CAUSE_DESTINATIONOUTOFORDER

This cause indicates that the destination indicated by the user cannot be reached because the interface to the destination is not functioning correctly.

static int

CAUSE_DESTNUMMISSANDDCNOTSUB

This cause indicates that the specified CUG does not exist.

static int

CAUSE_DPARK

It indicates the call is Directed-Parked call.

static int

CAUSE_DPARK_REMINDER

It indicates the call is Directed Park Reminder call.

static int

CAUSE_DPARK_UNPARK

It indicates that Directed Parked call is now unparked.

static int

CAUSE_EXCHANGEROUTINGERROR

This cause indicates that the exchange couldnt route the call to specified destination.

static int

CAUSE_FAC_CMC

It indicates the FAC(Force Authorization Code) or CMC(Client Matter Code) is needed to route the call.

static int

CAUSE_FACILITYREJECTED

This cause is returned when a supplementary service requested by the user cannot be provided by the network.

static int

CAUSE_IDENTIFIEDCHANDOESNOT
EXIST

This cause indicates that the equipment sending this cause has received a request to use a channel not activated on the interface for a call.

static int

CAUSE_IENIMPL

This cause indicates that the equipment sending this cause has received a message which includes information element(s)/parameter(s) not recognized because the information element(s)/parameter name(s) are not defined or are defined but not implemented by the equipment sending the cause.

static int

CAUSE_INBOUNDBLINDTRANSFER

It indicates the call is IN bound Blind Transfer call.

static int

CAUSE_INBOUNDCONFERENCE

It indicates the call is IN bound Conference call.

static int

CAUSE_INBOUNDTRANSFER

It indicates the call is IN bound Transfer call.

static int

CAUSE_INCOMINGCALLBARRED

This cause indicates that the incoming calls for that number is barred.

static int

CAUSE_INCOMPATABLEDDESTINATION

This cause indicates that the equipment sending this cause has received a request to establish a call which has low layer compatibility.

static int

CAUSE_INTERWORKINGUNSPECIFIED

This cause indicates that an interworking call has ended.

static int

CAUSE_INVALIDCALLREFVALUE

This cause indicates that the equipment sending this cause has received a message with a call reference which is not currently in use on the user-network interface.

static int

CAUSE_INVALIDIECONTENTS

This cause indicates that the equipment sending this cause has received and information element which it has implemented; however, one or more of the fields in the information element are coded in such a way which has not been implemented by the equipment sending this cause.

static int

CAUSE_INVALIDMESSAGEUNSPECIFIED

This cause is used to report an invalid message event only when no other cause in the invalid message class applies.

static int

CAUSE_INVALIDNUMBERFORMAT

This cause indicates that the called party cannot be reached because the called party number is not in a valid format or is not complete.

static int

CAUSE_INVALIDTRANSITNETSEL

This cause indicates that a transit network identification was received which is of an incorrect format.

static int

CAUSE_MANDATORYIEMISSING

This cause indicates that the equipment sending this cause has received a message which is missing an information element which must be present in the message before that message can be processed.

static int

CAUSE_MSGNCOMPATABLEWCS

This cause indicates that a message has been received which is incompatible with the call state.

static int

CAUSE_MSGTYPENCOMPATWCS

This cause indicates that the equipment sending this cause has received a message such that the procedures do not indicate that this is a permissible message to receive while in the call state, or a STATUS message was received indicating an incompatible call state.

static int

CAUSE_MSGTYPENIMPL

This cause indicates that the equipment sending this cause has received a message with a message type it does not recognize either because this is a message not defined or defined but not implemented by the equipment sending this cause.

static int

CAUSE_NETOUTOFORDER

This cause indicates that the network is not functioning correctly and that the condition is likely to last a relatively long period of time.

static int

CAUSE_NOANSWERFROMUSER

This cause is used when the called party has been alerted but does not respond with a connect indication within a prescribed period of time.

static int

CAUSE_NOCALLSUSPENDED

This cause indicates that the network has received a call resume request containing a call identity information element which presently does not indicate any suspended call within the domain of interfaces over which calls may be resumed.

static int

CAUSE_NOCIRCAVAIL

This cause indicates that there is no appropriate circuit/channel presently available to handle the call.

static int

CAUSE_NOERROR

This is usually given when there is no error and operation completes successfuly.

static int

CAUSE_NONSELECTEDUSERCLEARING

This cause indicates that the user has not been awarded the incoming call.

static int

CAUSE_NORMALCALLCLEARING

This cause indicates that the call is being cleared because one of the users involved in the call has requested that the call be cleared.

static int

CAUSE_NORMALUNSPECIFIED

This cause is used to report a normal event only when no other cause in the normal class applies.

static int

CAUSE_NOROUTETODDESTINATION

This cause indicates that the called party cannot be reached because the network through which the call has been routed does not serve the destination desired.

static int

CAUSE_NOROUTETOTRANSITNET

This cause indicates that the equipment sending this cause has received a request to route the call through a particular transit network which it does not recognize.

static int

CAUSE_NOUSERRESPONDING

This cause is used when a called party does not respond to a call establishment message with either an alerting or connect indication within the prescribed period of time allocated.

static int

CAUSE_NUMBERCHANGED

This cause is returned to a calling party when the called party number indicated by the calling party is no longer assigned.

static int

CAUSE_ONLYRDIVEARERCAPAVAIL

This cause indicates that the calling party has requested an unrestricted bearer service but the equipment sending this cause only supports the restricted version of the requested bearer capability.

static int

CAUSE_OUTBOUNDCONFERENCE

It indicates the call is OUT bound Conference call.

static int

CAUSE_OUTBOUNDTRANSFER

It indicates the call is OUT bound Transfer call

static int

CAUSE_OUTOFBANDWIDTH

This cause indicates that the call could not proceed because of Low Bandwidth.

static int

CAUSE_PROTOCOLERRORUNSPECIFIED

This cause is used to report a protocol error event only when no other cause in the protocol error class applies.

static int

CAUSE_QSIG_PR

It indicates the QSIG Path Replacement in the call.

static int

CAUSE_QUALOFSERVNAVAIL

This cause is used to report that the requested Quality of Service, as defined in Recommendation X.213.

static int

CAUSE_QUIET_CLEAR

It indicates the Call is cleared as Call Manager has gone down, but media between endpoints remain connected.

static int

CAUSE_RECOVERYONTIMEREXPIRY

This cause indicates that a procedure has been initiated by the expiration of a timer in association with error handling procedures.

static int

CAUSE_REDIRECTED

This cause indicates the call is being redirected to different party.

static int

CAUSE_REQCALLIDHASBEENCLEARED

This cause indicates that the network has received a call resume request containing a call identity information element indicating a suspended call that has in the meantime been cleared while suspended (either by network time-out or by the remote user).

static int

CAUSE_REQCIRCNAVIL

This cause is returned when the circuit or channel indicated by the requesting entity cannot be provided by the other side of the interface.

static int

CAUSE_REQFACILITYNIMPL

This cause indicates that the equipment sending this cause does not support the requested.

static int

CAUSE_REQFACILITYNOTSUBSCRIBED

This cause indicates that the user has requested a supplementary service which is implemented by the equipment which generated this cause but the user is not authorized to use.

static int

CAUSE_RESOURCESNAVAIL

This cause is used to report a resource unavailable event.

static int

CAUSE_RESPONSETOSTATUSENQUIRY

This cause is included in the STATUS message when the reason for generating the STATUS message was the prior receipt of a STATUS INQUIRY.

static int

CAUSE_SERVNOTAVAILUNSPECIFIED

This cause is used to report a service or option not available event only when no other cause in the service or option not available class applies.

static int

CAUSE_SERVOPERATIONVIOLATED

This cause indicates that although the calling party is a member of the CUG for the outgoing CUG call.

static int

CAUSE_SERVOROPTNAVAILORIMPL

This cause is used to report a service or option not implemented event only when no other cause in the service or option not implemented class applies.

static int

CAUSE_SUBSCRIBERABSENT

This cause value is used when a mobile station has logged off.

static int

CAUSE_SUSPCALLBUTNOTTHISONE

This cause indicates that a call resume has been attempted with a call identity which differs from that in use for any presently suspended call(s).

static int

CAUSE_SWITCHINGEQUIPMENT
CONGESTION

This cause indicates that the switching equipment generating this cause is experiencing a period of high traffic.

static int

CAUSE_TEMPORARYFAILURE

This cause indicates that the network is not functioning correctly and that the condition is not likely to last a long period of time; e.g., the user may wish to try another call attempt almost immediately.

static int

CAUSE_UNALLOCATEDNUMBER

This cause indicates that the destination requested by the calling user cannot be reached because, it is an invalid number.

static int

CAUSE_USERBUSY

This cause is used to indicate that the called party is unable to accept another call because the user busy condition has been encountered.


Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Methods

Table 6-66 Methods in CiscoCallEv

Interface
Method
Description

Int

getCiscoCause()

Returns the Cisco Unified Communications Manager cause for this event. To function properly, some applications need to know the reason why an event happened at an endpoint that the application is observing. For example, a Connection may be disconnected because the call was not answered (CAUSE_NOANSWERFROMUSER), or whether the caller it was disconnected because it was rejected (CAUSE_CALLREJECTED). Returns: The Cisco Unified Communications Manager cause for this event

Int

getCiscoFeatureReason()

Returns the Cisco Unified Communications Manager Feature Reason for this event. To function properly, some applications need to know the reason why an event happened. This interface provides the CiscoFeatureReason in JTAPI Call events for current and new features. Existing features, such as transfer, continue to receive the CiscoCause provided by the older interface CiscoCallEv.getCiscoCause(), while this interface will provide REASON_TRANSFER for transfer. Caution: Applications should make sure to handle unrecognized reasons and provide default behavior, because new reasons could be added in the future and this interface may not be backward compatible. The possible values are defined in the CiscoFeatureReason interface. Returns: The Cisco Unified Communications Manager Feature Reason for this event


Related Documentation

See Constant Field Values and CallEv for more information.

CiscoCallFeatureCancelledEv

This event notifies applications that the cancel operation has been invoked

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(2)

Created history table to track changes.


Declaration

public interface CiscoCallFeatureCancelledEv

Methods

Table 6-67 Methods in CiscoCallFeatureCancelledEv

Interface
Method
Description

CiscoCall

getConsultCall()

Returns the Consult Call for which consult operation is cancelled, if the consult call doesn't exist it will return NULL.


Related Documentation

See Constant Field Values.

CiscoCallID

The CiscoCallID object represents a unique object that is associated with each call. Applications may use the object itself or the integer representation of the object that the intValue() method returns.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

CiscoObjectContainer

Declaration

Public interface CiscoCallID extends CiscoObjectContainer

Fields

None

Methods

Table 6-68 Methods in CiscoCallID

Interface
Method
Description

Int

intValue()

Returns an integer representation of this object. Returns: Int An integer representation of this object

CiscoCall

getCall()

Returns the CiscoCall corresponding to this CiscoCallID.

int

getCallManagerID()

Returns the Cisco Unified Communications Manager NodeID of the call associated with this CiscoCallID.

int

getGlobalCallID()

Returns the GlobalCallID of the call associated with this CiscoCallID.


Inherited Methods

From Interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject,setObject

Related Documentation

None

CiscoMediaCallSecurityIndicator

CiscoMediaCallSecurityIndicator lets you retrieve the security indicator for a call.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Declaration

public interface CiscoMediaCallSecurityIndicator

Fields

None

Methods

Table 6-69 Methods in CiscoMediaCallSecurityIndicator

Interface
Method
Description

CiscoCallID

getCallID()

Returns the CiscoCallID.

int

getCiscoMediaSecurityIndicator()

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

CiscoMediaSecurityIndicator.MEDIA_
ENCRYPT_USER_NOT_AUTHORIZED

CiscoMediaSecurityIndicator.MEDIA_
ENCRYPTED_KEYS_UNAVAILABLE

CiscoMediaSecurityIndicator.MEDIA_NOT_
ENCRYPTED

CiscoRTPHandle

getCiscoRTPHandle()

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


Related Documentation

See CiscoRTPParams.

CiscoCallSecurityStatusChangedEv

Applications receive CiscoCallSecurityStatusChangedEv when the overall Call security status changes.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev

Declaration

public interface CiscoCallSecurityStatusChangedEv extends CiscoCallEv

Fields

Table 6-70 Fields in CiscoCallSecurityStatusChangedEv

Interface
Field

Static int

ID


Inherited Fields

From Interface com.cisco.jtapi.extensions.CiscoCallEv

CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, CAUSE_CTICCMSIP400BADREQUEST, CAUSE_CTICCMSIP401UNAUTHORIZED, CAUSE_CTICCMSIP402PAYMENTREQUIRED, CAUSE_CTICCMSIP403FORBIDDEN, CAUSE_CTICCMSIP404NOTFOUND, CAUSE_CTICCMSIP405METHODNOTALLOWED, CAUSE_CTICCMSIP406NOTACCEPTABLE, CAUSE_CTICCMSIP407PROXYAUTHENTICATIONREQUIRED, CAUSE_CTICCMSIP408REQUESTTIMEOUT, CAUSE_CTICCMSIP410GONE, CAUSE_CTICCMSIP411LENGTHREQUIRED, CAUSE_CTICCMSIP413REQUESTENTITYTOOLONG, CAUSE_CTICCMSIP414REQUESTURITOOLONG, CAUSE_CTICCMSIP415UNSUPPORTEDMEDIATYPE, CAUSE_CTICCMSIP416UNSUPPORTEDURISCHEME, CAUSE_CTICCMSIP420BADEXTENSION, CAUSE_CTICCMSIP421EXTENSTIONREQUIRED, CAUSE_CTICCMSIP423INTERVALTOOBRIEF, CAUSE_CTICCMSIP480TEMPORARILYUNAVAILABLE, CAUSE_CTICCMSIP481CALLLEGDOESNOTEXIST, CAUSE_CTICCMSIP482LOOPDETECTED, CAUSE_CTICCMSIP483TOOMANYHOOPS, CAUSE_CTICCMSIP484ADDRESSINCOMPLETE, CAUSE_CTICCMSIP485AMBIGUOUS, CAUSE_CTICCMSIP486BUSYHERE, CAUSE_CTICCMSIP487REQUESTTERMINATED, CAUSE_CTICCMSIP488NOTACCEPTABLEHERE, CAUSE_CTICCMSIP491REQUESTPENDING, CAUSE_CTICCMSIP493UNDECIPHERABLE, CAUSE_CTICCMSIP500SERVERINTERNALERROR, CAUSE_CTICCMSIP501NOTIMPLEMENTED, CAUSE_CTICCMSIP502BADGATEWAY, CAUSE_CTICCMSIP503SERVICEUNAVAILABLE, CAUSE_CTICCMSIP504SERVERTIMEOUT, CAUSE_CTICCMSIP505SIPVERSIONNOTSUPPORTED, CAUSE_CTICCMSIP513MESSAGETOOLARGE, CAUSE_CTICCMSIP600BUSYEVERYWHERE, CAUSE_CTICCMSIP603DECLINE, CAUSE_CTICCMSIP604DOESNOTEXISTANYWHERE, CAUSE_CTICCMSIP606NOTACCEPTABLE, CAUSE_CTICONFERENCEFULL, CAUSE_CTIDEVICENOTPREEMPTABLE, CAUSE_CTIDROPCONFEREE, CAUSE_CTIMANAGER_FAILURE, CAUSE_CTIPRECEDENCECALLBLOCKED, CAUSE_CTIPRECEDENCELEVELEXCEEDED, CAUSE_CTIPRECEDENCEOUTOFBANDWIDTH, CAUSE_CTIPREEMPTFORREUSE, CAUSE_CTIPREEMPTNOREUSE, CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_DPARK, CAUSE_DPARK_REMINDER, CAUSE_DPARK_UNPARK, CAUSE_EXCHANGEROUTINGERROR, CAUSE_FAC_CMC, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, CAUSE_OUTOFBANDWIDTH, CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QSIG_PR, CAUSE_QUALOFSERVNAVAIL, CAUSE_QUIET_CLEAR, CAUSE_RECOVERYONTIMEREXPIRY, CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUBSCRIBERABSENT, CAUSE_SUSPCALLBUTNOTTHISONE, CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, CAUSE_USERBUSY

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-71 Methods in CiscoCallSecurityStatusChangedEv

Interface
Method
Description

javax.telephony.events.Ev

getID()

Specified by: getID in interface javax.telephony.events.Ev

getCallSecurityStatus

getCallSecurityStatus()

Returns the call security status. This interface can return: CiscoCall.CALLSECURITY_UNKNOWN, CiscoCall.CALLSECURITY_NOTAUTHENTICATED, CiscoCall.CALLSECURITY_AUTHENTICATED, CiscoCall.CALLSECURITY_ENCRYPTED


Inherited Methods

From Interface com.cisco.jtapi.extensions.CiscoCallEv

getCiscoCause, getCiscoFeatureReason

From Interface javax.telephony.events.Ev

getCause, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Also Constant Field Values for more information.

CiscoConferenceChain

This interface provides links to conference chain connections for the conference calls that are linked together in a conference chain. You can obtain this object from CiscoConferenceChainAddedEv and CiscoConferenceChainRemovedEv.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Declaration

public interface CiscoConferenceChain

Fields

None

Methods

Table 6-72 Methods in CiscoConferenceChain

Interface
Method
Description

javax.telephony.Connection[]

getChainedConferenceConnections()

Returns an array of Connections for Conference Calls that are chained together in a single conference. Applications can use this list to get all the Conference Calls that are linked together. To get the list of Connections for all the Calls that are chained together in the Conference, the provider must have an observer on at least one party in every conference call.

CiscoCall[]

getChainedConferenceCalls()

Returns an array of Calls that are chained together in a single conference. This interface returns only the Calls in the conference chain that are observed in the provider.


Related Documentation

See CiscoConferenceChainAddedEv and CiscoConferenceChainRemovedEv for more information.

CiscoConferenceChainAddedEv

The system sends a CiscoConferenceChainAddedEv event when a conference chain connection gets added to a call. This event gets sent every time a new conference chain connection gets added. This event gets reported via theCallControlCallObserver interface.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


All Superinterfaces

javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev

Declaration

public interface CiscoConferenceChainAddedEv extends CiscoCallEv

Fields

Table 6-73 Fields in CiscoConferenceChainAddedEv

Interface
Field

static int

ID


Inherited Fields

From Interface com.cisco.jtapi.extensions.CiscoCallEv

CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, CAUSE_BCBPRESENTLYAVAIL,CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, CAUSE_CTICCMSIP400BADREQUEST, CAUSE_CTICCMSIP401UNAUTHORIZED, CAUSE_CTICCMSIP402PAYMENTREQUIRED,CAUSE_CTICCMSIP403FORBIDDEN, CAUSE_CTICCMSIP404NOTFOUND, CAUSE_CTICCMSIP405METHODNOTALLOWED, CAUSE_CTICCMSIP406NOTACCEPTABLE, CAUSE_CTICCMSIP407PROXYAUTHENTICATIONREQUIRED, CAUSE_CTICCMSIP408REQUESTTIMEOUT, CAUSE_CTICCMSIP410GONE, CAUSE_CTICCMSIP411LENGTHREQUIRED, CAUSE_CTICCMSIP413REQUESTENTITYTOOLONG, CAUSE_CTICCMSIP414REQUESTURITOOLONG, CAUSE_CTICCMSIP415UNSUPPORTEDMEDIATYPE, CAUSE_CTICCMSIP416UNSUPPORTEDURISCHEME, CAUSE_CTICCMSIP420BADEXTENSION, CAUSE_CTICCMSIP421EXTENSTIONREQUIRED, CAUSE_CTICCMSIP423INTERVALTOOBRIEF, CAUSE_CTICCMSIP480TEMPORARILYUNAVAILABLE, CAUSE_CTICCMSIP481CALLLEGDOESNOTEXIST, CAUSE_CTICCMSIP482LOOPDETECTED, CAUSE_CTICCMSIP483TOOMANYHOOPS, CAUSE_CTICCMSIP484ADDRESSINCOMPLETE, CAUSE_CTICCMSIP485AMBIGUOUS, CAUSE_CTICCMSIP486BUSYHERE, CAUSE_CTICCMSIP487REQUESTTERMINATED, CAUSE_CTICCMSIP488NOTACCEPTABLEHERE, CAUSE_CTICCMSIP491REQUESTPENDING, CAUSE_CTICCMSIP493UNDECIPHERABLE, CAUSE_CTICCMSIP500SERVERINTERNALERROR, CAUSE_CTICCMSIP501NOTIMPLEMENTED, CAUSE_CTICCMSIP502BADGATEWAY, CAUSE_CTICCMSIP503SERVICEUNAVAILABLE, CAUSE_CTICCMSIP504SERVERTIMEOUT, CAUSE_CTICCMSIP505SIPVERSIONNOTSUPPORTED, CAUSE_CTICCMSIP513MESSAGETOOLARGE, CAUSE_CTICCMSIP600BUSYEVERYWHERE, CAUSE_CTICCMSIP603DECLINE, CAUSE_CTICCMSIP604DOESNOTEXISTANYWHERE, CAUSE_CTICCMSIP606NOTACCEPTABLE, CAUSE_CTICONFERENCEFULL, CAUSE_CTIDEVICENOTPREEMPTABLE, CAUSE_CTIDROPCONFEREE, CAUSE_CTIMANAGER_FAILURE, CAUSE_CTIPRECEDENCECALLBLOCKED, CAUSE_CTIPRECEDENCELEVELEXCEEDED, CAUSE_CTIPRECEDENCEOUTOFBANDWIDTH, CAUSE_CTIPREEMPTFORREUSE, CAUSE_CTIPREEMPTNOREUSE, CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_DPARK, CAUSE_DPARK_REMINDER, CAUSE_DPARK_UNPARK, CAUSE_EXCHANGEROUTINGERROR, CAUSE_FAC_CMC, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, CAUSE_OUTOFBANDWIDTH, CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QSIG_PR, CAUSE_QUALOFSERVNAVAIL, CAUSE_QUIET_CLEAR, CAUSE_RECOVERYONTIMEREXPIRY, CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUBSCRIBERABSENT, CAUSE_SUSPCALLBUTNOTTHISONE, CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, CAUSE_USERBUSY

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-74 Methods in CiscoConferenceChainAddedEv

Interface
Method
Description

javax.telephony.Connection

getAddedConnection()

Returns the conference chain Connection that was added to the call.

CiscoConferenceChain

getConferenceChain()

Returns a CiscoConferenceChain that contains all of the conference connections for the calls that are chained together.


Inherited Methods

From Interface com.cisco.jtapi.extensions.CiscoCallEv

getCiscoCause, getCiscoFeatureReason

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values for more information.

CiscoConferenceChainRemovedEv

The system sends a CiscoConferenceChainRemovedEv event when a conference chain connection gets removed from a call. This event gets sent whenever a conference chain connection gets removed. This event gets reported via theCallControlCallObserver interface.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Superinterfaces

javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev

Declaration

public interface CiscoConferenceChainRemovedEv extends CiscoCallEv

Fields

Table 6-75 Fields in CiscoConferenceChainRemovedEv

Interface
Field

static int

ID


Inherited Fields

From Interface com.cisco.jtapi.extensions.CiscoCallEv

CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, CAUSE_CTICCMSIP400BADREQUEST, CAUSE_CTICCMSIP401UNAUTHORIZED, CAUSE_CTICCMSIP402PAYMENTREQUIRED, CAUSE_CTICCMSIP403FORBIDDEN, CAUSE_CTICCMSIP404NOTFOUND, CAUSE_CTICCMSIP405METHODNOTALLOWED, CAUSE_CTICCMSIP406NOTACCEPTABLE, CAUSE_CTICCMSIP407PROXYAUTHENTICATIONREQUIRED, CAUSE_CTICCMSIP408REQUESTTIMEOUT, CAUSE_CTICCMSIP410GONE, CAUSE_CTICCMSIP411LENGTHREQUIRED, CAUSE_CTICCMSIP413REQUESTENTITYTOOLONG, CAUSE_CTICCMSIP414REQUESTURITOOLONG, CAUSE_CTICCMSIP415UNSUPPORTEDMEDIATYPE, CAUSE_CTICCMSIP416UNSUPPORTEDURISCHEME, CAUSE_CTICCMSIP420BADEXTENSION, CAUSE_CTICCMSIP421EXTENSTIONREQUIRED, CAUSE_CTICCMSIP423INTERVALTOOBRIEF, CAUSE_CTICCMSIP480TEMPORARILYUNAVAILABLE, CAUSE_CTICCMSIP481CALLLEGDOESNOTEXIST, CAUSE_CTICCMSIP482LOOPDETECTED, CAUSE_CTICCMSIP483TOOMANYHOOPS, CAUSE_CTICCMSIP484ADDRESSINCOMPLETE, CAUSE_CTICCMSIP485AMBIGUOUS, CAUSE_CTICCMSIP486BUSYHERE, CAUSE_CTICCMSIP487REQUESTTERMINATED, CAUSE_CTICCMSIP488NOTACCEPTABLEHERE, CAUSE_CTICCMSIP491REQUESTPENDING, CAUSE_CTICCMSIP493UNDECIPHERABLE, CAUSE_CTICCMSIP500SERVERINTERNALERROR, CAUSE_CTICCMSIP501NOTIMPLEMENTED, CAUSE_CTICCMSIP502BADGATEWAY, CAUSE_CTICCMSIP503SERVICEUNAVAILABLE, CAUSE_CTICCMSIP504SERVERTIMEOUT, CAUSE_CTICCMSIP505SIPVERSIONNOTSUPPORTED, CAUSE_CTICCMSIP513MESSAGETOOLARGE, CAUSE_CTICCMSIP600BUSYEVERYWHERE, CAUSE_CTICCMSIP603DECLINE, CAUSE_CTICCMSIP604DOESNOTEXISTANYWHERE, CAUSE_CTICCMSIP606NOTACCEPTABLE, CAUSE_CTICONFERENCEFULL, CAUSE_CTIDEVICENOTPREEMPTABLE, CAUSE_CTIDROPCONFEREE, CAUSE_CTIMANAGER_FAILURE, CAUSE_CTIPRECEDENCECALLBLOCKED, CAUSE_CTIPRECEDENCELEVELEXCEEDED, CAUSE_CTIPRECEDENCEOUTOFBANDWIDTH, CAUSE_CTIPREEMPTFORREUSE, CAUSE_CTIPREEMPTNOREUSE, CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_DPARK, CAUSE_DPARK_REMINDER, CAUSE_DPARK_UNPARK, CAUSE_EXCHANGEROUTINGERROR, CAUSE_FAC_CMC, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, CAUSE_OUTOFBANDWIDTH, CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QSIG_PR, CAUSE_QUALOFSERVNAVAIL, CAUSE_QUIET_CLEAR, CAUSE_RECOVERYONTIMEREXPIRY, CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUBSCRIBERABSENT, CAUSE_SUSPCALLBUTNOTTHISONE, CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER,CAUSE_USERBUSY

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-76 Methods in CiscoConferenceChainRemovedEf

Interface
Method
Description

CiscoConferenceChain

getConferenceChain()

Returns a CiscoConferenceChain that contains all of the conference connections for the calls that are chained together. Returns: Connection.

javax.telephony.Connection

getRemovedConnection()

Returns the conference chain Connection that was removed from the call. Returns: CiscoConferenceChain.


Inherited Methods

From Interface com.cisco.jtapi.extensions.CiscoCallEv

getCiscoCause, getCiscoFeatureReason

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values for more information.

CiscoConferenceEndEv

The CiscoConferenceEndEv event indicates that a Conference operation completed. The system reports this event via the CallControlCallObserver interface.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1)

Created history table to track changes.


Superinterfaces

javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev

Declaration

public interface CiscoConferenceEndEv extends CiscoCallEv

Fields

Table 6-77 Fields in CiscoConferenceEndEv

Interface
Field

static int

ID


Inherited Fields

From Interface com.cisco.jtapi.extensions.CiscoCallEv

CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, CAUSE_CTICCMSIP400BADREQUEST, CAUSE_CTICCMSIP401UNAUTHORIZED, CAUSE_CTICCMSIP402PAYMENTREQUIRED, CAUSE_CTICCMSIP403FORBIDDEN, CAUSE_CTICCMSIP404NOTFOUND, CAUSE_CTICCMSIP405METHODNOTALLOWED, CAUSE_CTICCMSIP406NOTACCEPTABLE, CAUSE_CTICCMSIP407PROXYAUTHENTICATIONREQUIRED, CAUSE_CTICCMSIP408REQUESTTIMEOUT, CAUSE_CTICCMSIP410GONE, CAUSE_CTICCMSIP411LENGTHREQUIRED, CAUSE_CTICCMSIP413REQUESTENTITYTOOLONG, CAUSE_CTICCMSIP414REQUESTURITOOLONG, CAUSE_CTICCMSIP415UNSUPPORTEDMEDIATYPE, CAUSE_CTICCMSIP416UNSUPPORTEDURISCHEME, CAUSE_CTICCMSIP420BADEXTENSION, CAUSE_CTICCMSIP421EXTENSTIONREQUIRED, CAUSE_CTICCMSIP423INTERVALTOOBRIEF, CAUSE_CTICCMSIP480TEMPORARILYUNAVAILABLE, CAUSE_CTICCMSIP481CALLLEGDOESNOTEXIST, CAUSE_CTICCMSIP482LOOPDETECTED, CAUSE_CTICCMSIP483TOOMANYHOOPS, CAUSE_CTICCMSIP484ADDRESSINCOMPLETE, CAUSE_CTICCMSIP485AMBIGUOUS, CAUSE_CTICCMSIP486BUSYHERE, CAUSE_CTICCMSIP487REQUESTTERMINATED, CAUSE_CTICCMSIP488NOTACCEPTABLEHERE, CAUSE_CTICCMSIP491REQUESTPENDING, CAUSE_CTICCMSIP493UNDECIPHERABLE, CAUSE_CTICCMSIP500SERVERINTERNALERROR, CAUSE_CTICCMSIP501NOTIMPLEMENTED, CAUSE_CTICCMSIP502BADGATEWAY, CAUSE_CTICCMSIP503SERVICEUNAVAILABLE, CAUSE_CTICCMSIP504SERVERTIMEOUT, CAUSE_CTICCMSIP505SIPVERSIONNOTSUPPORTED, CAUSE_CTICCMSIP513MESSAGETOOLARGE, CAUSE_CTICCMSIP600BUSYEVERYWHERE, CAUSE_CTICCMSIP603DECLINE, CAUSE_CTICCMSIP604DOESNOTEXISTANYWHERE, CAUSE_CTICCMSIP606NOTACCEPTABLE, CAUSE_CTICONFERENCEFULL, CAUSE_CTIDEVICENOTPREEMPTABLE, CAUSE_CTIDROPCONFEREE, CAUSE_CTIMANAGER_FAILURE, CAUSE_CTIPRECEDENCECALLBLOCKED, CAUSE_CTIPRECEDENCELEVELEXCEEDED, CAUSE_CTIPRECEDENCEOUTOFBANDWIDTH, CAUSE_CTIPREEMPTFORREUSE, CAUSE_CTIPREEMPTNOREUSE, CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_DPARK, CAUSE_DPARK_REMINDER, CAUSE_DPARK_UNPARK, CAUSE_EXCHANGEROUTINGERROR, CAUSE_FAC_CMC, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, CAUSE_OUTOFBANDWIDTH, CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QSIG_PR, CAUSE_QUALOFSERVNAVAIL, CAUSE_QUIET_CLEAR, CAUSE_RECOVERYONTIMEREXPIRY, CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUBSCRIBERABSENT, CAUSE_SUSPCALLBUTNOTTHISONE, CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, CAUSE_USERBUSY

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-78 Methods in CiscoConferenceEndEv

Interface
Method
Description

javax.telephony.Address

getConferenceControllerAddress()

Returns the Address that currently acts as the conference controller for this call, the initiating call.

javax.telephony.Call

getConferencedCall()

Returns the call that merged. This call is in the Call.INVALID state.

javax.telephony.Call[]

getFailedCalls()

Returns list of Calls that could not be Conferenced.

javax.telephony.Call

getFinalCall()

Returns the call that remains active after the conference completes.

javax.telephony.Terminal
Connection

getHeldConferenceController()

Returns the TerminalConnection that currently acts as the conference controller for this call -- the final call. This is the TerminalConnection that was in HELD state when the conference got initiated. This method returns null or TerminalConnection if the conference controller is not being observed.

javax.telephony.Terminal
Connection

getTalkingConferenceController()

Returns the TerminalConnection that currently acts as the conference controller for this call -- the initiating call.This is the TerminalConnection that was in TALKING state. This method returns null or TerminalConnection if the conference controller is not being observed.

boolean

isSuccess()

Returns Boolean True or False depending on whether the conference succeeded or failed. The application can use this interface to determine whether a Conference is successful.

Conferences will fail in these situations:

If the application issues the request Call.conference(otherCalls[]), the system considers the conference as failed if one or more than one Calls could not Join into Conference. Use getFailedCalls() to find the failed calls.

If no conference bridge is available, and the conference could not complete. Use getFailedCalls() to get a list of the calls that could not join the conference.

If the party being conferenced drops out before the conference could complete.


Inherited Methods

From Interface com.cisco.jtapi.extensions.CiscoCallEv

getCiscoCause, getCiscoFeatureReason

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values

See Also isSuccess()

CiscoConferenceStartEv

The CiscoConferenceStartEv event indicates that a conference operation started. The CallControlCallObserver interface reports this event.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Added getControllerTerminalName() method for Join Across Lines/Connected Conference feature.


Superinterfaces

javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev

Declaration

public interface CiscoConferenceStartEv extends CiscoCallEv

Fields

Table 6-79 Fields in CiscoConferenceStartEv

Interface
Field

static int

ID


Inherited Fields

From Interface com.cisco.jtapi.extensions.CiscoCallEv

CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, CAUSE_CTICCMSIP400BADREQUEST, CAUSE_CTICCMSIP401UNAUTHORIZED, CAUSE_CTICCMSIP402PAYMENTREQUIRED, CAUSE_CTICCMSIP403FORBIDDEN, CAUSE_CTICCMSIP404NOTFOUND, CAUSE_CTICCMSIP405METHODNOTALLOWED, CAUSE_CTICCMSIP406NOTACCEPTABLE, CAUSE_CTICCMSIP407PROXYAUTHENTICATIONREQUIRED, CAUSE_CTICCMSIP408REQUESTTIMEOUT, CAUSE_CTICCMSIP410GONE, CAUSE_CTICCMSIP411LENGTHREQUIRED, CAUSE_CTICCMSIP413REQUESTENTITYTOOLONG, CAUSE_CTICCMSIP414REQUESTURITOOLONG, CAUSE_CTICCMSIP415UNSUPPORTEDMEDIATYPE, CAUSE_CTICCMSIP416UNSUPPORTEDURISCHEME, CAUSE_CTICCMSIP420BADEXTENSION, CAUSE_CTICCMSIP421EXTENSTIONREQUIRED, CAUSE_CTICCMSIP423INTERVALTOOBRIEF, CAUSE_CTICCMSIP480TEMPORARILYUNAVAILABLE, CAUSE_CTICCMSIP481CALLLEGDOESNOTEXIST, CAUSE_CTICCMSIP482LOOPDETECTED, CAUSE_CTICCMSIP483TOOMANYHOOPS, CAUSE_CTICCMSIP484ADDRESSINCOMPLETE, CAUSE_CTICCMSIP485AMBIGUOUS, CAUSE_CTICCMSIP486BUSYHERE, CAUSE_CTICCMSIP487REQUESTTERMINATED, CAUSE_CTICCMSIP488NOTACCEPTABLEHERE, CAUSE_CTICCMSIP491REQUESTPENDING, CAUSE_CTICCMSIP493UNDECIPHERABLE, CAUSE_CTICCMSIP500SERVERINTERNALERROR, CAUSE_CTICCMSIP501NOTIMPLEMENTED, CAUSE_CTICCMSIP502BADGATEWAY, CAUSE_CTICCMSIP503SERVICEUNAVAILABLE, CAUSE_CTICCMSIP504SERVERTIMEOUT, CAUSE_CTICCMSIP505SIPVERSIONNOTSUPPORTED, CAUSE_CTICCMSIP513MESSAGETOOLARGE, CAUSE_CTICCMSIP600BUSYEVERYWHERE, CAUSE_CTICCMSIP603DECLINE, CAUSE_CTICCMSIP604DOESNOTEXISTANYWHERE, CAUSE_CTICCMSIP606NOTACCEPTABLE, CAUSE_CTICONFERENCEFULL, CAUSE_CTIDEVICENOTPREEMPTABLE, CAUSE_CTIDROPCONFEREE, CAUSE_CTIMANAGER_FAILURE, CAUSE_CTIPRECEDENCECALLBLOCKED, CAUSE_CTIPRECEDENCELEVELEXCEEDED, CAUSE_CTIPRECEDENCEOUTOFBANDWIDTH, CAUSE_CTIPREEMPTFORREUSE, CAUSE_CTIPREEMPTNOREUSE, CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_DPARK, CAUSE_DPARK_REMINDER, CAUSE_DPARK_UNPARK, CAUSE_EXCHANGEROUTINGERROR, CAUSE_FAC_CMC, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, CAUSE_OUTOFBANDWIDTH, CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QSIG_PR, CAUSE_QUALOFSERVNAVAIL, CAUSE_QUIET_CLEAR, CAUSE_RECOVERYONTIMEREXPIRY, CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUBSCRIBERABSENT, CAUSE_SUSPCALLBUTNOTTHISONE, CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, CAUSE_USERBUSY

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-80 Methods in CiscoConferenceStartEv 

Interface
Method
Description

javax.telephony.Address

getConferenceControllerAddress()

Returns the Address that currently acts as the conference controller for this call, the initiating call.

javax.telephony.Call

getConferencedCall()

Returns the call that will be conferenced. This is the call that will be merged into the initiating call. This interface returns the first call from the list of calls that are joining into conference.

javax.telephony.Call[]

getConferencedCalls()

Returns the list of the calls that will be conferenced. These calls are the ones that will be merged into the final call.

javax.telephony.Call

getFinalCall()

Returns the call that will remain active after the conference completes. This is the call into which all the calls will merge.

javax.telephony.Terminal
Connection

getHeldConferenceController()

Returns the TerminalConnection that currently acts as the conference controller for this call, the initiating call. This is the TerminalConnection that was in HELD state. This method returns null if the conference controller is not being observed. This method returns the first held controller for a multiple call join scenario.

javax.telephony.Terminal
Connection[]

getHeldConferenceControllers()

Returns all TerminalConnections on Conference Controller Terminal that are joining together and are in HELD State.

javax.telephony.Address

getOriginalConferenceController
Address()

Returns the Address of the participant that initiated the conference.

javax.telephony.Terminal
Connection

getTalkingConferenceController()

Returns the TerminalConnection that currently acts as the conference controller for this call, the initiating call. This is the TerminalConnection that was in TALKING state. This method returns null if the conference controller is not being observed. This method returns null if there is no controller in talking state. Calls can be joined into a conference without any talking controller.

String

getControllerTerminalName()

Returns the terminal name of the controllers across which a conference is done.


Inherited Methods

From Interface com.cisco.jtapi.extensions.CiscoCallEv

getCiscoCause, getCiscoFeatureReason

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values.

CiscoConnection

The CiscoConnection interface extends the CallControlConnection interface with additional Cisco specific capabilities. Applications can use the getReason method to obtain the reason for the creation of a connection.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Added two new methods: getPartyInfo and disconnect(CiscoPartyInfopartyInfo for Drop Any Party feature.

8.0(1)

Enhanced with the following:

New method to get the associated CiscoHuntConnection. If application is observing hunt list member, applications can use this method to find out if call is routed through HuntPilot.

New interface getUniqueID(Terminal term) is added which will return the uniqueID as string.

New method that allows an application to determine if the connection is associated with a chaperone device on a chaperone call. Chapone devices have a limited feature set, and knowing that a connection is associated with a chaperone device can allow the application to better handle the connections.


All Superinterfaces

javax.telephony.callcontrol.CallControlConnection, CiscoObjectContainer, javax.telephony.Connection

Declaration

public interface CiscoConnection extends javax.telephony.callcontrol.CallControlConnection, CiscoObjectContainer

Fields

Table 6-81 Fields in CiscoConnection

Interface
Field
Description

static int

ADDRESS_SEARCH_SPACE

The redirect should be done by using the redirect controller address search space.

static int

CALLED_ADDRESS_DEFAULT

The default behavior for Cisco JTAPI should apply.

static int

CALLED_ADDRESS_SET_TO_PREFERRED
CALLEDPARTY

The original called Address should be set to the value present in preferredOriginalCalledParty field.

static int

CALLED_ADDRESS_SET_TO_REDIRECT_
DESTINATION

The called Address should be reset to the redirect destination.

static int

CALLED_ADDRESS_UNCHANGED

The called Address should remain unchanged after the redirect operation.

static int

CALLINGADDRESS_SEARCH_SPACE

The redirect should be done by using the calling address search space.

static int

DEFAULT_SEARCH_SPACE

The redirect should be done by using the default search space for the implementation.

static int

REASON_DIRECTCALL

This Connection results from a direct call.

static int

REASON_FORWARDALL

This Connection results from unconditional forwarding.

static int

REASON_FORWARDBUSY

This Connection results from a forwarding on busy.

static int

REASON_FORWARDNOANSWER

This Connection results from a forwarding on no answer.

static int

REASON_OUTBOUND

This Connection is an originating Connection, not a destination Connection.

static int

REASON_REDIRECT

This Connection results from a redirection.

static int

REASON_TRANSFERREDCALL

This Connection results from a transfer.

static int

REDIRECT_DROP_ON_FAILURE

This redirect mode instructs the implementation to perform redirect without checking the validity or availability of the destination.

static int

REDIRECT_NORMAL

This redirect mode instructs the implementation to perform redirect if the destination is valid and available.


Inherited Fields

From interface javax.telephony.callcontrol.CallControlConnection

ALERTING, DIALING, DISCONNECTED, ESTABLISHED, FAILED, IDLE, INITIATED, NETWORK_ALERTING, NETWORK_REACHED, OFFERED, OFFERING, QUEUED, UNKNOWN

From interface javax.telephony.Connection

CONNECTED, INPROGRESS

Methods

Table 6-82 Methods in CiscoConnection 

Interface
Method
Description

Boolean

getAddressPI()

Returns Presentation Indicator (PI) associated with the Address on which the connection is created.

CiscoHuntConnection

getCiscoHuntConnection()

This method returns the associated CiscoHuntConnection or null.

CiscoConnectionID

getConnectionID()

Returns CiscoConnectionID for this CiscoConnection

java.lang.String

getDParkPrefixCode()

Returns the prefix code that needs to be dialed with the DPark DN to retrieve the call.

int

getReason()

Returns the reason for the creation of this Connection. To function properly, some applications need to know the reason for the creation of the connection is created at an endpoint.

The reason for a Connection creation may be any of the following constants:

CiscoConnection.REASON_DIRECTCALL CiscoConnection.REASON_TRANSFERREDCALL

CiscoConnection.REASON_FORWARDNOANSWER

CiscoConnection.REASON_FORWARD
BUSY

CiscoConnection.REASON_FORWARD
ALL

CiscoConnection.REASON_REDIRECT

CiscoConnection.REASON_NORMAL

javax.telephony.TerminalConnection

getRequestController()

Returns the current request Controller for the Connection.

String

getUniqueID(Terminal term)

This method returns the updated uniqueID of the connection.

In case if there are no shared lines associated with this connection, application can just pass null object as parameter to this interface to get the Unique Identifier.

Unique Identifier will be same for all the shared lines, but if it's a barge scenario, different terminals would have different identifier.The returned Unique Identifier will be 32-character hex string. Please refer to End to End Call Tracing, page A-171, for more information.

Throws

PrivilegeVoilationException, InvalidStateException

Parameters

Terminal

boolean

isChaperone()

This method returns true if the connection is associated with a Chaperone call, and false if not.

java.lang.String

park()

This method parks the call at a system park DN and returns the address of the park DN.

javax.telephony.Connection

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

This method overloads the CallControlConnection.redirect() method.

Throws

javax.telephony.InvalidStateException, javax.telephony.InvalidPartyException, javax.telephony.MethodNotSupported
Exception, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailable
Exception

Parameters

Mode - This parameter can take one of the following two values:

CiscoConnection.REDIRECT_DROP_ON_FAILURE—This mode instructs the implementation to perform a redirect without checking the validity or availability of the destination. The original call gets dropped if the destination is invalid or busy.

CiscoConnection.REDIRECT_NORMAL—This mode instructs the implementation to perform a redirect only after checking the validity or availability of the destination. This matches the behavior of the CallControlConnection.redirect() method. The system does not drop the original call on failure.

javax.telephony.Connection

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

This method overloads the CallControlConnection.redirect() method. It takes two new parameters: redirectMode and callingSearchSpace.

The redirectMode selects which type of redirect to perform. The callingSearchSpace tells the implementation to use either the calling party search space or the redirect controller search space.

Parameters

mode—One of the following:

CiscoConnection.REDIRECT_DROP_ON_FAILURE—This mode instructs the implementation to perform a redirect without checking the validity or availability of the destination. The original call gets dropped if the destination is invalid or busy.

CiscoConnection.REDIRECT_NORMAL—This mode instructs the implementation to perform a redirect only after checking the validity or availability of the destination. This matches the behavior of the CallControlConnection.redirect() method. The system does not drop the original call on failure.

callingSearchSpace—One of the following:

CiscoConnection.DEFAULT_SEARCH_
SPACE

CiscoConnection.CALLINGADDRESS_
SEARCH_SPACE

CiscoConnection.ADDRESS_SEARCH_
SPACE

Throws

javax.telephony.InvalidStateException, javax.telephony.InvalidPartyException, javax.telephony.MethodNotSupported
Exception, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailable
Exception

javax.telephony.Connection

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

This method overloads the CallControlConnection.redirect() method.

It takes three new parameters: mode, callingSearchSpace, and calledAddressOption. The redirectMode selects the type of redirect to perform. The callingSearchSpace tells the implementation to use either the calling party search space or the redirect controller search space. The calledAddressOption parameter controls whether to reset the original called fields.

Parameters

mode—One of the following:

CiscoConnection.REDIRECT_DROP_ON_FAILURE

CiscoConnection.REDIRECT_NORMAL

callingSearchSpace—One of the following:

CiscoConnection.DEFAULT_SEARCH_
SPACE

CiscoConnection.CALLINGADDRESS_
SEARCH_SPACE

CiscoConnection.ADDRESS_SEARCH_
SPACE

calledAddressOption—One of the following:

CiscoConnection.CALLED_ADDRESS_
DEFAULT

CiscoConnection.CALLED_ADDRESS_
UNCHANGED

CiscoConnection.CALLED_ADDRESS_
SET_TO_REDIRECT_DESTINATION

Throws

javax.telephony.InvalidStateException, javax.telephony.InvalidPartyException, javax.telephony.MethodNotSupported
Exception, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailable
Exception

javax.telephony.Connection

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

This method overloads the CallControlConnection.redirect() method. It takes three new parameters: mode, callingSearchSpace, and calledAddressOption.

The redirectMode selects the type of redirect to perform. The callingSearchSpace tells the implementation to use either the calling party search space or the redirect controller search space. The calledAddressOption parameter controls whether to reset the original called fields.

If the FAC and CMC codes are missing or invalid, the call might not get offered and platformException may contain one of the following error codes:

CiscoJTAPIException.CTIERR_FAC_CMC_REASON_FAC_NEEDED

CiscoJTAPIException.CTIERR_FAC_CMC_REASON_CMC_NEEDED

CiscoJTAPIException.CTIERR_FAC_CMC_REASON_FAC_CMC_NEEDED

CiscoJTAPIException.CTIERR_FAC_CMC_REASON_FAC_INVALID

CiscoJTAPIException.CTIERR_FAC_CMC_REASON_CMC_INVALID

Parameters

mode—One of the following:

CiscoConnection.REDIRECT_DROP_ON_FAILURE

CiscoConnection.REDIRECT_NORMAL

callingSearchSpace—One of the following:

CiscoConnection.DEFAULT_SEARCH_
SPACE

CiscoConnection.CALLINGADDRESS_
SEARCH_SPACE

CiscoConnection.ADDRESS_SEARCH_
SPACE

   

preferredOriginalCalledParty—may be a DN that will be the originalCalledParty field when call is offered to destinationAddress. If this field * needs to be used, applications must set calledAddressOption as CALLED_ADDRESS_SET_TO_PREFERREDCALLEDPARTY. If applications are not interested in this field, you must pass the default value of null.

calledAddressOption—One of the following:

CiscoConnection.CALLED_ADDRESS_DEFAULT

CiscoConnection.CALLED_ADDRESS_UNCHANGED

CiscoConnection.CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION

preferredOriginalCalledParty—may be a DN that will be the originalCalledParty field when call is offered to destinationAddress. If this field * needs to be used, applications must set calledAddressOption as CALLED_ADDRESS_SET_TO_
PREFERREDCALLEDPARTY. If applications are not interested in this field, you must pass the default value of null.

facCode—required if the destinationAddress requires a forced authorization code to offer the call. Pass the FAC in this parameter. Pass the default value of null if the destinationAddress does not require a FAC code.

cmcCode—required if the destinationAddress requires a client matter code to offer the call. Pass the CMC in this parameter. Pass the default value of null if the destinationAddress does not require a CMC code.

javax.telephony.Connection

redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace, int calledAddressOption, java.lang.String preferredOriginalCalledParty, java.lang.String facCode, java.lang.String cmcCode, int featurePriority)

This method overloads CallControlConnection.redirect(). It takes a new parameter, featurePriority, that sets the call priority. The featurePriority parameter may be:

CiscoCall.FEATUREPRIORITY_NORMAL

CiscoCall.FEATUREPRIORITY_URGENT

CiscoCall.FEATUREPRIORITY_
EMERGENCY

Returns

Connection

Throws

javax.telephony.InvalidStateException, javax.telephony.InvalidPartyException, javax.telephony.MethodNotSupported
Exception, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailable
Exception

javax.telephony.Connection

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

This method overloads the CallControlConnection.redirect() method. It takes three new parameters: mode, callingSearchSpace, and preferredOriginalCalledParty.

The redirectMode selects the type of redirect to perform. The callingSearchSpace tells the implementation to use either the calling party search space or the redirect controller search space.

Parameters

mode—One of the following:

CiscoConnection.REDIRECT_DROP_ON_FAILURE

CiscoConnection.REDIRECT_NORMAL

callingSearchSpace—One of the following:

CiscoConnection.DEFAULT_SEARCH_SPACE

CiscoConnection.CALLINGADDRESS_SEARCH_SPACE

CiscoConnection.ADDRESS_SEARCH_SPACE

preferredOriginalCalledParty—May be a DN that will be the originalCalledParty field when the call gets offered to the destinationAddress.

Throws

javax.telephony.InvalidStateException, javax.telephony.InvalidPartyException, javax.telephony.MethodNotSupported
Exception, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailable
Exception

javax.telephony.Connection

redirect(String destinationAddress, int mode, int callingSearchSpace, int calledAddressOption, String preferredOriginalCalledParty, String facCode, String cmcCode, int featurePriority, byte[] applicationXMLData)

This method is similar to the existing redirect method on the CiscoConnection object, except this one takes an additional parameter, applicationXMLData.

Parameters

applicationXMLData

This parameter was added, and it allows an application to send message header point like SIP contact header info to the receiving end point. The parameter takes xml format as mentioned below.

<data>

<item>

<type>contact</type>

<operation>append</operation>

<protocol>SIP</protocol>

<value>;+sip.instance=&quot;&lt;urn:uuid=*guid*&gt;&quot;</value>

</item>

</data>

Note This version only supports: contact, operation: append, protocol: SIP. It can be enhanced to support other protocols and operations in the future.

If applications are not interested in this field, you must pass the default value of null.

void

setRequestController(javax.telephony.TerminalConnection tc)

This interface gets provided to a requesting TerminalConnection.

com.cisco.jtapi.extensions.Cisco
PartyInfo[]

getPartyInfo()

Returns a list of participants.

java.lang.void

disconnect(CiscoPartyInfoparty
Info)

Disconnects participant with whose CiscoPartyInfo matches the passed parameter value; throws exception otherwise.

Throws

PrivilegeViolationException, InvalidStateException


Inherited Methods

From Interface javax.telephony.callcontrol.CallControlConnection

accept, addToAddress, getCallControlState, park, redirect, reject

From Interface javax.telephony.Connection

disconnect, getAddress, getCall, getCapabilities, getConnectionCapabilities, getState, getTerminalConnections

From Interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Documentation

None

CiscoConnectionID

The CiscoConnectionID object represents a unique object that is associated with each connection. Applications may use the object itself or the integer representation of the object that the intValue() method returns.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Superinterfaces

CiscoObjectContainer

Declaration

public interface CiscoConnectionID extends CiscoObjectContainer

Fields

None

Methods

Table 6-83 Methods in CiscoConnectionID

Interface
Method
Description

CiscoConnection

getConnection()

Returns the CiscoConnection for the CiscoConnectionID.

Int

intValue()

Returns an integer representation of this object.


Inherited Methods

From Interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Related Documentation

None

CiscoConnectionUniqueIDChangedEv

It's a new event to highlight that uniqueID of the connection has changed.

Cisco Unified Communications Manager Release Number
Description

8.0(1)

New event


Interface History

Declaration

public interface CiscoConnectionUniqueIDChangedEv extends ConnEv

Methods

Table 6-84 Methods in CiscoConnectionUniqueIDChangedEv

Interface
Method
Description

String

getOldUniqueID()

This method returns the old uniqueID of the connection which has just changed. The returned value is a Unique Identifier as 32-character hex string.

Terminal

getTerminal()

This method returns the Terminal for which this ConnEv is delivered.

String

getUniqueID()

This method returns the updated uniqueID of the connection. The returned value is a Unique Identifier as 32-character hex string.


Related Documentation

CiscoConsultCall

The CiscoConsultCall interface extends the CiscoCall interface to expose certain properties of calls that have been created as part of a consultative transfer or consultative conference.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Superinterfaces

javax.telephony.Call, javax.telephony.callcontrol.CallControlCall, CiscoCall, CiscoObjectContainer

Declaration

public interface CiscoConsultCall extends CiscoCall

Fields

None

Inherited Fields

From Interface com.cisco.jtapi.extensions.CiscoCall

CALLSECURITY_AUTHENTICATED, CALLSECURITY_ENCRYPTED, CALLSECURITY_NOTAUTHENTICATED, CALLSECURITY_UNKNOWN, FEATUREPRIORITY_EMERGENCY, FEATUREPRIORITY_NORMAL, FEATUREPRIORITY_URGENT, PLAYTONE_BOTHLOCALANDREMOTE, PLAYTONE_LOCALONLY, PLAYTONE_NOLOCAL_OR_REMOTE, PLAYTONE_REMOTEONLY, SILENT_MONITOR

From Interface javax.telephony.Call

ACTIVE, IDLE, INVALID

Methods

Table 6-85 Methods in CiscoConsultCall 

Interface
Method
Description

javax.telephony.Terminal
Connection

getConsultingTerminalConnection()

Returns the consulting TerminalConnection that was used to create this CiscoConsultCall. If this Call was created as part of a consultative transfer or consultative conference, the getConsultingTerminalConnection method returns the TerminalConnection that was used to perform the consultation on the original call. This method lets you correlate a ConsultCall with its original call. The original call itself does not have any methods that you can use determine the ConsultCall, if any, to which it is related. Returns: Null if this Call does not result from a consultation, or the consulting TerminalConnection of the original Call if this call resulted from a consultation.

javax.telephony.Connection[]

consultWithoutMedia
(javax.telephony.TerminalConnection tc, java.lang.String dialedDigits)

Provides applications ability to initiate a consultative call without setting up media for it. This interface may be invoked when application is creating a consult call and completing transfer before media establishes for consult call.

Cisco Unified Communication Manager may some times run into erroneous race condition when consult call is answered, and application completes transfer in the middle of media setup for consult call.

To avoid this problem, application that does not wait for media setup completion for consult call, may use this method to setup consult call.

From CallEvent perspective, this method behaves similar to CallControlCall.consult(TerminalConnection tc, String dialedDigits).

Creates a consultation between this Call and an active Call without establishing the media. This consult call may only be transferred, not conferenced. Cisco JTAPI does not support this method with CallControlCall.setConferenceEnable(). Cisco JTAPI only supports this method with CallControlCall.setTransferEnable().

Throws

javax.telephony.InvalidStateException javax.telephony.InvalidArgumentException javax.telephony.MethodNotSupported
Exception javax.telephony.ResourceUnavailableException javax.telephony.PrivilegeViolationException javax.telephony.InvalidPartyException


Inherited Methods

From Interface com.cisco.jtapi.extensions.CiscoCall

conference, connect, getCalledAddressPI, getCalledPartyInfo, getCallID, getCallingAddressPI, getCallSecurityStatus, getConferenceChain, getCurrentCalledAddress, getCurrentCalledAddressPI, getCurrentCalledDisplayNamePI, getCurrentCalledPartyDisplayName, getCurrentCalledPartyInfo, getCurrentCalledPartyUnicodeDisplayName, getCurrentCalledPartyUnicodeDisplayNamelocale, getCurrentCallingAddress, getCurrentCallingAddressPI, getCurrentCallingDisplayNamePI, getCurrentCallingPartyDisplayName, getCurrentCallingPartyInfo, getCurrentCallingPartyUnicodeDisplayName, getCurrentCallingPartyUnicodeDisplayNamelocale, getGlobalizedCallingParty, getLastRedirectedPartyInfo, getLastRedirectingAddressPI, getLastRedirectingPartyInfo, getModifiedCalledAddress, getModifiedCallingAddress, startMonitor, startMonitor, transfer

From Interface javax.telephony.callcontrol.CallControlCall

addParty, conference, consult, consult, drop, getCalledAddress, getCallingAddress, getCallingTerminal, getConferenceController, getConferenceEnable, getLastRedirectedAddress, getTransferController, getTransferEnable, offHook, setConferenceController, setConferenceEnable, setTransferController, setTransferEnable, transfer, transfer

From Interface javax.telephony.Call

addObserver, connect, getCallCapabilities, getCapabilities, getConnections, getObservers, getProvider, getState, removeObserver

From Interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Related Documentation

See CiscoCall for more information.

CiscoConsultCallActiveEv

The CiscoConsultCallActiveEv event interface extends the JTAPI CallActiveEv event. This event indicates that the state of the call object changed to Call.ACTIVE and that the call was initiated as a result of a consultative transfer or consultative conference operation (manual or programmatic). Applications can obtain the consulting TerminalConnection on the original (consulting) call by using the CiscoConsultCall.getConsultingTerminalConnection method.

The system reports this event to applications via the CallObserver interface.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Superinterfaces

javax.telephony.events.CallActiveEv, javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev

Declaration

public interface CiscoConsultCallActiveEv extends CiscoCallEv, javax.telephony.events.CallActiveEv

Fields

None

Inherited Fields

From Interface com.cisco.jtapi.extensions.CiscoCallEv

CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, CAUSE_CTICCMSIP400BADREQUEST, CAUSE_CTICCMSIP401UNAUTHORIZED, CAUSE_CTICCMSIP402PAYMENTREQUIRED, CAUSE_CTICCMSIP403FORBIDDEN, CAUSE_CTICCMSIP404NOTFOUND, CAUSE_CTICCMSIP405METHODNOTALLOWED, CAUSE_CTICCMSIP406NOTACCEPTABLE, CAUSE_CTICCMSIP407PROXYAUTHENTICATIONREQUIRED, CAUSE_CTICCMSIP408REQUESTTIMEOUT, CAUSE_CTICCMSIP410GONE, CAUSE_CTICCMSIP411LENGTHREQUIRED, CAUSE_CTICCMSIP413REQUESTENTITYTOOLONG, CAUSE_CTICCMSIP414REQUESTURITOOLONG, CAUSE_CTICCMSIP415UNSUPPORTEDMEDIATYPE, CAUSE_CTICCMSIP416UNSUPPORTEDURISCHEME, CAUSE_CTICCMSIP420BADEXTENSION, CAUSE_CTICCMSIP421EXTENSTIONREQUIRED, CAUSE_CTICCMSIP423INTERVALTOOBRIEF, CAUSE_CTICCMSIP480TEMPORARILYUNAVAILABLE, CAUSE_CTICCMSIP481CALLLEGDOESNOTEXIST, CAUSE_CTICCMSIP482LOOPDETECTED, CAUSE_CTICCMSIP483TOOMANYHOOPS, CAUSE_CTICCMSIP484ADDRESSINCOMPLETE, CAUSE_CTICCMSIP485AMBIGUOUS, CAUSE_CTICCMSIP486BUSYHERE, CAUSE_CTICCMSIP487REQUESTTERMINATED, CAUSE_CTICCMSIP488NOTACCEPTABLEHERE, CAUSE_CTICCMSIP491REQUESTPENDING, CAUSE_CTICCMSIP493UNDECIPHERABLE, CAUSE_CTICCMSIP500SERVERINTERNALERROR, CAUSE_CTICCMSIP501NOTIMPLEMENTED, CAUSE_CTICCMSIP502BADGATEWAY, CAUSE_CTICCMSIP503SERVICEUNAVAILABLE, CAUSE_CTICCMSIP504SERVERTIMEOUT, CAUSE_CTICCMSIP505SIPVERSIONNOTSUPPORTED, CAUSE_CTICCMSIP513MESSAGETOOLARGE, CAUSE_CTICCMSIP600BUSYEVERYWHERE, CAUSE_CTICCMSIP603DECLINE, CAUSE_CTICCMSIP604DOESNOTEXISTANYWHERE, CAUSE_CTICCMSIP606NOTACCEPTABLE, CAUSE_CTICONFERENCEFULL, CAUSE_CTIDEVICENOTPREEMPTABLE, CAUSE_CTIDROPCONFEREE, CAUSE_CTIMANAGER_FAILURE, CAUSE_CTIPRECEDENCECALLBLOCKED, CAUSE_CTIPRECEDENCELEVELEXCEEDED, CAUSE_CTIPRECEDENCEOUTOFBANDWIDTH, CAUSE_CTIPREEMPTFORREUSE, CAUSE_CTIPREEMPTNOREUSE, CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_DPARK, CAUSE_DPARK_REMINDER, CAUSE_DPARK_UNPARK, CAUSE_EXCHANGEROUTINGERROR, CAUSE_FAC_CMC, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, CAUSE_OUTOFBANDWIDTH, CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QSIG_PR,CAUSE_QUALOFSERVNAVAIL, CAUSE_QUIET_CLEAR, CAUSE_RECOVERYONTIMEREXPIRY, CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUBSCRIBERABSENT, CAUSE_SUSPCALLBUTNOTTHISONE, CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, CAUSE_USERBUSY

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

javax.telephony.TerminalConnection getHeldTerminalConnection() Deprecated. Replaced by CiscoConsultCall.getConsultingTerminalConnection()

Table 6-86 Methods in CiscoConsultCallActiveEv

Interface
Method
Description

javax.telephony.TerminalConnection

getHeldTerminalConnection()

Deprecated method.

Replaced by CiscoConsultCall.getConsultingTerminal
Connection().

Returns the consulting TerminalConnection that was used to create this CiscoConsultCall. You can use this method to correlate a consultation call with its original call. The original call does not have any methods that you can use to determine the consultation call, if any, to which it is related. Returns: The consulting TerminalConnection of the call that created the call that is referenced by this event


Inherited Methods

From Interface com.cisco.jtapi.extensions.CiscoCallEv

getCiscoCause, getCiscoFeatureReason

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.CallEv

getCall

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Call, CallObserver, CallActiveEv and Constant Field Values for more information.

CiscoEv

The CiscoEv interface extends this code JTAPI javax.telephony.events.Ev interface and serves as the base interface for all Cisco-extended JTAPI events. Every event in this package extends this interface, directly or indirectly.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Superinterfaces

javax.telephony.events.Ev

Subinterfaces

CiscoAddrActivatedEv, CiscoAddrActivatedOnTerminalEv, CiscoAddrAddedToTerminalEv, CiscoAddrAutoAcceptStatusChangedEv, CiscoAddrCreatedEv, CiscoAddrEv, CiscoAddrInServiceEv, CiscoAddrIntercomInfoChangedEv, CiscoAddrIntercomInfoRestorationFailedEv, CiscoAddrOutOfServiceEv, CiscoAddrRecordingConfigChangedEv, CiscoAddrRemovedEv, CiscoAddrRemovedFromTerminalEv, CiscoAddrRestrictedEv, CiscoAddrRestrictedOnTerminalEv, CiscoCallChangedEv, CiscoCallEv, CiscoCallSecurityStatusChangedEv, CiscoConferenceChainAddedEv, CiscoConferenceChainRemovedEv, CiscoConferenceEndEv, CiscoConferenceStartEv, CiscoConsultCallActiveEv, CiscoMediaOpenLogicalChannelEv, CiscoOutOfServiceEv, CiscoProvCallParkEv, CiscoProvEv, CiscoProvFeatureEv, CiscoProvTerminalCapabilityChangedEv, CiscoRestrictedEv, CiscoRTPInputKeyEv, CiscoRTPInputStartedEv, CiscoRTPInputStoppedEv, CiscoRTPOutputKeyEv, CiscoRTPOutputStartedEv, CiscoRTPOutputStoppedEv, CiscoTermActivatedEv, CiscoTermButtonPressedEv, CiscoTermCreatedEv, CiscoTermDataEv, CiscoTermDeviceStateActiveEv, CiscoTermDeviceStateAlertingEv, CiscoTermDeviceStateHeldEv, CiscoTermDeviceStateIdleEv, CiscoTermDeviceStateWhisperEv, CiscoTermDNDOptionChangedEv, CiscoTermDNDStatusChangedEv, CiscoTermEv, CiscoTermInServiceEv, CiscoTermOutOfServiceEv, CiscoTermRegistrationFailedEv, CiscoTermRemovedEv, CiscoTermRestrictedEv, CiscoTermSnapshotCompletedEv, CiscoTermSnapshotEv, CiscoToneChangedEv, CiscoTransferEndEv, CiscoTransferStartEv

Declaration

public interface CiscoEv extends javax.telephony.events.Ev

Fields

None

Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

None

Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Ev for more information.

CiscoFeatureReason

The CiscoFeatureReason interface specifies the feature reason that is associated with each delivered event.

Interface History

Cisco Unified Communications Manager Release
Description

7.1(1 and 2)

Added new reason, FORWARD_NO_RETRIEVE, for the Park Monitoring and Assisted DPark feature.

8.0(1)

A new reason code, REASON_SAF_CCD_PSTN_FAILOVER, has been added to convey the proper reason for a PSTN failover to the application.

8.5(1)

A new feature reason, REASON_MEDIA_STREAMING, is added.


Declaration

public interface CiscoFeatureReason

Fields

Table 6-87 CiscoFeatureReason Fields 

Interface
Field
Description

static int

REASON_BARGE

Indicates that the reason for the event is BARGE feature.

static int

REASON_BLINDTRANSFER

Indicates that reason is single step transfer

static int

REASON_CALLPICKUP

Indicates that the reason for the events is PICKUP

static int

REASON_CCM_REDIRECTION

Indicates that the reason for the events is SIP 3xx feature.

static int

REASON_CLICK_TO_CONFERENCE

Indicates that connections have been added or removed by using the Click to Conference feature

static int

REASON_CONFERENCE

Indicates that the reason for the event is CONFERENCE

static int

REASON_DPARK_CALLPARK

Indicates that the reason for events is DPARK feature

public static final int

REASON_DEQUEUING

Indicates that the event is gererated because the call has got de-queued under the Native Queuing Feature.

public static final int

REASON_DEQUEUING_TIMER_EXPIRED

Indicates that the event is generated because the call is de-queued under the Native Queuing Feature as the maximum queue timer expired.

public static final int

REASON_DEQUEUING_AGENTS_BUSY

Indicates that the event has been gererated because the call has got de-queued under the Native Queuing Feature as the agents were busy and the queue was full.

public static final int

REASON_DEQUEUING_AGENTS_UNAVAILABLE

Indicates that the event is gererated because the call has got de-queued under the Native Queuing Feature as the agents were either not logged-in or were unregistered.

static int

REASON_DPARK_REVERSION

Indicates that the reason for events in DPARK Reversion

static int

REASON_DPARK_UNPARK

Indicates that the reason for events in DPARK UNPARK

static int

REASON_FAC_CMC

Indicates that the reason for the events is FAC, CMC feature

static int

REASON_FORWARDALL

Indicates that reason for the event is FORWARD

static int

REASON_FORWARDBUSY

Indicates that the reasons for the event is forward busy

static int

REASON_FORWARDNOANSWER

Indicates that the reasons for the event is forward no answer

static int

REASON_FORWARD_NO_RETRIEVE

Indications that the reason for the event is forward no retrieve

static int

REASON_IMMDIVERT

Indicates that the reason for the events is imm divert

static int

REASON_MEDIA_STREAMING

Indicates that the event received is related to an Agent Greeting call

static int

REASON_MOBILITY

Indicates that the reason for events caused by Mobility Manager feature

static int

REASON_MOBILITY_CELLPICKUP

Indicates that the reason for events caused by Mobility Manager feature

static int

REASON_MOBILITY_FOLLOWME

Indicates that the reason for events caused by Mobility Manager feature

static int

REASON_MOBILITY_HANDIN

Indicates that the reason for events caused by Mobility Manager feature

static int

REASON_MOBILITY_HANDOUT

Indicates that the reason for events caused by Mobility Manager feature

static int

REASON_MOBILITY_IVR

Indicates that the reason for events caused by Mobility Manager feature

static int

REASON_NORMAL

Indicates that the reason for the event is NORMAL

static int

REASON_PARK

Indicates that the reason for the event is PARK feature

static int

REASON_PARKREMAINDER

Indicates that the reasons for the event is park remainder

static int

REASON_QSIG_PR

Indicates that the reason for the event is QSIG path replacement

public static final int

REASON_QUEUING

Indicates that the event is generated due to the Native Queuing feature.

static int

REASON_REDIRECT

Indicates that the reason for event is REDIRECT

static int

REASON_REFER

Returned for events sent for REFER done at Cisco Unified Communications Manager

static int

REASON_REPLACE

REASON_REPLACE : This reason will be returned for events send for REPLACE feature done at Cisco Unified Communications Manager

static int

REASON_SILENTMONITORING

Indicates that the reason for events in SILENT MONITORING

static int

REASON_TRANSFER

Indicates that the reason for the event is TRANSFER

static int

REASON_UNPARK

Indicates that the reason for the event is unpark

static final int

REASON_SAF_CCD_PSTN_FAILOVER

Indicates the reason for PSTN failover to the application


Related Documentation

See Constant Field Values for more information.

CiscoHuntConnection

A CiscoHuntConnection in a call indicates that the call is routed through a hunt pilot.

Cisco Unified Communications Manager Release Number
Description

8.0(1)

New interface


Interface History

Declaration

public interface CiscoHuntConnection extends CiscoConnection.

Methods

Table 6-88 Methods in CiscoHuntConnection 

Interface
Method
Description

Connection[]

getAgentConnections()

This method returns an array of connections to the hunt group member or null.


Related Documentation

CiscoIntercomAddress

The CiscoIntercomAddress interface extends the CiscoAddress interface with additional Cisco Unified Communications Manager-specific capabilities for intercom addresses. This interface lets applications initiate intercom calls and take advantage of other intercom-specific features.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Superinterfaces

javax.telephony.Address, CiscoAddress, CiscoObjectContainer

Declaration

public interface CiscoIntercomAddress extends CiscoAddress

Fields

None

Inherited Fields

From Interface com.cisco.jtapi.extensions.CiscoAddress

APPLICATION_CONTROLLED_RECORDING, AUTO_RECORDING, AUTOACCEPT_OFF, AUTOACCEPT_ON, AUTOANSWER_OFF, AUTOANSWER_UNKNOWN, AUTOANSWER_WITHHEADSET, AUTOANSWER_WITHSPEAKERSET, EXTERNAL, EXTERNAL_UNKNOWN, IN_SERVICE, INTERNAL, MONITORING_TARGET, NO_RECORDING, OUT_OF_SERVICE, RINGER_DEFAULT, RINGER_DISABLE, RINGER_ENABLE, UNKNOWN

Methods

Table 6-89 Methods in CiscoIntercomAddress 

Interface
Method
Description

void

setIntercomTarget(java.lang.String targetDNjava.lang.String targetAsciiLabel, java.lang.String targetUnicodeLabel)

Sets the intercom target DN, intercom target label, and intercom target Unicode label that appears next to the intercom line on the phone. The phone displays the Unicode label if the phone has that capability; otherwise, the phone displays the ASCII target label.

Throws

javax.telephony.InvalidPartyException means that the target DN is invalid.

javax.telephony.InvalidStateException means that the address, terminal, or provider are not in service.

Parameters

targetDN—Destination DN for the intercom call

targetAsciiLabel—ASCII display label shown next to the intercom line on the phone target

UnicodeLabel—Unicode display label shown on the phone

Boolean

isIntercomTargetSet()

Returns true if an application has overridden the current value, or false if the current value matches the default value configured in the database.

void

resetIntercomTarget()

Resets the intercom target DN, intercom target label, and intercom target Unicode label to their default values.

Throws

javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException

java.lang.String

getIntercomTargetNumber()

Returns the current intercom target DN that the application set. If the application has not set the intercom target DN, this interface returns the default intercom target DN that is configured in Cisco Unified Communications Manager Administration. Returns: The intercom target DN number, as a string.

java.lang.String

getIntercomTargetAsciiLabel()

Returns the current intercom target label that the application set. If the application has not set the intercom target label, this interface returns the default intercom target label that is configured in Cisco Unified Communications Manager Administration. Returns: The intercom target label string.

java.lang.String

getIntercomTargetUnicodeLabel()

Returns the current intercom target Unicode label that the application set. If the application has not set the Unicode label, this interface returns the default intercom target Unicode label that is configured in Cisco Unified Communications Manager Administration. Returns: The intercom Unicode target label string.

java.lang.String

getDefaultIntercomTargetNumber()

Returns the default intercom target DN that is configured through Cisco Unified Communications Manager Administration. Returns: The default intercom target DN number, as a string.

java.lang.String

getDefaultIntercomTargetAsciiLabel()

Returns the default intercom target label that is configured through Cisco Unified Communications Manager Administration. Returns: The default intercom target label string.

java.lang.String

getDefaultIntercomTargetUnicodeLabel()

Returns the default intercom target label that is configured through Cisco Unified Communications Manager Administration. Returns: The default unicode intercom target label string.

javax.telephony.Connection[]

connectIntercom(javax.telephony.Terminal terminal, java.lang.String targetNumber)

Places an intercom call from an originating intercom address to a destination intercom address. Returns:A connection list for the calling and called intercom addresses.

Throws

javax.telephony.InvalidPartyException—The target DN is not a valid number.

javax.telephony.InvalidArgumentException—The address is not a CiscoIntercomAddress or the terminal is not a Terminal.

javax.telephony.InvalidStateException—The address, terminal, or provider is not in service.

javax.telephony.ResourceUnavailableException—A resource is not available to complete the operation.

javax.telephony.PrivilegeViolationException—The application does not have sufficient privileges to execute this operation.


Inherited Methods

From Interface com.cisco.jtapi.extensions.CiscoAddress

clearCallConnections, getAddressCallInfo, getAutoAcceptStatus, getAutoAnswerStatus, getInServiceAddrTerminals, getPartition, getRecordingConfig, getRegistrationState, getRestrictedAddrTerminals, getState, getType, isRestricted, setAutoAcceptStatus, setMessageWaiting, setRingerStatus

From Interface javax.telephony.Address

addCallObserver, addObserver, getAddressCapabilities, getCallObservers, getCapabilities, getConnections, getName, getObservers, getProvider, getTerminals, removeCallObserver, removeObserver

From Interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Related Documentation

See CiscoAddress for additional information.

CiscoIsacMediaCapability

The CiscoIsacMediaCapability object specifies the properties for a iSAC encoded RTP stream. Applications that support iSAC media termination use this object when registering a CiscoMediaTerminal.

The packet size and bit rate are variable.

Interface History

Cisco Unified Communications Manager Release Number
Description

8.0(1)

Interface added in this release for iSac codec which can be used by application to register a CiscoMediaTerminal or CiscoRouteTerminal if they want to use this new MediaCapability.


Superinterfaces

None

Declaration

public class CiscoIsacMediaCapabilityextends CiscoMediaCapability

Constuctors

Table 6-90 Constructor in CiscoIsacMediaCapability

Interface
Constructor
Description

public

CiscoIsacMediaCapability()

Constructs a CiscoIsacMediaCapability


Fields

None

Inherited Fields

From class com.cisco.jtapi.extensions.CiscoMediaCapability

G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, GSM_80_MILLISECONDS, ISAC, WIDEBAND_256K_10_MILLISECONDS

Methods

None

Inherited Methods

Inherited from class com.cisco.jtapi.extensions.CiscoMediaCapability

getMaxFramesPerPacket, getPayloadType, isSupported, toString

Inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

CiscoJtapiException

The CiscoJtapiException interface defines error codes that CTI requests may return. Cisco JTAPI extends all of the JTAPI exceptions to implement this interface. You can get the error codes by casting the exception to CiscoJtapiException and calling the method getErrorCode().

For example, if "e" is any exception caught by an application, the following code checks whether the exception is an instance of CiscoJtapiException.

try {
   // some code here
 }
catch ( Exception e ) {
   if( e instanceof CiscoJtapiException){
     CiscoJtapiException ce = com.cisco.cti.client.CTIFAILURE.(CiscoJtapiException) e
     int errorCode = com.cisco.cti.client.CTIFAILURE.ce.getErrorCode()   //returns the 
ErrorCode.
   }
 }
 
   

Interface History

Cisco Unified Communications Manager Release Number
Description

7.0

Added this interface.

7.1(1 and 2)

Added new error codes for the Logical Partition feature called: CiscoJtapiException.CTIERR_REDIRECT_CALL_
PARTITIONING_POLICY and CiscoJtapiException.CTIERR_FEATURE_NOT_
AVAILABLE.

8.0(1)

A new error code is added which will be exposed when the monitoring/recording request is rejected when the supervisor/recorder does not meet the security capabilities of the agent.

New error code, OPERATION_NOT_AVAILABLE_IN_CURRENT_STATE, has also been added.

8.5(1)

The following new error codes are added:
CTIERR_MEDIA_CONNECTION_FAILED, CTIERR_REQUEST_ALREADY_PENDING, CTIERR_START_STREAM_MEDIA_FAILED, CTIERR_STOP_STREAM_MEDIA_FAILED, CTIERR_NO_STREAMING_MEDIA_SESSION, CTIERR_EXISTING_STREAMING_MEDIA_SESSION
CTIERR_MEDIA_ALREADY_TERMINATED_STATIC_GETPORT_SUPPORT,
CTIERR_MEDIA_ALREADY_TERMINATED_DYNAMIC_GETPORT_SUPPORT,
CTIERR_SSO_DISABLED,
CTIERR_SSO_AUTH_SERVER_DOWN.

9.0(1)

The following new error codes are added:
CTIERR_INVALID_REMOTE_DESTINATION_NUMBER

CTIERR_DUPLICATE_REMOTE_DESTINATION_NUMBER

CTIERR_REMOTEDESTINATION_LIMIT_EXCEEDED

CTIERR_REMOTE_DEVICE_REQUEST_FAILED_ACTIVE_RD_NOT_SET

CTIERR_ENDUSER_NOT_ASSOCIATED_WITH_DEVICE

CTIERR_DEVICE_ALREADY_REGISTERED_NONEXTEND

CTIERR_MEDIA_ALREADY_TERMINATED_EXTEND

CTIERR_INVALID_REMOTE_DESTINATION_NAME

CTIERR_RECORDING_INVOCATION_TYPE_NOT_MATCHING


Declaration

public interface CiscoJtapiException

Fields

Table 6-91 Fields in CiscoJtapiException 

Interface
Field
Description

static int

ASSOCIATED_LINE_NOT_OPEN

This error indicates that the request is issued on a line, which is not open

static int

CALL_ALREADY_EXISTS

This error indicates that another call already exists on the line

static int

CALL_DROPPED

The call dropped after the feature request (hold, unhold, transfer, or conference) but before the request was completed.

static int

CALLHANDLE_NOTINCOMINGCALL

This error indicates that an attempt is made to answer a call that either does not exist or is not in the correct state

static int

CALLHANDLE_UNKNOWN_TO_
LINECONTROL

This error indicates that attempt to redirect call that was unknown to line control

static int

CANNOT_OPEN_DEVICE

This error indicates that device open failed because the associated device is unregistering

static int

CANNOT_TERMINATE_MEDIA_ON_
PHONE

This error indicates that media cannot be terminated by an application when the device is a physical phone (the phone always terminates the media)

static int

CFWDALL_ALREADY_SET

This error indicates that attempt to set CFWALL while it is already set

static int

CFWDALL_DESTN_INVALID

This error indicates that attempt to CFWALL to an invalid destination

static int

CLUSTER_LINK_FAILURE

This error indicates that link to one of the cisco unified communications managers failed in the cluster (network error)

static int

COMMAND_NOT_IMPLEMENTED_
ON_DEVICE

This error indicates that device does not support the command.

static int

CONFERENCE_ALREADY_PRESENT

This error indicates that attempt to conference a party that is already in conference

static int

CONFERENCE_FAILED

This error indicates that conference completion was not successful.

static int

CONFERENCE_FULL

This error indicates that all conference bridges are busy.

static int

CONFERENCE_INACTIVE

This error indicates that attempt to complete conference while consult conference is not active

static int

CONFERENCE_INVALID_
PARTICIPANT

This error indicates that an attempt to conference to self or an invalid participant

static int

CTIERR_ACCESS_TO_DEVICE_
DENIED

This error indicates that the access to device is denied.

static int

CTIERR_APP_SOFTKEYS_ALREADY_
CONTROLLED

This error indicates that the application softkeys are already controlled by another application

static int

CTIERR_APPLICATION_DATA_SIZE_
EXCEEDED

This error indicates that application data size has exceeded limit

static int

CTIERR_BIB_NOT_CONFIGURED

This error indicates built in bridge is not configured

static int

CTIERR_BIB_RESOURCE_NOT_
AVAILABLE

This error indicates that built in bridge resource not available

static int

CTIERR_CALL_MANAGER_NOT_
AVAILABLE

This error indicates that Communications Manager is not available currently

static int

CTIERR_CALL_NOT_EXISTED

This error indicates that call does not exist

static int

CTIERR_CALL_PARK_NO_DN

This error indicates no call park DN

static int

CTIERR_CALL_REQUEST_ALREADY_OUTSTANDING

This error indicates call request already outstanding

static int

CTIERR_CALL_UNPARK_FAILED

This error indicates that call unpark did not succeed

static int

CTIERR_CAPABILITIES_DO_NOT_
MATCH

This error indicates that capabilities do not match

static int

CTIERR_CLOSE_DELAY_NOT_
SUPPORTED_WITH_REG_TYPE

This error indicates that the close delay is not supported with this registration type

static int

CTIERR_CONFERENCE_ALREADY_
EXISTED

This error indicates that conference already exists

static int

CTIERR_CONFERENCE_NOT_EXISTED

This error indicates that conference does not exist

static int

CTIERR_CONNECTION_ON_INVALID_PORT

This error indicates application is trying to connect to invalid port

static int

CTIERR_CONSULT_CALL_FAILURE

This error indicates consult call failure

static int

CTIERR_CONSULTCALL_ALREADY_
OUTSTANDING

This error indicates that consult call already outstanding

static int

CTIERR_CRYPTO_CAPABILITY_
MISMATCH

This error indicates that device registration failed as device crypto algorithms does not match with current device registration

static int

CTIERR_CTIHANDLER_PROCESS_
CREATION_FAILED

This error indicates that CTIHandler process creation failed

static int

CTIERR_DB_INITIALIZATION_ERROR

This error indicates DB initialization error

static int

CTIERR_DEVICE_ALREADY_OPENED

This error indicates that device is already opened

static int

CTIERR_DEVICE_NOT_OPENED_YET

This error indicates that device is not yet opened

static int

CTIERR_DEVICE_OWNER_ALIVE_
TIMER_STARTED

This error indicates that there is a device registration failure

static int

CTIERR_DEVICE_REGISTRATION_
FAILED_NOT_SUPPORTED_MEDIATYPE

This error indicates an invalid media type, CTIPort need to be registered with Dynamic media port registation if it has an intercom line

static int

CTIERR_DEVICE_RESTRICTED

This error indicates that the device is restricted

static int

CTIERR_DEVICE_SHUTTING_DOWN

This error indicates that device is shutting down

static int

CTIERR_DIRECTORY_LOGIN_
TIMEOUT

This error indicates that there is a directory login time out

static int

CTIERR_DUPLICATE_CALL_
REFERENCE

This error indicates duplicate call reference

static int

CTIERR_DYNREG_IPADDRMODE_
MISMATCH

This indicates registration failure when Cisco Media/Route Terminal is already registered with different Addressing mode.

static int

CTIERR_EXISTING_STREAMING_MEDIA_SESSION

This error occurs if an application attempts to invoke an Agent Greeting API while another request is made and accepted.

JTAPI throws InvalidStateException with a description as "There is an existing streaming media session".

static int

CTIERR_FAC_CMC_REASON_CMC_
INVALID

Client Matter Code (CMC) entered is invalid

static int

CTIERR_FAC_CMC_REASON_CMC_
NEEDED

CMC is required to offer the call

static int

CTIERR_FAC_CMC_REASON_FAC_
CMC_NEEDED

Forced Authorization Code (FAC) and CMC are required to offer call

static int

CTIERR_FAC_CMC_REASON_FAC_
INVALID

FAC entered is invalid

static int

CTIERR_FAC_CMC_REASON_FAC_
NEEDED

FAC is required to offer the call

static int

CTIERR_FEATURE_ALREADY_REGISTERED

This error indicates feature already registered

static int

CTIERR_FEATURE_DATA_REJECT

This error indicates feature data reject

static int

CTIERR_FEATURE_SELECT_FAILED

This error indicates that feature select failed

static int

CTIERR_ILLEGAL_DEVICE_TYPE

This error indicates that the device type is illegal

static int

CTIERR_INCOMPATIBLE_
AUTOINSTALL_PROTOCOL_VERSION

This error indicates that auto install protocol version is incompatible

static int

CTIERR_INCORRECT_MEDIA_
CAPABILITY

Device registration failed due to incorrect media capability.

static int

CTIERR_INFORMATION_NOT_
AVAILABLE

This error indicates that information is not available

static int

CTIERR_INTERCOM_SPEEDDIAL_
ALREADY_CONFIGURED

This error indicates that intercom target value is already configured, application is trying to make call with Intercom target DN

static int

CTIERR_INTERCOM_SPEEDDIAL_
ALREADY_SET

This error indicates that intercom request failed as intercom target value is already set, application is trying to set again

static int

CTIERR_INTERCOM_SPEEDDIAL_
DESTN_INVALID

This error indicates that intercomm request failed as intercom target value in not in the intercom group

static int

CTIERR_INTERCOM_TALKBACK_
ALREADY_PENDING

This error indicates that intercom talk back request is already pending

static int

CTIERR_INTERCOM_TALKBACK_FAILURE

This error indicates that talkback request failed for some reason.

static int

CTIERR_INTERNAL_FAILURE

This error indicates there is a CTI internal failure

static int

CTIERR_INVALID_CALLID

This error indicates the call ID is invalid

static int

CTIERR_INVALID_DEVICE_NAME

This error indicates that the device name is not valid

static int

CTIERR_INVALID_DTMFDIGITS

Play DTMF request failed because it is an invalid DTMF digit.

static int

CTIERR_INVALID_FILTER_SIZE

This error indicates that filter size is invalid

static int

CTIERR_INVALID_MEDIA_DEVICE

This error indicates that the media device is not valid

static int

CTIERR_INVALID_MEDIA_
PARAMETER

This error indicates media parameter is inavlid

static int

CTIERR_INVALID_MEDIA_PROCESS

This error indicates that there is an invalid media process

static int

CTIERR_INVALID_MEDIA_RESOURCE_ID

This error indicates media resource ID is not valid

static int

CTIERR_INVALID_MESSAGE_HEADER_INFO

This error indicates that the header info is not valid

static int

CTIERR_INVALID_MESSAGE_LENGTH

This error indicates that message length is invalid

static int

CTIERR_INVALID_MONITOR_DESTN

This error indicates monitoring request failed due to invalid monitoring destination

static int

CTIERR_INVALID_MONITOR_DN_
TYPE

This error indicates an invalid monitor DN type

static int

CTIERR_INVALID_MONITORMODE

This error indicates monitor request failed due to an invalid monitor mode

static int

CTIERR_INVALID_PARAMETER

This error indicates that the parameter is not valid

static int

CTIERR_INVALID_PARK_DN

This error indicates that the DN is an invalid park DN

static int

CTIERR_INVALID_PARK_
REGISTRATION_HANDLE

This error indicates that the handle is an invalid park registration handle

static int

CTIERR_INVALID_RESOURCE_TYPE

This error indicates an invalid resource type

static int

CTIERR_IPADDRMODE_MISMATCH

This indicates the registration failure due to IP Addressing Mode mismatch.

static int

CTIERR_LINE_OUT_OF_SERVICE

This error indicates that line is out of service.

static int

CTIERR_LINE_RESTRICTED

This error indicates that the line is restricted

static int

CTIERR_MAXCALL_LIMIT_REACHED

This error indicates that maximum call limit has reached

static int

CTIERR_MEDIA_ALREADY_
TERMINATED_DYNAMIC

This error indicates that device registration failed as device is registered with Dynamic media termination

Final static int

CTIERR_MEDIA_ALREADY_TERMINATED_DYNAMIC_GETPORT_SUPPORT

This error indicates that the application tries to register a terminal, which is already registered with get port support, with a different registration type.

static int

CTIERR_MEDIA_ALREADY_
TERMINATED_NONE

This error indicates that device registration failed as device is already registered with media termination none

static int

CTIERR_MEDIA_ALREADY_
TERMINATED_STATIC

This error indicates that device registration failed as device is registered with Static media termination

Final static int

CTIERR_MEDIA_ALREADY_TERMINATED_STATIC_GETPORT_SUPPORT

This error indicates that the application tries to register a terminal, which is already registered with get port support, with a different registration type.

static int

CTIERR_MEDIA_CAPABILITY_
MISMATCH

This error indicates that device registration failed as media capability of device does not match with current device registration

static int

CTIERR_MEDIA_CONNECTION_FAILED

This error indicates that there is a general failure with the Agent Greeting feature.
JTAPI throws InvalidStateException with a description as "The connection to the media has failed".

static int

CTIERR_MEDIA_RESOURCE_NAME_
SIZE_EXCEEDED

This error indicates that media resource name size has exceeded limit

static int

CTIERR_MEDIAREGISTRATIONTYPE_DO_NOT_MATCH

This error indicates that media registration types do not match

static int

CTIERR_MESSAGE_TOO_BIG

This error indicates that message is too big

static int

CTIERR_MORE_ACTIVE_CALLS_
THAN_RESERVED

This error indicates that there are more active calls than reserved

static int

CTIERR_NO_EXISTING_CALLS

This error indicates there are no existing calls

static int

CTIERR_NO_EXISTING_CONFERENCE

This error indicates that there is no existing conference

static int

CTIERR_NO_RECORDING_SESSION

This error indicates recording request failed as there is no recording session

static int

CTIERR_NO_RESPONSE_FROM_MP

This error indicates no response from media resource

static int

CTIERR_NO_STREAMING_MEDIA_SESSION

This error occurs if an application attempts to invoke a stop request while there is no existing media stream to stop. JTAPI throws InvalidStateException with a description as "There is no streaming media session active".

static int

CTIERR_NOT_PRESERVED_CALL

This error indicates that the call is not preserved

static int

CTIERR_OPERATION_FAILED_
QUIETCLEAR

This error indicates that feature unavailable for this call due to temporary failure

static int

CTIERR_OPERATION_NOT_ALLOWED

This error indicates that this operation is not allowed

static int

CTIERR_OUT_OF_BANDWIDTH

This error indicates out of bandwidth error

static int

CTIERR_OWNER_NOT_ALIVE

This error indicates a failure during registering the device

static int

CTIERR_PENDING_ACCEPT_OR_
ANSWER_REQUEST

This error indicates that there is a pending accept or answer request

static int

CTIERR_PENDING_START_
MONITORING_REQUEST

This error indicates there is a pending start monitoring request

static int

CTIERR_PENDING_START_
RECORDING_REQUEST

This error indicates there is a pending start recording request

static int

CTIERR_PENDING_STOP_RECORDING_REQUEST

This error indicates there is a pending stop recording request

static int

CTIERR_PRIMARY_CALL_INVALID

This error indicates that primary call in monitoring request in invalid or gone idle

static int

CTIERR_PRIMARY_CALL_STATE_
INVALID

This error indicates that primary call in monitoring request is in invalid state

static int

CTIERR_RECORDING_ALREADY_
INPROGRESS

This error indicates recording request failed that recording is already in progress

static int

CTIERR_RECORDING_CONFIG_NOT_
MATCHING

This error indicates recording configuration does not match

static int

CTIERR_RECORDING_SESSION_INACTIVE

This error indicates recording request failed because recording session is inactive

static int

CTIERR_REDIRECT_UNAUTHORIZED_COMMAND_USAGE

This error indicates a redirect unauthorized command usage

static int

CTIERR_REGISTER_FEATURE_
ACTIVATION_FAILED

This error indicates that register feature activation failed

static int

CTIERR_REGISTER_FEATURE_APP_
ALREADY_REGISTERED

Register feature application was already registered

static int

CTIERR_REGISTER_FEATURE_
PROVIDER_NOT_REGISTERED

Register feature provider was not registered.

static int

CTIERR_REQUEST_ALREADY_PENDING

This error occurs if an application attempts to invoke an Agent Greeting API while another request is made.
JTAPI throws InvalidStateException with a description as "The request was rejected because there is a similar request already pending".

static int

CTIERR_RESOURCE_NOT_AVAILABLE

This error indicates that resource is not available to fulfil the request

public static final int

CTIERR_SECURITY_CAPABILITY_MISMATCH

This error code is exposed when the monitoring/recording request is rejected when the supervisor/recorder does not meet the security capabilities of the agent.

int

CTIERR_SSO_AUTH_SERVER_DOWN

This error code is returned if authorization server is down.

int

CTIERR_SSO_DISABLED

This error code is returned if the Single Sign-On feature is not enabled on Cisco Unified Communications Manager.

static int

CTIERR_START_MONITORING_
FAILED

This error indicates that start monitoring request failed

static int

CTIERR_START_RECORDING_FAILED

This error indicates that start recording request failed

static int

CTIERR_START_STREAM_MEDIA_FAILED

This error occurs if there is a general failure with the Agent Greeting feature, that is not covered by any of the other error codes.
JTAPI throws InvalidStateException with a description as "Start streaming media request failed".

static int

CTIERR_STOP_STREAM_MEDIA_FAILED

This error occurs if there is a general failure with the Agent Greeting feature, that is not covered by any of the other error codes.

JTAPI throws InvalidStateException with a description as "Stop streaming media request failed".

static int

CTIERR_STATION_SHUT_DOWN

This error indicates that there is a station shutdown

static int

CTIERR_SYSTEM_ERROR

This error indicates CTI system error

static int

CTIERR_UDP_PASS_THROUGH_NOT_
SUPPORTED

This error indicates UDP data passthrough not supported

static int

CTIERR_UNKNOWN_EXCEPTION

This error indicates an unknown exception occured

static int

CTIERR_UNSUPPORTED_CALL_PARK_TYPE

This error indicates that call park type is not supported

static int

CTIERR_UNSUPPORTED_CFWD_TYPE

This error indicates that the call forward type is unsupported

static int

CTIERR_USER_NOT_AUTH_FOR_
SECURITY

This error indicates user is not authorized for secure connection

static int

CTIERR_REDIRECT_CALL_PARTITIONING_POLICY

This error indicates redirect is not authorized

static int

CTIERR_FEATURE_NOT_AVAILABLE

This error indicates that the feature is unavailable

static int

DARES_INVALID_REQ_TYPE

This error indicates that there is an internal call processing error: DaRes invalid request type

static int

DATA_SIZE_LIMIT_EXCEEDED

This error indicates that XML data object size is bigger than allowed.

static int

DB_ERROR

This error indicates that the device query contained an illegal device type

static int

DB_ILLEGAL_DEVICE_TYPE

This error indicates illegal device type in DB

static int

DB_NO_MORE_DEVICES

This error is no longer used.

static int

DESTINATION_BUSY

This error indicates that destination is busy

static int

DESTINATION_UNKNOWN

This error indicates that destination is not found

static int

DEVICE_ALREADY_REGISTERED

This error indicates that device registration attempt failed, because the device is already registered

static int

DEVICE_NOT_OPEN

This error indicates that an attempt to open a line failed, as the device is not opened or the device is not registered.

static int

DEVICE_OUT_OF_SERVICE

This error indicates that device is out of service.

static int

DIGIT_GENERATION_ALREADY_IN_
PROGRESS

This error indicates that digit generation is already in progress.

static int

DIGIT_GENERATION_CALLSTATE_
CHANGED

This error indicates that call state is invalid to continue.

static int

DIGIT_GENERATION_WRONG_CALL_HANDLE

This error indicates that call handle is invalid and call may be gone.

static int

DIGIT_GENERATION_WRONG_CALL_STATE

This error indicates that call state is not valid to generate digits.

static int

DIRECTORY_LOGIN_FAILED

This error indicates that directory login failed: directory not initialized

static int

DIRECTORY_LOGIN_NOT_ALLOWED

This error indicates that directory login failed

static int

DIRECTORY_TEMPORARY_
UNAVAILABLE

This error indicates that directory is temporarily unavailable.

static int

EXISTING_FIRSTPARTY

This error indicates that there is already a device controlling media.

static int

HOLDFAILED

This error indicates that the hold was rejected by line control or call control layers

static int

ILLEGAL_CALLINGPARTY

This error indicates that an attempt was made to originate call using a calling party that is not on the device

static int

ILLEGAL_CALLSTATE

This error indicates line is not in a legal state to invoke the request

static int

ILLEGAL_HANDLE

This error indicates the handle is not valid

static int

ILLEGAL_MESSAGE_FORMAT

This error indicates that there is a QBE protocol error

static int

INCOMPATIBLE_PROTOCOL_VERSION

This error indicates that JTAPI and CTI versions are not compatible : CTI Error Protocol version not supported

static int

INVALID_LINE_HANDLE

This error indicates that attempt to perform a line operation on an invalid line handle.

static int

INVALID_RING_OPTION

This error indicates that the ring option is invalid

static int

LINE_GREATER_THAN_MAX_LINE

This error indicates that line is greater than the maximum available lines on this device

static int

LINE_INFO_DOES_NOT_EXIST

This error indicates that line information does not exist in the database.

static int

LINE_NOT_PRIMARY

This error indicates that internal error returned from call control.

static int

LINECONTROL_FAILURE

This error indicates line control refuses to allow a new call to be initiated because of its current state.

static int

MAX_NUMBER_OF_CTI_CONNECTIONS_REACHED

The maximum number of CTI connections was reached.

static int

MSGWAITING_DESTN_INVALID

This error indicates that attempt to set message waiting lamp for an invalid DN; Message Waiting Destination not found.

static int

NO_ACTIVE_DEVICE_FOR_
THIRDPARTY

This error indicates there is no active device for thirdparty

static int

NO_CONFERENCE_BRIDGE

This error indicates that no conference bridge available

static int

NOT_INITIALIZED

This error indicates that attempt is made to open a provider before CTI initialization completes

static int

OPERATION_NOT_AVAILABLE_IN_CURRENT_STATE

This error indicates that the operation is not available in Current state.

static int

PROTOCOL_TIMEOUT

Internal error returned from call control

static int

PROVIDER_ALREADY_OPEN

This error indicates that an attempt is made to reopen provider

static int

PROVIDER_CLOSED

Attempt to close provider while it is already closed

static int

PROVIDER_NOT_OPEN

This error indicates that device list incomplete or device list query timeout or query aborted

static int

REDIRECT_CALL_CALL_TABLE_FULL

This error indicates that internal error is returned from call control

static int

REDIRECT_CALL_DESTINATION_
BUSY

This error indicates that the redirect destination is busy

static int

REDIRECT_CALL_DESTINATION_OUT_OF_ORDER

This error indicates that redirect destination is out of order

static int

REDIRECT_CALL_DIGIT_ANALYSIS_
TIMEOUT

This error indicates a digit analyss time out, this is an internal error returned from call control

static int

REDIRECT_CALL_DOES_NOT_EXIST

This error indicates that an attempt is made to redirect a call that does not exist or is not longer active

static int

REDIRECT_CALL_INCOMPATIBLE_
STATE

This error indicates that internal error is returned from call control

static int

REDIRECT_CALL_MEDIA_
CONNECTION_FAILED

This error indicates media connection failure, this is an internal error returned from call control

static int

REDIRECT_CALL_NORMAL_
CLEARING

This error indicates that redirect failed because of normal call clearing

static int

REDIRECT_CALL_ORIGINATOR_
ABANDONED

This error indicates that far end hung up on the call being redirected

static int

REDIRECT_CALL_PARTY_TABLE_
FULL

This error indicates that internal error is returned from call control

static int

REDIRECT_CALL_PENDING_
REDIRECT_TRANSACTION

This error indicates that internal error is returned from call control

static int

REDIRECT_CALL_PROTOCOL_ERROR

This error indicates a protocol error, this is an internal error returned from call control

static int

REDIRECT_CALL_UNKNOWN_
DESTINATION

This error indicates that an attempt is made to redirect to an unknown destination

static int

REDIRECT_CALL_UNKNOWN_ERROR

This error indicates that internal error is returned from call control

static int

REDIRECT_CALL_UNKNOWN_PARTY

This error indicates an unknown party is detected, this is an internal error returned from call control

static int

REDIRECT_CALL_UNRECOGNIZED_
MANAGER

This error indicates that internal error is returned from call control

static int

REDIRECT_CALLINFO_ERR

This error indicates that internal error is returned from call control

static int

REDIRECT_ERR

This error indicates that internal error is returned from call control

static int

RETRIEVEFAILED

This error indicates that retrieval of call was rejected by line control or call control

static int

RETRIEVEFAILED_ACTIVE_CALL_ON_LINE

This error indicates that error occurred in retrieving held call; because there is already another active call on the line

static int

SSAPI_NOT_REGISTERED

This error indicates that the redirect command was issued when the internal supporting interface was not initialized; either CTI has not yet finished its initialization or an internal error occurred

static int

TIMEOUT

This error indicates that the request has timed out.

static int

TRANSFER_INACTIVE

This error indicates that attempt to complete transfer, while consult tranfer is not there

static int

TRANSFERFAILED

This error indicates that the transfer failed probably because one of the call legs was hung up or disconnected from the far end

static int

TRANSFERFAILED_CALLCONTROL_
TIMEOUT

This error indicates that expected response from call control not received during a transfer

static int

TRANSFERFAILED_DESTINATION_
BUSY

This error indicates that an attempt is made to transfer call to a busy destination

static int

TRANSFERFAILED_DESTINATION_
UNALLOCATED

This error indicates an attempt is made to to transfer call to a directory number that is not registered

static int

TRANSFERFAILED_OUTSTANDING
_TRANSFER

This error indicates that existing transfer is still in progress

static int

UNDEFINED_LINE

This error indicates that the line that was specified, is not found on the device

static int

UNKNOWN_GLOBAL_CALL_HANDLE

This error indicates that the global call handle is unknown

static int

UNRECOGNIZABLE_PDU

This error indicates that there is a QBE protocol error

static int

UNSPECIFIED

This error indicates that an unspecified error has occured.


Inherited Fields

None

Methods

Table 6-92 Methods in CiscoJtapiException

Interface
Method
Description

int

getErrorCode()

Returns the errorCode as an integer for this exception.

java.lang.String

getErrorDescription()

Returns the detailed description of the errorCode

java.lang.String

getErrorDescription(int errorCode)

Deprecated

Use String getErrorDescription (); instead. Returns the detailed description of the errorCode.

java.lang.String

getErrorName()

Returns an exception in string format.

java.lang.String

getErrorName(int errorCode)

Deprecated

Use String getErrorName (); instead. Returns an exception in string format.


Inherited Methods

None

Related Documentation

See Constant Field Values for more information.

CiscoMediaStreamStartedEv

Applications receive the event when they observe a device that is the target of a "addMediaStream()" invocation. This is the Agent device. This event is sent when the media begins to play on the call.

This event is only deliviered to the device that invokes the original request. Multiple observers on the same address receive the events. Shared lines of the invoking device will not receive this event.

Declaration

public interface CiscoMediaStreamStartedEv extends CiscoCallEv

Fields

None

Inherited Fields

None

Methods

None

Inherited Methods

None

CiscoMediaStreamEndedEv

Applications receive the event when they observe a device that is the target of a "addMediaStream()" invocation. This is the Agent device. This event is sent when the media has finished playing on the call. It contains a field that it exposes if the media is played successfully, or if the end event is the result of an error.

This event is only deliviered to the device that invokes the original request. Shared lines of the invoking device will not receive this event.

Declaration

public interface CiscoMediaStreamEndedEv extends CiscoCallEv

Fields

Table 6-93 Fields in CiscoMediaStreamEndedEv 

Interface
Field
Description

static int

RESULT_FAILED

This result code indicates that the CiscoMediaStreamEndedEv is received due to some failure with the request that caused it to end early.

static int

RESULT_SUCCESS

This result code indicates that the CiscoMediaStreamEndedEv is received as a result of successful media streaming.

static int

RESULT_PRIMARY_CALL_DROPPED

This result code indicates that the CiscoMediaStreamEndedEv is received due to the primary call.


Inherited Fields

None

Methods

Table 6-94 Fields in CiscoMediaStreamEndedEv

Interface
Method
Description

boloean

getResult()

Returns one of the above result codes, which allows the applications to figure out if the CiscoMediaStreamEndedEv is received due to an error, or upon a successful request.


Inherited Methods

None

CiscoJtapiPeer

By extending the com.cisco.services.tracing.TraceModule interface, CiscoJtapiPeer exposes trace information to applications. All instances of JtapiPeer objects that the Cisco JTAPI implementation creates implement this interface. Applications that want to manipulate the trace settings of the Cisco JTAPI implementation may use the CiscoJtapiPeer.getTraceManager method to obtain its TraceManager object. Applications can then manipulate the TraceManager object as described in the com.cisco.services.tracing package.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.

8.5(1)

Added a new API getprovider().


Superinterfaces

CiscoObjectContainer, javax.telephony.JtapiPeer, TraceModule

Declaration

public interface CiscoJtapiPeer extends TraceModule, javax.telephony.JtapiPeer, CiscoObjectContainer

Fields

None

Methods

Table 6-95 Methods in CiscoJtapiPeer 

Interface
Method
Description

CiscoJtapiProperties

getJtapiProperties()

Defines the various methods that applications can use to modify the parameters that the JTAPI layer will use.

void

setJtapiProperties(CiscoJtapiProperties jtapiproperties)

Provides applications ability to save changes made to CiscoJtapiProperties in jtapi.ini file and activate these changes in properties for the providers in JTAPIPeer.

 

getprovider()

Enhanced to read the single sign on ticket as ssoticket="ssoticketfromAD".


Inherited Methods

From Interface com.cisco.services.tracing.TraceModule

getTraceManager, getTraceModuleName

From Interface javax.telephony.JtapiPeer

getName, getProvider, getServices

From Interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Related Documentation

See CiscoJtapiProperties and TraceModule for more information.

CiscoJtapiPeerImpl

This interface has a method called "getProvider()," which is the primary way for applications to open a JTAPI provider. This method takes a "provider string," and it was enhanced to take a new argument.

Declaration

public interface CiscoJtapiPeerImpl extends ObjectContainerImpl implements CiscoJtapiPeer

Fields

Methods

Table 6-96 Methods in CiscoJtapiPeerImpl

Interface
Method
Description

provider

getProvider(String providerString)

The provider string argument is a string of key or value pairs . A new key was added to this method to allow applications to specify whether to run in FIPS compliant mode. The new argument is "FIPSCompliant," and applications should specify "true" or "false."

Specifying any value for the FIPSCompliant parameter in the Provider String will have no affect if the provider is not configured as a secured connection.


CiscoJtapiProperties

Cisco Unified JTAPI behavior and functionality is tailored by many parameters which are read in from the jtapi.ini file when an instance of CiscoJtapiPeer is instantiated. These parameters are now exposed to applications for control via this CiscoJtapiproperties interface.

Applications can query the CiscoJtapiproperties properties object and change these parameters to better suit the application functionality. Exposing these properties via the CiscoJtapiproperties interface also allows applications to have a single point of administration (at the application end) for these parameters. The most visible parameters are those describing the tracing levels and tracing destinations.

Usage

JtapiPeer peer = JtapiPeerFactory.getJtapiPeer ( null );
 if(peer instanceof CiscoJtapiPeer) {
 CiscoJtapiProperties jProps = ((CiscoJtapiPeer)peer).getJtapiProperties();
 jProps.setTracePath("\\D:\\Traces\\WorkFlow");	 jProps.setUseJavaConsoleTrace(false);
 MyProviderObserver providerObserver = new MyProviderObserver ();
 provider = peer.getProvider ( providerName ); }
 
   

In the above example an application has set the Java console tracing to off and set the trace path to D:\Traces\WorkFlowApp1.When the peer is obtained an object implementing CiscoJtapiProperties is created by reading parameters set in the jtapi.ini file. If no jtapi.ini file exists in the classpath default settings are used to create this object. The parameters used by Cisco Jtapi are read in and frozen when the first getProvider () call is made.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.

8.0(1)

Enhanced with methods to enable/disable the HuntList feature.

8.6(1)

Enhanced with methods for applications to specify a desired level of FIPS compliance when they download certificates.


Declaration

public interface CiscoJtapiProperties

Fields

None

Sample Code

try {
          JtapiPeer peer = JtapiPeerFactory.getJtapiPeer ( null );
 
   
         MyProviderObserver providerObserver = new MyProviderObserver ();
         provider = peer.getProvider ( ipaddress;login=useid;passwd=password );
         if ( provider != null ) {
		provider.addObserver ( providerObserver );
		provInService.waitTrue();
	boolean hlenabled = ((CiscoJtapiPeer)peer).getJtapiProperties().getHuntListEnabled();
	System.out.Println("Initial state of HuntList = " + hlenabled);
	CiscoJtapiProperties cjp = ((CiscoJtapiPeer)peer).getJtapiProperties();
	cjp.setHuntListEnabled(true);
	((CiscoJtapiPeer)peer).setJtapiProperties(cjp);
	boolean hlenabled = ((CiscoJtapiPeer)peer).getJtapiProperties().getHuntListEnabled();
	System.out.Println("Final state of HuntList = " + hlenabled);
}

Methods

Table 6-97 Methods in CiscoJtapiProperties

Interface
Method
Description

void

deleteCertificates(java.lang.String username, java.lang.String instanceID, java.lang.String ccmCAPFAddress, java.lang.String certificatePath)

Deletes X.509 client certificate installed for USER Instance in certificate store.

void

deleteSecurityPropertyForInstance(java.lang.String username, java.lang.String instanceID, java.lang.String capfIp, java.lang.String certPath)

Deletes security properly from jtapi.ini file and also delete certificate previously installed for username/instanceId.

java.lang.String

getAlarmServiceHostname()

Gets the alarm service host name.

 int

getAlarmServicePort()

Gets the port number for the alarm service.

boolean

getCallSecurityStatusChangedEv()

Advises the application if it would receive the event CallSecurityStatusChangedEv when applicable.

int

getCtiRequestTimeout()

Gets the timout for cti requests, other than the provider open (seconds).

java.lang.String[]

getDebuggingNames()

Get names of supported debugging level jtapi traces.

boolean

getDebuggingValue(java.lang.String debuggingName)

Get the enabled or disabled state of a debugging level trace.

 int

getDesiredServerHeartbeatInterval()

Get the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds).

boolean

getDiscConnBeforeCreatingInCPIC()

Controls the event order for the scenario when only redirected party in observed by Application This interface returns True if ConnDisconnectedEv is send before ConnCreatedEv, False otherwise.

java.lang.String

getFileNameBase()

Gets the filename for individual log files.

java.lang.String

getFileNameExtension()

Gets the filename extension for log files.

Boolean

getHuntListEnabled()

Returns true if HuntList is enabled else false.

 int

getJavaSocketConnectTimeout()

Returns the value of service parameter for SOCKET CONNECT TIMEOUT in seconds.

 int

getNumTraceFiles()

Gets the number of trace files before rollover.

boolean

getPeriodicWakeupEnabled()

Gets the enabled state of periodic wake up.

 int

getPeriodicWakeupInterval()

Gets the interval for periodic wakeup (milliseconds).

boolean

getProcessOfferingAfterNewcallevent()

Retrieves the boolean value for the jtapi.ini parameter ProcessOfferringAfterNewcallEvent'. By default this interface returns false.

 int

getProviderOpenRequestTimeout()

Gets the timout for a provider open request (seconds).

 int

getProviderOpenRetryAttempts()

Returns the value of service parameter for maximum number of reconnect attempts to CTI Manager.

 int

getProviderRetryInterval()

Gets the interval at which the connection to the CTI Manager will ge retried (seconds).

 int

getQueueSizeThreshold()

Gets the threshold for the event queue size to trigger alarms.

boolean

getQueueStatsEnabled()

Gets the enabled state of event queue stats.

 int

getRouteSelectTimeout()

Gets the route select timeout (milliseconds).

java.util.Hashtable

getSecurityPropertyForInstance()

Returns a Hash table with all the parameters set for users and InstanceIDs.

See User/InstanceID Hashtable for key and value pairs.

java.util.Hashtable

getSecurityPropertyForInstance(java.lang.String user, java.lang.String instanceID)

Teturn a Hash table with all the parameters set for users and InstanceIDs.

See User/InstanceID Hashtable for key and value pairs.

java.lang.String[]

getServices()

Returns the services that this implementation supports.

java.lang.String

getSyslogCollector()

Gets the syslog collector hostname.

 int

getSyslogCollectorUDPPort()

Gets the syslog collector UDP port.

java.lang.String

getTraceDirectory()

Path directory where trace files will be written.

 int

getTraceFileSize()

Trace file size before rollover.

java.lang.String[]

getTraceNames()

Gets the names of supported jtapi traces.

java.lang.String

getTracePath()

Gets the path where the trace files will be located.

boolean

getTraceValue(java.lang.String traceName)

Gets the enabled or disabled state of a trace.

boolean

getUpdateJtapiCalledWithOriginalCalled()

Queries the parameter setting that changes Jtapi behavior on updating called address.

boolean

getUseAlarmService()

gets the enabled/disabled state of the alarm service.

boolean

getUseFileTrace()

Gets the enabled or disabled state of jtapi log file tracing.

boolean

getUseJavaConsoleTrace()

Gets the enabled or disabled state of jtapi console tracing.

boolean

getUseSameDir()

Causes the traces to go to a single directory if UseSameDir is true.

boolean

getUseSyslog()

Gets the enabled or disabled state of syslog tracing.

boolean

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

Provides information about where Client and Server certificates are updated for a given user/instanceID or if the Client and Server certificates are not updated.

void

setAlarmServiceHostname(java.lang.String hostname)

Sets the alarm service host name.

void

setAlarmServicePort(int portNumber)

Sets the port number the alarm service is listening on.

void

setCallSecurityStatusChangedEv(boolean val)

Enables applications to set the filter to receive CallSecurityStatusChangedEv to true or false.

void

setCtiRequestTimeout(int seconds)

Sets the time out for CTI requests other than provider open (seconds).

void

setDebuggingValue(java.lang.String debuggingName, boolean value)

Enables or disables a particular debugging level trace.

void

setDesiredServerHeartbeatInterval(int seconds)

Sets the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds).

void

setDiscConnBeforeCreatingInCPIC(boolean val)

Sets event order, sent Disconnect before Connection created during redirect at redirted party.

void

setFileNameBase(java.lang.String base)

Sets the filename for log files.

void

setFileNameExtension(java.lang.String extn)

Sets the filename extension for log files.

void

setHuntListEnabled (boolean)

Enables the Hunt List Feature in Cisco Unified JTAPI.

void

setJavaSocketConnectTimeout(int timeout)

Allows application to set the SOCKET CONNECT TIMEOUT in seconds.

void

setNumTraceFiles(int val)

Sets the number of trace files before rollover.

void

setPeriodicWakeupEnabled(boolean enabled)

Sets the enable/disable state for periodic wake up.

void

setPeriodicWakeupInterval(int milliseconds)

Sets the periodic wake up interval (milliseconds).

void

setProcessOfferingAfterNewcallevent(boolean val)

Controls the event order for the transfer scenario when only transfer destination observed by Application and transfer is completed in offering state.

void

setProviderOpenRequestTimeout(int seconds)

Sets the timeout for a provider open request (seconds).

void

setProviderOpenRetryAttempts(int retryAttempts)

Allows application to set the JTAPI Reconnect Attempts to CTI Manager.

void

setProviderRetryInterval(int seconds)

Sets the interval at which the connection to the CTI Manager will ge retried (seconds).

void

setQueueSizeThreshold(int size)

Sets the threshold for the event queue size to trigger alarms.

void

setQueueStatsEnabled(boolean enabled)

Enables and disables event queue statistics.

void

setRouteSelectTimeout(int milliseconds)

Sets the route select timeout milliseconds.

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)

Deprecated

This method is replaced by overloaded method setSecurityPropertyForInstance which takes an extra parameter certStorePassphrase, a passphrase for java key store. This method might have some security vulnerability.

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, java.lang.String certstorePassphrase)

Provides the application ability to downloading server/client cerfiticate and set security property for application instance in jtapi.ini file of JTAPI.

void

setSecurityPropertyForInstance(String user, String instanceID, String authCode, String tftp, String tftpPort, String capf, String capfPort, String certPath, boolean securityOption, String certstorePassphrase, boolean fipsCompliant)

This method provides applications the ability to download server/client certificate and set the security property for this application instance in the jtapi.ini file.

Specifying any value of fipsCompliant for this method will have no effect unless the securityOption is set to true.

It should be noted that this method will call updateCertificate() and updateServerCertificate(). This is the preferred way to acquire certificates.

void

setServices(java.lang.String[] services)

Sets a list of available services.

void

setSyslogCollector(java.lang.String value)

Sets the syslog collector hostname.

void

setSyslogCollectorUDPPort(int port)

Sets the syslog collector UDP port.

void

setTraceDirectory(java.lang.String dir)

Sets the directory where jtapi trace files should be written.

void

setTraceFileSize(int val)

Sets the size of the trace file.

void

setTracePath(java.lang.String path)

Sets the directory root where jtapi traces will be written.

void

setTraceValue(java.lang.String traceName, boolean value)

Enables or disables a particular trace.

void

setUpdateJtapiCalledWithOriginalCalled(boolean val)

Updates Jtapi Called information with original called once the parameter is set to true always.

void

setUseAlarmService(boolean value)

Enables or disables the alarm service.

void

setUseFileTrace(boolean value)

Enables or disables jtapi log file tracing.

void

setUseJavaConsoleTrace(boolean value)

Enables or disables jtapi console tracing.

void

setUseSameDir(boolean value)

Causes the traces to go to a single directory if UseSameDir is true.

void

setUseSyslog(boolean value)

Enables or disables syslog tracing.

void

updateCertificate(java.lang.String user, java.lang.String intanceID, java.lang.String authcode, java.lang.String ccmTFTPAddress, java.lang.String ccmTFTPPort, java.lang.String ccmCAPFAddress, java.lang.String ccmCAPFPort, java.lang.String certificatePath)

Deprecated

This method is replaced by overloaded method updateCertifcate which takes an extra parameter certStorePassphrase, a passphrase for java key store. This method might have some security vulnerability.

void

updateCertificate(java.lang.String user, java.lang.String intanceID, java.lang.String authcode, java.lang.String ccmTFTPAddress, java.lang.String ccmTFTPPort, java.lang.String ccmCAPFAddress, java.lang.String ccmCAPFPort, java.lang.String certificatePath, java.lang.String certStorePassphrase)

Installs an X.509 client certificate for USER Instance in cerfiticate store.

void

updateCertificate(String user, String intanceID, String authcode, String ccmTFTPAddress, String ccmTFTPPort, String ccmCAPFAddress, String ccmCAPFPort, String certificatePath, String certStorePassphrase, boolean fipsCompliant) throws Exception, IOException, UnknownHostException;

This method downloads the client and server certificates for the specified parameters.

void

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

Deprecated

This method is replaced by overloaded method updateServerCertifcate which takes an extra parameter certStorePassphrase, a passphrase for java key store. This method might have some security vulnerability.

void

updateServerCertificate(java.lang.String userName, java.lang.String instanceID, java.lang.String ccmTFTPAddress, java.lang.String ccmTFTPPort, java.lang.String ccmCAPFAddress, java.lang.String ccmCAPFPort, java.lang.String certificatePath, java.lang.String certStorePassphrase)

Installs an X.509 server certificate given certificate path.

void

updateServerCertificate(String userName, String instanceID, String ccmTFTPAddress, String ccmTFTPPort, String ccmCAPFAddress, String ccmCAPFPort, String certificatePath, String certStorePassphrase, boolean fipsCompliant) throws Exception, IOException, UnknownHostException;

This method downloads the server certificates for the specified parameters. It is called by updateCertificate().


User/InstanceID Hashtable

Table 6-98 User/InstanceID Hash Table

Key
Value

"user"

userName

String "instanceID"

InstanceID

String"AuthCode"

authCode

String "CAPF"

capfServerIP-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)


Related Documentation

CiscoLocales

This interface lists all the locales that Cisco Unified JTAPI supports.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Declaration

public interface CiscoLocales

Fields

Table 6-99 Fields in CiscoLocales

Interface
Field

static int

LOCALE_ARABIC_ALGERIA

static int

LOCALE_ARABIC_BAHRAIN

static int

LOCALE_ARABIC_EGYPT

static int

LOCALE_ARABIC_IRAQ

static int

LOCALE_ARABIC_JORDAN

static int

LOCALE_ARABIC_KUWAIT

static int

LOCALE_ARABIC_LEBANON

static int

LOCALE_ARABIC_MOROCCO

static int

LOCALE_ARABIC_OMAN

static int

LOCALE_ARABIC_QATAR

static int

LOCALE_ARABIC_SAUDI_ARABIA

static int

LOCALE_ARABIC_TUNISIA

static int

LOCALE_ARABIC_UNITED_ARAB_EMIRATES

static int

LOCALE_ARABIC_YEMEN

static int

LOCALE_BULGARIAN_BULGARIA

static int

LOCALE_CATALAN_SPAIN

static int

LOCALE_CHINESE_HONG_KONG

static int

LOCALE_CROATIAN_CROATIA

static int

LOCALE_CZECH_CZECH_REPUBLIC

static int

LOCALE_DANISH_DENMARK

static int

LOCALE_DUTCH_NETHERLAND

static int

LOCALE_ENGLISH_UNITED_KINGDOM

static int

LOCALE_ENGLISH_UNITED_STATES

static int

LOCALE_FINNISH_FINLAND

static int

LOCALE_FRENCH_FRANCE

static int

LOCALE_GERMAN_GERMANY

static int

LOCALE_GREEK_GREECE

static int

LOCALE_HEBREW_ISRAEL

static int

LOCALE_HUNGARIAN_HUNGARY

static int

LOCALE_ITALIAN_ITALY

static int

LOCALE_JAPANESE_JAPAN

static int

LOCALE_KOREAN_KOREA

static int

LOCALE_NORWEGIAN_NORWAY

static int

LOCALE_POLISH_POLAND

static int

LOCALE_PORTUGUESE_BRAZIL

static int

LOCALE_PORTUGUESE_PORTUGAL

static int

LOCALE_ROMANIAN_ROMANIA

static int

LOCALE_RUSSIAN_RUSSIA

static int

LOCALE_SERBIAN_REPUBLIC_OF_MONTENEGRO

static int

LOCALE_SERBIAN_REPUBLIC_OF_SERBIA

static int

LOCALE_SIMPLIFIED_CHINESE_CHINA

static int

LOCALE_SLOVAK_SLOVAKIA

static int

LOCALE_SLOVENIAN_SLOVENIA

static int

LOCALE_SPANISH_SPAIN

static int

LOCALE_SWEDISH_SWEDEN

static int

LOCALE_THAI_THAILAND

static int

LOCALE_TRADITIONAL_CHINESE_CHINA


Methods

None

Related Documentation

See Constant Field Values.

CiscoMediaConnectionMode

The CiscoMediaConnectionMode interface lists all of the media connection modes.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Declaration

public interface CiscoMediaConnectionMode

Fields

Table 6-100 Fields in CiscoMediaConnectionMode

Interface
Field
Description

static int

NONE

There is no active transmit or receive channel.

static int

RECEIVE_ONLY

Only the receive channel is active.

static int

TRANSMIT_AND_RECEIVE

Both the transmit and the receive channels are active.

static int

TRANSMIT_ONLY

Only the transmit channel is active.


Methods

None

Related Documentation

See Constant Field Values.

CiscoMediaEncryptionAlgorithmType

The CiscoMediaEncryptionAlgorithmType interface indicates the SRTP algorithm type used for encryption. This interface lists all of the security indicator values that an application can get in CiscoRTPInputKeyEv and CiscoRTPOutputKeyEv. If an application is terminating its own media on CTIPorts and Media Terminated RPs, only one of the following algorithms needs to be provided in the register API.

Interface History

Cisco Unified Communications Manager Release
Description

3.x

Added the extension.


Superinterfaces

public interface CiscoMediaEncryptionAlgorithmType

Fields

Table 6-101 CiscoMediaEncryptionAlgorithmType Fields

Inteface
Field
Description

static int

AES_128_COUNTER

The algorithm used is based on Advanced Encryption Standard (AES), which is a computer security standard. The cryptography scheme is a symmetric block cipher that encrypts and decrypts 128-bit blocks of data.


Related Documentation

See Constant Field Values for additional information.

CiscoMediaEncryptionKeyInfo

The CiscoMediaEncryptionKeyInfo interface lets applications get information about SRTP keys.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Declaration

public interface CiscoMediaEncryptionKeyInfo

Fields

None

Methods

Table 6-102 Methods in CiscoMediaEncryptionKeyInfo

Interface
Method
Description

int

getAlgorithmID()

Returns the media encryption algorithm ID for the current stream.

int

getIsMKIPresent()

Indicates whether MKI is present.

byte[]

getKey()

Returns the master key for the stream.

int

getKeyLength()

Returns the keyLength of the key.

byte[]

getSalt()

Returns the salt key for the stream.

int

getSaltLength()

Returns the saltLength of the salt.

int

keyDerivationRate()

Indicates the SRTP key derivation rate for this session.


Related Documentation

See CiscoRTPInputKeyEv, CiscoRTPOutputKeyEv.

CiscoMediaOpenIPPortEv

CiscoMediaOpenIPPortEv event is delivered only if the terminal is registered with registration type as CiscoBaseTerminal.DYNAMIC_MEDIA_REGISTRATION_FOR_GET_PORT_SUPPORT or CiscoBaseTerminal.STATIC_MEDIA_REGISTRATION_FOR_GET_PORT_SUPPORT.

Interface History

Cisco Unified Communications Manager Release Number
Description

8.5(1)

New interface.


Sample Code

public class MyTermObserver implements implements TerminalObserver, 
CallControlTerminalObserver, AgentTerminalObserver, PhoneTerminalObserver {
 
   
  public void termChangedEvent (TermEv[] evlist) {
        for(int i=0; evlist != null && i < evlist.length; i++){
	...
	...
	If ( evlisth[i] instanceof  CiscoMediaOpenIPPortEv){
		CiscoMediaOpenIPPortEv ev = (CiscoMediaOpenIPPortEv)evlist[i];
if(((CiscoBaseMediaTerminal)(ev.getTerminal()))).getRegistrationType== 
CiscoTerminal.DYNAMIC_MEDIA_REGISTRATION_FOR_GET_PORT_SUPPORT){
				System.out.println("Set RTP parameters");
				System.out.println("open the port");
			} else {
				System.out.println("Open port");
			}
			
			
 
   
	}
        }
        ...
        ...
}

Declaration

public interface CiscoMediaOpenIPPortEv

Superinterfaces

NA

Fields

NA

Inherited Fields

NA

Methods

Table 6-103 Methods in CiscoMediaOpenIPPortEv

Interface
Method

int

getMediaIPAddressingMode()

CiscoRTPHandle

getCiscoRTPHandle()


Inherited Methods

NA

CiscoMediaOpenLogicalChannelEv

The system sends a CiscoMediaOpenLogicalChannelEv event each time that media gets established for a dynamically registered CiscoMediaTerminal or CiscoRouteTerminal. Upon receiving this event, applications must invoke setRTPParams on CiscoMediaTerminal or CiscoRouteTerminal and pass in the IP address and port number where they want to terminate the media, along with the rtpHandle that this event delivers.

Applications can get a call reference by using CiscoProvider.getCall(CiscoRTPHandle). Applications must be aware that the far end and local end may not be able to invoke features unless the setRTPParams method is invoked. If applications fail to respond to this event within the specified time, the call may get disconnected.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.0(1)

Added the getAddressingModeForMedia() method.

8.5(1)

Added the isRTPRequired() method.


Sample Code

public class MyTermObserver implements implements TerminalObserver, 
CallControlTerminalObserver, AgentTerminalObserver, PhoneTerminalObserver {
 
   
  public void termChangedEvent (TermEv[] evlist) {
        for(int i=0; evlist != null && i < evlist.length; i++){
	...
	...
	If ( evlisth[i] instanceof  CiscoMediaOpenLogicalChannelEv){
		CiscoMediaOpenLogicalChannelEv ev = (CiscoMediaOpenLogicalChannelEv)evlist[i];
if(ev.isRTPRequired()){
				System.out.println("Set RTP parameters");
			} else {
				System.out.println("Do not set RTP parameters");
			}
			
			
 
   
	}
        }
        ...
        ...
  }
 
   

Superinterfaces

CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEv

Declaration

public interface CiscoMediaOpenLogicalChannelEv extends CiscoTermEv

Fields

Table 6-104 Fields in CiscoMediaOpenLogicalChannelEv

Interface
Field

static int

ID


Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-105 Methods in CiscoMediaOpenLogicalChannelEv

Interface
Method
Description

int

getAddressingModeForMedia()

Returns int Application and could get following value for required IP Addressing Mode:

CiscoTerminal.IP_ADDRESSING_IPv4—Means application needs to provide IPv4 format for the IP Address in setRTPParams request.

CiscoTerminal.IP_ADDRESSING_IPv6: Means application need to provide IPv6 format IP Address in set RTP Params request.

CiscoRTPHandle

getCiscoRTPHandle()

Returns CiscoRTPHandle object. Applications should pass this handle along with RTPParameters to CiscoMediaTerminal or CiscoRouteTerminal. Applications can get call reference using CiscoProvider.getCall If there is no callobserver or there was no callobserver when this event is delivered, then CiscoProvider.getCall may return null

int

getMediaConnectionMode()

Returns a CiscoMediaConnectionMode. Applications could get one of the following values:

CiscoMediaConnectionMode.RECEIVE_ONLY— Means one-way media receive only.

CiscoMediaConnectionMode.TRANSMIT_AND_
RECEIVE—Means two-way media.

Applications should never see a value of NONE; however, if that happens, applications should ignore the event and log an error.

int

getPacketSize()

Returns the packet size of the far end, in milliseconds.

getPacketSize

int

getPayLoadType()

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

CiscoRTPPayload.NONSTANDARD

CiscoRTPPayload.G711ALAW64K

CiscoRTPPayload.G711ALAW56K

CiscoRTPPayload.G711ULAW64K

CiscoRTPPayload.G711ULAW56K

CiscoRTPPayload.G722_64K

CiscoRTPPayload.G722_56K

CiscoRTPPayload.G722_48K

CiscoRTPPayload.G7231

CiscoRTPPayload.G728

CiscoRTPPayload.G729

CiscoRTPPayload.G729ANNEXA

CiscoRTPPayload.IS11172AUDIOCAP

CiscoRTPPayload.IS13818AUDIOCAP

CiscoRTPPayload.ACY_G729AASSN

CiscoRTPPayload.DATA64

CiscoRTPPayload.DATA56

CiscoRTPPayload.GSM

CiscoRTPPayload.ACTIVEVOICE

boolean

isRTPRequired()

Indicates if the application must set the RTP parameters upon receiving this event.


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.TermEv

getTerminal

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values and CiscoRTPParams

CiscoMediaSecurityIndicator

CiscoMediaSecurityIndicator gets sent in CiscoRTPInputKeyEv, CiscoRTPOutputKeyEv, and CiscoSnapShotRTPEv. It shows the call security status.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Declaration

public interface CiscoMediaSecurityIndicator

Fields

Table 6-106 Fields in CiscoMediaSecurityIndicator

Interface
Field
Description

static int

MEDIA_ENCRYPT_KEYS_AVAILABLE

Terminates the media in secure mode, and keys are available.

static int

MEDIA_ENCRYPT_KEYS_UNAVAILABLE

Terminates the media in secure mode, but keys are not available because SRTP is not enabled in Cisco Unified Communications Manager Administration.

static int

MEDIA_ENCRYPT_USER_NOT_AUTHORIZED

Terminates the media in secure mode, but keys are not available because the user is not authorized to get the keys.

static int

MEDIA_NOT_ENCRYPTED

The media is not encrypted for this call.


Related Documentation

See Constant Field Values.

CiscoMediaTerminal

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 wants to terminate 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 first adds an observer that implements the CiscoTerminalObserver interface using the Terminal.addObserver method. Finally, the application registers the IP address and port number to which incoming RTP streams for the terminal should be directed, by using the CiscoMediaTerminal.register method.

To supply an IP address and port number dynamically on a per-call basis, applications must register by only providing the capabilities that they support. Applications must react to the CiscoMediaOpenLogicalChannelEv that gets sent whenever media gets established. Applications registering with this type must be aware that, when this event is received, the far end and the local end may not be able to perform any feature operation unless media is established. If applications fail to respond to this event within the specified time, the call may get dropped.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1x

Support added for IPv6.


Superinterfaces

CiscoObjectContainer, CiscoTerminal, javax.telephony.Terminal

Declaration

public interface CiscoMediaTerminal extends CiscoTerminal

Fields

None

Inherited Fields

From Interface com.cisco.jtapi.extensions.CiscoTerminal

ASCII_ENCODING, DEVICESTATE_ACTIVE, DEVICESTATE_ALERTING, DEVICESTATE_HELD, DEVICESTATE_IDLE, DEVICESTATE_UNKNOWN, DEVICESTATE_WHISPER, DND_OPTION_CALL_REJECT, DND_OPTION_NONE, DND_OPTION_RINGER_OFF, IN_SERVICE, IP_ADDRESSING_MODE_IPV4, IP_ADDRESSING_MODE_IPV4_V6, IP_ADDRESSING_MODE_IPV6, IP_ADDRESSING_MODE_UNKNOWN, IP_ADDRESSING_MODE_UNKNOWN_ANATRED, NOT_APPLICABLE, OUT_OF_SERVICE, UCS2UNICODE_ENCODING, UNKNOWN_ENCODING

Methods

Table 6-107 Methods in CiscoMediaTerminal

Interface
Method
Description

void

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

This method registers the MediaTerminal and returns successfully when the MediaTerminal is registered.

The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state.

This method has three arguments:

The first argument specifies the internet address at which the RTP media stream for this Terminal will terminate.

The second indicates the UDP port at which RTP packets will be directed.

The final argument indicates the type of RTP encodings that the application is willing to support for this Terminal.

Parameters

address—The internet address at which inbound IPv4 RTP streams on this terminal will terminate

port—The UDP port for inbound RTP streams on this terminal

capabilities—The list of the types of RTP encodings that the application supports for this terminal.

Throws

CiscoRegistrationException


Table 6-108

Interface
Method
Description

void

register(java.net.InetAddress address, int port)

Deprecated

Registers a Terminal with the specified address and port, defaulting to G.711 64 kHz u-law encoding with a thirty-millisecond packet size.

Parameters

address—The internet address for inbound IPv4 RTP streams on this terminal

port—The UDP port for inbound RTP streams on this terminal

Throws

CiscoRegistrationException

void

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

This method registers the MediaTerminal. Ensure that the CiscoMediaTerminal is in the CiscoTerminal.UNREGISTERED state and its Provider is in the Provider.IN_SERVICE state.

This method returns successfully when the MediaTerminal gets registered. This method requires that the application have a TLS link established with CTIManager and have the SRTP Enabled flag enabled in Cisco Unified Communications Manager Administration for the user; otherwise, the system throws a PrivilegeViolationException.

Parameters

address—The internet address for inbound IPv4 RTP streams on this terminal

port—The UDP port for inbound RTP streams on this terminal

capabilities—The list of RTP encodings that this terminal supports

algorithmIDs—The SRTP algorithms that this CTIPort supports. AlgorithmIDs must be one of CiscoMediaEncryptionAlgorithmType.

Throws

CiscoRegistrationException javax.telephony.PrivilegeViolationException

void

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

The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state.

The successful effect of this method is to register the MediaTerminal. The activeAddressingMode indicates the application IP addressing capabilities. If application specifies activeAddressingMode as CiscoTerminal.IP_ADDRESSING_MODE_IPv4, then it must also specify address.

If application specifies activeAddressingMode as CiscoTerminal.IP_ADDRESSING_MODE_IPv6, then it must also specify address_v6.

If application specifies activeAddressingMode as CiscoTerminal.IP_ADDRESSING_MODE_IPv4_6, then it must also specify address and address_v6.

Method Arguments

This method has four arguments:

The first argument specifies the internet address at which the RTP media stream for this Terminal will be terminated.

The second indicates the UDP port at which RTP packets will be directed.

The third argument indicates the type of RTP encodings that the application is willing to support for this Terminal

The final argument indicates SRTP algorithm that application supports.

This method can be used only if application has TLS link established with CTIManager and if application has SRTP Enabled flag enabled in CM Admin pages for the user, otherwise PrivilegeViolationException is thrown.

Method Post-Conditions

This method returns successfully when the MediaTerminal is registered.

   

Parameters

address—The internet address for inbound IPv4 RTP streams on this terminal, it can be null depending on application Addressing Mode.

port—The UDP port for inbound RTP streams on this terminal

capabilities—The list of RTP encodings supported by this terminal

algorithmIDs—Indicates SRTP algorithms that this CTIPort supports. AlgorithmIDs may only be one of CiscoMediaEncryptionAlgorithmType

address_v6—The IPv6 internet address for inbound IPv6 RTP streams on this terminal, it can be null depending upon activeAddressingMode

activeAddressingMode—IP Addressing mode in which application intends to register this CiscoMediaTerminal. It can be:

CiscoTerminal.IP_ADDRESSING_MODE_IPv4

CiscoTerminal.IP_ADDRESSING_MODE_IPv6

CiscoTerminal.IP_ADDRESSING_MODE_IPv4z_v6 Since: 7.0

Throws

CiscoRegistrationException, javax.telephony.PrivilegeViolationException

void

register(CiscoMediaCapability[] capabilities)

This method registers the MediaTerminal with the specified CiscoMediaCapabilities. Applications should use this method when they want to supply the IP address and port dynamically for each call.

Applications that register with this method will receive a CiscoMediaOpenLogicalChannelEv for each call and must supply an IP address and port number by using the setRTPParams method on this object.

Ensure the CiscoMediaTerminal is in the CiscoTerminal.UNREGISTERED state and its Provider is in the Provider.IN_SERVICE state.

Method Arguments

Arguments indicate the type of RTP encodings that the application is willing to support for this Terminal.

Method Post-Conditions

This method returns successfully when the CiscoMediaTerminal is registered.

Parameters

capabilities—The list of RTP encodings that this terminal supports.

Throws

CiscoRegistrationException

void

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

This method registers a MediaTerminal with the specified CiscoMediaCapabilities and supported SRTP algorithms.

Applications should use this method when they want to supply the IP address and port dynamically for each call and also want to specify the SRTP algorithm.

Applications that register with this method will receive a CiscoMediaOpenLogicalChannelEv for each call and must supply the IP address and port number by using the setRTPParams method on this object.

This form of register() also requires a second parameter that indicates which SRTP algorithm that the application supports.

This method requires that the application have a TLS link established with CTIManager and have the SRTP Enabled flag enabled in Cisco Unified Communications Manager Administration for the user; otherwise, the system throws a PrivilegeViolationException.

This method returns successfully when the CiscoMediaTerminal gets registered.

Ensure the CiscoMediaTerminal is in the CiscoTerminal.UNREGISTERED state and its Provider is in the Provider.IN_SERVICE state.

Parameters

capabilities—The list of RTP encodings that this terminal supports

algorithmIDs—The list of SRTP algorithms that this terminal supports. AlgorithmIDs must be one of CiscoMediaEncryptionAlgorithmType.

Throws

CiscoRegistrationException javax.telephony.PrivilegeViolationException

void

register(CiscoMediaCapability[] capabilities, int[] algorithmIDs, int activeAddressingMode)

The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to register the MediaTerminal. It registers a Terminal with specified CiscoMediaCapabilities and supported SRTP algorithms. It also indicates that application is interested in supplying ipAddress and port dynamically for each call.

Applications registering with this method receive CiscoMediaOpenLogicalChannelEv for each call and have to supply ipAddress and port number using setRTPParams method on this object.

The second parameter indicates SRTP algorithm that application supports. This method can be used only if application has TLS link established with CTIManager and if application has SRTP Enabled flag enabled in Cisco Unified Communications Manager Administration for the user, otherwise PrivilegeViolationException is thrown.

Method Arguments

Arguments indicate the type of RTP encodings that the application is willing to support for this Terminal and the application or CTIManager failure persistence delay.

Method Post-Conditions

This method returns successfully when the CiscoMediaTerminal is registered.

Parameters

capabilities—The list of RTP encodings supported by this terminal

algorithmIDs—Indicates the list of SRTP algorithms supported by this terminal. AlgorithmIDs may only be one of CiscoMediaEncryptionAlgorithmType

activeAddressingMode—Is the IP Addressing mode in which application intends to register this CiscoMediaTerminal. The activeAddressingMode can be:

CiscoTerminal.IP_ADDRESSING_MODE_IPv4

CiscoTerminal.IP_ADDRESSING_MODE_IPv6

CiscoTerminal.IP_ADDRESSING_MODE_IPv4_
v6

Throws

CiscoRegistrationException javax.telephony.PrivilegeViolationException

void

setRTPParams(CiscoRTPHandle rtpHandle, CiscoRTPParams rtpParams)

Applications must use this method when they want to set the IP address and RTP port number to dynamically stream media for a call. In this situation, the application will have registered the MediaTerminal or CiscoRouteTeminal by providing only capabilities.

Applications must invoke this method upon receiving the CiscoCallOpenLogicalChannel on terminalObserver. Applications must pass in the rtpHandle that they receive in CiscoCallOpenLogicalChannelEv. Applications can get a CiscoCall reference by calling the CiscoProvider.getRTPHandle(rtpHandle) method.

This method may return null if no call observer is added on the terminal, or there was no callobserver at the time when this event got sent sent, or or there is no call associated with this handle.

Parameters

rtpHandle—is obtained from. CiscoMediaCallOpenLogicalChannelEv

rtpParams—is of type CiscoRTPParams, which is used to specify the dynamic RTP address and port number for a media terminal on a per-call basis.

Throws

javax.telephony.InvalidStateException javax.telephony.InvalidArgumentException javax.telephony.PrivilegeViolationException

void

unregister()

This method unregisters the MediaTerminal and returns successfully when the MediaTerminal gets unregistered. The CiscoMediaTerminal must be registered and its Provider must be in the Provider.IN_SERVICE state.

Throws

CiscoUnregistrationException

boolean

isRegistered()

This method returns true if the CiscoMediaTerminal is registered and false otherwise. For a MediaTerminal, this method returns true if the MediaTerminal is InService and false if it is OutOfService. For CTIManager failure cases, this method returns false.

boolean

isRegisteredByThisApp()

This method returns true if this application issued a successful registration request. The registration remains valid even if the device is out-of-service because of a CTIManager failure. This will get set to true until this application unregisters the device.

int

getIPAddressingMode()

An application can invoke this API to query the IP Addressing Mode of the CiscoMediaTerminal Addressing mode may be any of the following constants:

CiscoTerminal.IP_ADDRESSING_IPv4

CiscoTerminal.IP_ADDRESSING_IPv6

CiscoTerminal.IP_ADDRESSING_IPv4_v6


Inherited Methods

From Interface com.cisco.jtapi.extensions.CiscoTerminal

createSnapshot, getAltScript, getDeviceState, getDNDOption, getDNDStatus, getEMLoginUsername, getFilter, getLocale, getProtocol, getRegistrationState, getRTPInputProperties, getRTPOutputProperties, getState, getSupportedEncoding, isRestricted, sendData, sendData, setDNDStatus, setFilter, unPark

From Interface javax.telephony.Terminal

addCallObserver, addObserver, getAddresses, getCallObservers, getCapabilities, getName, getObservers, getProvider, getTerminalCapabilities, getTerminalConnections, removeCallObserver, removeObserver

From Interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Related Documentation

See CiscoTerminal and CiscoMediaOpenLogicalChannelEv.CiscoRTPParams

CiscoMonitorInitiatorInfo

This interface defines provides information about the monitor initiator.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Declaration

public interface CiscoMonitorInitiatorInfo

Fields

None

Methods

Table 6-109 Methods in CiscoMonitorInitiatorInfo

Interface
Method
Description

CiscoAddress

getAddress()

Returns the monitor initiator address.

Int

getMonitorInitiatorCallLegHandle()

Returns the call leg hanlde at the monitor initiator. JTAPI gets the call at the monitor target by using provider.getCall
(int monitorInitiatorCallLegHandle).

This method returns null if the call at the monitor initiator is not active in this provider.

java.lang.String

getTerminalName()

Returns the terminal name of the monitor initiator.


Related Documentation

None

CiscoMonitorTargetInfo

This interface provides information about the monitor target.

Declaration

public interface CiscoMonitorTargetInfo

Fields

None

Methods

Table 6-110 Methods in CiscoMonitorTargetInfo

Interface
Method
Description

CiscoAddress

getAddress()

Returns the monitor target address.

Int

getMonitorTargetCallLegHandle()

Returns the call leg handle at the monitor target.

java.lang.String

getTerminalName()

Returns the terminal name of monitor target.


Related Documentation

None

CiscoObjectContainer

The ApplicationObject interface allows applications to associate an application-defined object to objects that implement this interface.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Subinterfaces

CiscoAddress, CiscoCall, CiscoCallID, CiscoConnection, CiscoConnectionID, CiscoConsultCall, CiscoIntercomAddress, CiscoJtapiPeer, CiscoMediaTerminal, CiscoProvider, CiscoRouteTerminal, CiscoTerminal, CiscoTerminalConnection

Declaration

public interface CiscoObjectContainer

Fields

None

Methods

Table 6-111 Methods in CiscoObjectContainer

Interface
Method
Description

java.lang.Object

getObject()

Gets the application-defined object.

java.lang.Object

setObject(java.lang.Object reference)

Sets an application-defined object.


Related Documentation

None

CiscoOutOfServiceEv

The CiscoOutOfServiceEv event is the super class for the out-of-service events CiscoAddrOutOfServiceEv and CiscoTermOutOfServiceEv. This class defines the causes for out-of-service events.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Superinterfaces

CiscoEv, javax.telephony.events.Ev

Subinterfaces

CiscoAddrOutOfServiceEv, CiscoTermOutOfServiceEv

Declaration

public interface CiscoOutOfServiceEv extends CiscoEv

Fields

Table 6-112 Fields in CiscoOutOfServiceEv 

Interface
Field
Description

static int

CAUSE_CALLMANAGER_FAILURE

The cause for this event is due a Cisco Unified Communications Manager failure.

static int

CAUSE_CTIMANAGER_FAILURE

The cause for this event is due to a failure from CTIManager.

static int

CAUSE_DEVICE_FAILURE

The cause for this event is a device failure.

static int

CAUSE_DEVICE_RESTRICTED

The cause for this event is that the device is restricted.

static int

CAUSE_DEVICE_UNREGISTERED

The cause for this event is that the device is in an unregistered state.

static int

CAUSE_LINE_RESTRICTED

The cause for this event is that the line is restricted.

static int

CAUSE_NOCALLMANAGER_AVAILABLE

The cause for this event is the unavailability of any Cisco Unified Communications Manager.

static int

CAUSE_REHOME_TO_HIGHER_PRIORITY_CM

The cause for this event is an to error in failback to a higher-priority Cisco Unified Communications Manager node.

static int

CAUSE_REHOMING_FAILURE

The cause for this event is a failure while attempting to rehome.

static int

ID


Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Methods

None

Related Documentation

See Constant Field Values

CiscoPartyInfo

This interface defines the party info of the call.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Declaration

public interface CiscoPartyInfo

Fields

Table 6-113 Fields in CiscoPartyInfo 

Interface
Field
Description

Static int

ABBREVIATED_NUMBER

This NumberType is same as 4; it represents caller is from same Cisco Unified Communications Manager server.

Static int

INTERNATIONAL_NUMBER

This NumberType is same as 0; it represents nothing is configured

Static int

NATIONAL_NUMBER

This NumberType is same as 1; it represents caller is INTERNATIONAL

Static int

NET_SPECIFIC_NUMBER

This NumberType is same as 2; it represents caller is NATIONAL

Static int

RESERVED_FOR_EXTENSION

This NumberType is same as 6; it represents its a fast dial call - not being used currently

Static int

SUBSCRIBER_NUMBER

This NumberType is same as 3; it represents call is from MGCP/H.323 gateway

Static int

UNKNOWN_NUMBER


Methods

Table 6-114 Methods in CiscoPartyInfo 

Interface
Method
Description

javax.telephony.Address

getAddress()

Returns the address.

boolean

getAddressPI()

Returns Presentation Indicator (PI) associated with Address. If it returns true, Application can display this Address name to end users. If it returns false, Applications should not display this Address name to end user.

java.lang.String

getDisplayName()

Returns display name of the party.

boolean

getDisplayNamePI()

Returns the PI associated with DisplayName. If it returns true, Application can display this DisplayName to end users. If it returns false, Applications should not display this DisplayName to end user.

int

getlocale()

Returns the locale of the party unicode display name.

int

getNumberType()

Returns number type of the party.

java.lang.String

getUnicodeDisplayName()

Returns unicode display name of the party.

CiscoUrlInfo

getUrlInfo()

Returns URL Info.

java.lang.String

getVoiceMailbox()

Returns voice mail box of the party.


Related Documentation

See Constant Field Values.

CiscoPickupGroup

CiscoPickupGroup is a new interface that represents a Pickup Group at the JTAPI layer. Currently, all a PickupGroup is a pair of String objects representing the Pickup Group's DN, and the Pickup Group's Partition.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.

8.0(1)

Following APIs are added:

getPickupGroupDN()

getPickupGroupPartition()


Declaration

public interface CiscoPickupGroup

Methods

Table 6-115 Methods in CiscoPickup Group

Interface
Method
Description

String

getPickupGroupDN()

Returns a String object that represents the number of the Pickup Group.

String

getPickupGroupPartition()

Returns a String object that represents the partition of the Pickup Group. It returns an empty String object if this pickup group does not belong to a partition.


Related Documentation

None

CiscoProvCallParkEv

CiscoProvCallParkEv event is delivered to providerobserver when a call is parked/unparked from any device in the cluster. To receive this event application should register using CiscoProvider.registerFeature() and CiscoProvFeatureID.MONITOR_CALLPARK_DN. User profile used by the application should have the Call Park Retrieval Allowed flag enabled to receive this event.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.


Superinterfaces

CiscoEv, CiscoProvEv, CiscoProvFeatureEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Declaration

public interface CiscoProvCallParkEv extends CiscoProvFeatureEv

Fields

Table 6-116 Fields in CiscoProvCallParkEv 

Interface
Field
Description

Static int

ID

Static int

PARK_STATE_ACTIVE

Indicates that a call is parked.

static int

PARK_STATE_IDLE

Indicates that a call is unparked.

static int

REASON_CALLPARK

Indicates that this event is due to call park.

static int

REASON_CALLPARKREMAINDER

Deprecated

This interface is deprecated due to a spelling error. Use the new interface REASON_CALLPARKREMINDER.

static int

REASON_CALLPARKREMINDER

Indicates that the call is offered back to the parking party after call park reminder.

static int

REASON_CALLUNPARK

Indicates that the call is unparked.


Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Table 6-117 Methods in CiscoProvCallParkEv 

Interface
Method
Description

int

getintCallIDValue()

Returns an integer representation of this object.

java.lang.String

getParkDN()

Returns where the call is parked.

java.lang.String

getParkedParty()

Returns the DN of the parked party.

java.lang.String

getParkedPartyPartition()

Returns the partition of the Parked Party.

java.lang.String

getParkingParty()

Returns the DN of the parking party.

java.lang.String

getParkingPartyPartition()

Returns the partition of the Parking party.

java.lang.String

getParkPartyPartition()

Returns the partition of park DN.

int

getReason()

Returns the reason of the event.

int

getState()

Returns the state of the call. Possible states are CiscoProvCallParkEv.PARK_STATE_IDLE CiscoProvCallParkEv.PARK_STATE_ACTIVE.


Inherited Methods

From Interface com.cisco.jtapi.extensions.CiscoProvFeatureEv

getFeatureID

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface javax.telephony.events.ProvEv

getProvider

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Related Documentation

See Constant Field Values.

CiscoProvEv

The CiscoProvEv interface, which extends JTAPI's core javax.telephony.events.ProvEv interface, serves as the base interface for all Cisco-extended JTAPI Provider events. Every Provider-related event in this package extends this interface, directly or indirectly.

Interface History

Cisco Unified Communications Manager Release Number
Description

7.1(1 and 2)

Created history table to track changes.

8.0(1)

Added new API getCiscoCause() which returns the CiscoCause for delivering the provider events.


Superinterfaces

CiscoEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Subinterfaces

CiscoAddrActivatedEv, CiscoAddrActivatedOnTerminalEv, CiscoAddrAddedToTerminalEv, CiscoAddrCreatedEv, CiscoAddrRemovedEv, CiscoAddrRemovedFromTerminalEv, CiscoAddrRestrictedEv, CiscoAddrRestrictedOnTerminalEv, CiscoProvCallParkEv, CiscoProvFeatureEv, CiscoProvTerminalCapabilityChangedEv, CiscoRestrictedEv, CiscoTermActivatedEv, CiscoTermCreatedEv, CiscoTermRemovedEv, CiscoTermRestrictedEv

Declaration

public interface CiscoProvEv extends CiscoEv, javax.telephony.events.ProvEv

Fields

None

Inherited Fields

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

From Interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Methods

Interface
Method
Description

int

getCiscoCause ()

This method returns the cause to let application know why the event has been delivered.

Static final int

CiscoProvEv.CAUSE_NORMAL

This indicates the cause for non - EM login/logout scenarios. It will have an integer value of 0.

Static final int

CiscoProvEv.CAUSE_EM_LOGIN

This cause indicates an EM login on a terminal with a profile that is in the application's control list and/or with a user id that matches with the user id with which application has been started. It will have an integer value of 1.

Static final int

CiscoProvEv. CAUSE_EM_LOGOUT

This cause indicates an EM logout from a terminal with the profile that is in the application's control list and/or with a user id that matches with the user id with which application has been started. It will have an integer value of 2.

Static final int

CiscoProvEv. CAUSE_EM_LOGIN_PROFILE_ADD

This cause indicates a case where profile is added to the control list when it is already logged into a terminal. It will have an integer value of 3.

Static final int

CiscoProvEv. CAUSE_EM_LOGIN_PROFILE_REMOVE

This cause indicates a case where profile is removed from the control list when it is already logged into a terminal. It will have an integer value of 4.


Inherited Methods

From Interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

From Interface j