Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(2)
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

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

CiscoAddrCreatedEv

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

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

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

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

CiscoIntercomAddress

Superinterfaces

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoJtapiException

Declaration

Fields

Inherited Fields

Methods

Inherited Methods

Related Documentation

CiscoJtapiPeer

Superinterfaces

Declaration

Fields

Methods

Inherited Methods

Related Documentation

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

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

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

CiscoProvider

Superinterfaces

Declaration

Fields

Inherited Fields

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

CiscoRecorderInfo

Declaration

Fields

Methods

Related Documentation

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

Related Documentation

CiscoTerminalConnection

Superinterfaces

Declaration

Fields

Inherited Fields

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


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, page F-1.

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, page F-1.

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, page F-1.

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, page F-1.

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, page F-1.

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 and 2)

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


Superinterfaces

javax.telephony.Address, CiscoObjectContainer

Subinterfaces

CiscoIntercomAddress

Fields

Table 6-30 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.

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

UNKNOWN

This represents an address with an unknown name.


Methods

Table 6-31 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.

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

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.

java.lang.String

getPartition()

It returns the partition associated with an Address.

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—Unified CM 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

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, page F-1 for more information.

CiscoAddressObserver

Applications implement this interface to receive CiscoAddrEv events such as CiscoAddrInServiceEv and 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.

CiscoAddrCreatedEv

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.


Fields

None

Methods

Table 6-32 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.

Void

setCiscoAddrParkStatusEvFilter
(Boolean filterValue)

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

boolean

getCiscoAddrIntercomInfo
ChangedEvFilter()

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

void

setCiscoAddrIntercomInfo
ChangedEvFilter(boolean filter value)

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

boolean

getCiscoAddrIntercomInfo
RestorationFailedEvFilter()

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

void

setCiscoAddrIntercomInfoRestorationFailedEvFilter(boolean
filter value)

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

boolean

getCiscoAddrRecordingConfig
ChangedEvFilter()

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

void

setCiscoAddrRecordingConfig
ChangedEvFilter(boolean filter value)

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


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, page F-1.

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-33 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-34 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 CiscoAddress.getInServiceAddrTerminals() and Constant Field Values, page F-1 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-35 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-36 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, page F-1 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-37 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-38 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, page F-1 and CiscoAddrEv for additional information.

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-39 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-40 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, page F-1 and CiscoAddress.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-41 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-42 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-43 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-44 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, page F-1 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-45 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-46 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, page F-1 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-47 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-48 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, page F-1 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-49 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, page F-1 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 CM, 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-50 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-51 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, page F-1 for more information.

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.


Superinterfaces

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

Subinterfaces

CiscoConsultCall

Declaration

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

Fields

Table 6-52 Fields in CiscoCall 

Interface
Field
Description

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.

Static int

FEATUREPRIORITY_EMERGENCY

Feature priority is emergency

Static int

FEATUREPRIORITY_NORMAL

Feature priority is normal

Static int

FEATUREPRIORITY_URGENT

Feature priority is urgent

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

Methods

Table 6-53 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.

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-54 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-55 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, page F-1 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-56 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-57 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-58 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, page F-1 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-59 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-60 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, page F-1 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-61 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, page F-1.

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-62 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-63 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-64 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-65 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, page F-1 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-66 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-67 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-68 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, page F-1 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-69 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_SUSPCALL