-
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 8.6(1)
-
Preface
-
Overview
-
New and Changed Information
-
Features Supported by Cisco Unified JTAPI
-
Cisco Unified JTAPI Installation
-
Hierarchy for All Cisco Unified JTAPI Packages
-
Cisco Unified JTAPI Extensions
-
Cisco Unified JTAPI Alarms and Services
-
Cisco Unified JTAPI Examples
-
Message Sequence Charts
-
Cisco Unified JTAPI Classes and Interfaces
-
Troubleshooting Cisco Unified JTAPI
-
Cisco Unified JTAPI Operations-by-Release
-
CTI Supported Devices
-
Constant Field Values
-
Caveats
-
Deprecated API
-
Index
-
Feedback
Table Of Contents
Cisco Unified JTAPI Extensions
CiscoAddrActivatedOnTerminalEv
CiscoAddrAutoAcceptStatusChangedEv
CiscoAddrIntercomInfoChangedEv
CiscoAddrIntercomInfoRestorationFailedEv
CiscoAddrRecordingConfigChangedEv
CiscoAddrRemovedFromTerminalEv
CiscoAddrRestrictedOnTerminalEv
CiscoAddrVoiceMailPilotChangedEv
CiscoCallCtlTermConnHeldReversionEv
CiscoMediaCallSecurityIndicator
CiscoCallSecurityStatusChangedEv
CiscoConnectionUniqueIDChangedEv
CiscoMediaEncryptionAlgorithmType
CiscoMediaOpenLogicalChannelEv
CiscoProvTerminalUnRegisteredEv
CiscoProviderCapabilityChangedEv
CiscoProvTerminalCapabilityChangedEv
CiscoTermConnMonitoringStartEv
CiscoTermConnMonitorInitiatorInfoEv
CiscoTermConnMonitorTargetInfoEv
CiscoTermConnRecordingTargetInfoEv
CiscoTermDeviceStateAlertingEv
ProviderPickupNotificationRegistrationClosedEv
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
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
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
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
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
Fields
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
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
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
public
CiscoG723MediaCapability(int rtpPacketFrameSize, int bitRate)
Constructs a CiscoG723MediaCapability.
Fields
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
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
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
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
CiscoG729MediaCapability(int payload, int rtpPacketFrameSize)
Constructs a CiscoG729MediaCapability.
Fields
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
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
Declaration
public class CiscoGSMMediaCapability extends CiscoMediaCapability
java.lang.Object
com.cisco.jtapi.extensions.CiscoMediaCapability
com.cisco.jtapi.extensions.CiscoGSMMediaCapability
Constructors
Fields
Table 6-10 Fields in CiscoGSMMediaCapability
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
Declaration
public class CiscoJtapiVersion extends java.lang.Object
java.lang.Object
com.cisco.jtapi.extensions.CiscoJtapiVersion
Constructors
public CiscoJtapiVersion() None
Fields
None
Methods
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
Declaration
public class CiscoMediaCapability extends java.lang.Object
java.lang.Object
com.cisco.jtapi.extensions.CiscoMediaCapability
Subclasses
CiscoG711MediaCapability, CiscoG723MediaCapability, CiscoG729MediaCapability, CiscoGSMMediaCapability, CiscoWideBandMediaCapability
Constructors
Fields
Methods
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
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
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
Declaration
public class CiscoRTPParams extends java.lang.Object
java.lang.Object
Constructors
CiscoRTPParams (java.net.InetAddress, rtpAddress, int rtpPort)
Fields
None
Methods
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
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
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
Declaration
public class CiscoWideBandMediaCapability extends CiscoMediaCapability
java.lang.Object
com.cisco.jtapi.extensions.CiscoMediaCapability
com.cisco.jtapi.extensions.CiscoWideBandMediaCapability
Constructors
Fields
Table 6-19 Fields in CiscoWideBandMedicaCapability
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
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
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
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
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
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
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
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
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.
•
•
Interface History
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
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
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
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
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
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
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
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
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
CiscoAddrMonitorTerminatedEv
When a monitor session is terminated, the Supervisor who had initiated the session will be notified with this event.
Interface History
Declaration
pubic interface CiscoAddrMonitorTerminatedEv extends CiscoAddrEv
Methods
Related Documentation
CiscoAddress
The CiscoAddress interface extends the Address interface with additional Cisco Unified Communications Manager capabilities.
Interface History
Superinterfaces
javax.telephony.Address, CiscoObjectContainer
Subinterfaces
CiscoIntercomAddress
Fields
Methods
Inherited Methods
From Interface javax.telephony.Address
addCallObserver, addObserver, getAddressCapabilities, getCallObservers, getCapabilities, getConnections, getName, getObservers, getProvider, getTerminals, removeCallObserver, removeObserver
From Interface com.cisco.jtapi.extensions.CiscoObjectContainer
getObject, setObject
Related Documentation
See Also Constant Field Values for more information.
CiscoAddressObserver
Applications implement this interface to receive CiscoAddrEv events such as CiscoAddrInServiceEv 0 CiscoAddrOutOfServiceEv when observing Addresses via the Address.addObserver method.
Interface History
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
7.1(1)
Created history table to track changes.
Superinterfaces
javax.telephony.events.AddrEv, CiscoEv, javax.telephony.events.Ev
Subinterfaces
CiscoAddrAutoAcceptStatusChangedEv, CiscoAddrInServiceEv, CiscoAddrIntercomInfoChangedEv, CiscoAddrIntercomInfoRestorationFailedEv, CiscoAddrOutOfServiceEv, CiscoAddrRecordingConfigChangedEv
Declaration
public interface CiscoAddrEv extends CiscoEv, javax.telephony.events.AddrEv
Fields
None
Inherited Fields
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods
None
Inherited Methods
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.AddrEv
getAddress
From interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See javax.telephony.events.AddrEv for more information.
CiscoAddrEvFilter
CiscoAddrEvFilter provided for applications to set filters for address events. The application can use the following APIs to enable/disable the filters to receive the event notifications on address or to check the value set of the filter. Application can enable the filter, if it wishes to receive the new event (CiscoAddrParkStatusEv), for the rest of the events the filter values are true by default.
Interface History
Fields
None
Methods
Sample Code:
CiscoAddress caddr = (CiscoAddress) provider.getAddress("2000");If ( caddr != null ){CiscoAddrEvFilter filter = caddr.getFilter();filter.setCiscoAddrVoiceMailPilotChangedEvFilter(true);caddr.addObserver(myAddrObserver);}try {JtapiPeer peer = JtapiPeerFactory.getJtapiPeer ( null );MyProviderObserver providerObserver = new MyProviderObserver ();provider = peer.getProvider ( ipaddress;login=useid;passwd=password );if ( provider != null ) {provider.addObserver ( providerObserver );provInService.waitTrue();CiscoAddrEvFilter filter;CiscoAddress addr = provider.getAddress(S1, S1p);filter.setCiscoAddrMonitoringTerminatedEvFilter(false);addr.setFilter(filter);System.out.println(" Current filter value is : "+ addr.getFilter().getCiscoAddrMonitoringTerminatedEvFilter());}Inherited Methods
None
Parameters
The set methods take a Boolean value as the parameter.
Value Range
The get methods return a Boolean value (true or false).
Related Documentation
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
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
Inherited Fields
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods
Table 6-35 Methods in CiscoAddrInService
getTerminal
CiscoTerminal getTerminal()
Returns the Terminal at which this Address is going IN_SERVICE.
Inherited Methods
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From interface javax.telephony.events.AddrEv
getAddress
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Related Documentation.getInServiceAddrTerminals() and Constant Field Values for more information.
CiscoAddrIntercomInfoChangedEv
The system sends the CiscoAddrIntercomInfoChangedEv event to the application whenever the target DN or intercom target label changes for a CiscoIntercomAddress. The system provides this event to all of the application observers that have been added to the CiscoIntercomAddress.
Interface History
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
Inherited Fields
From interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
From interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods
Table 6-37 Methods in CiscoAddrIntercomInfoChangedEv
getIntercomAddress
getIntercomAddress()
Returns the intercom address for which the information changed.
Inherited Methods
From interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From interface javax.telephony.events.AddrEv
getAddress
From interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See CiscoAddrEv and Constant Field Values for more information.
CiscoAddrIntercomInfoRestorationFailedEv
The system sends the CiscoAddrIntercomInfoRestorationFailedEv event to the application when JTAPI cannot restore the application set intercom target DN or the intercom target label for the CiscoIntercomAddress during failover or fallback. The system provides this event on the application observer for the application that set the intercom target DN or the intercom target label.
Interface History
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
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
Inherited Methods
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.AddrEv
getAddress
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Constant Field Values and CiscoAddrEv for additional information.
CiscoAddrPickupGroupChangedEv
CiscoAddrPickupGroupChangedEv is a new interface being added with Call Pickup feature development. This event is fired whenever a pickup group's information changes, and the line info gets updated. The line info will only be updated when the line is updated with the "apply config" button in the CUCM.
Interface History
Declaration
public interface CiscoAddrPickupGroupChangedEv extends CiscoProvEv
Methods
New Error Code
CTIERR_PICKUPGROUP_CHANGED
CTIERR_PICKUPGROUP_DELETED
CiscoAddrOutOfServiceEv
The CiscoAddrOutOfServiceEv event notifies applications that an Address has gone OUT_OF_SERVICE. With Shared Lines(where the same Address appears on different Terminals), applications may receive multiple CiscoAddrOutOfServiceEv events for all the Terminals. Applications can use this interface to find out the Terminal on which the Address(or Shared Line) is going OUT_OF_SERVICE.
Interface History
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
Inherited Fields
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
From Interface com.cisco.jtapi.extensions.CiscoOutOfServiceEv
CAUSE_CALLMANAGER_FAILURE, CAUSE_CTIMANAGER_FAILURE, CAUSE_DEVICE_FAILURE, CAUSE_DEVICE_RESTRICTED, CAUSE_DEVICE_UNREGISTERED, CAUSE_LINE_RESTRICTED, CAUSE_NOCALLMANAGER_AVAILABLE, CAUSE_REHOME_TO_HIGHER_PRIORITY_CM, CAUSE_REHOMING_FAILURE
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods
Table 6-42 Methods in CiscoAddrOutOfServiceEv
CiscoTerminal
getTerminal()
Returns the Terminal at which this Address is going OUT_OF_SERVICE.
Inherited Methods
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.AddrEv
getAddress
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Constant Field Values and Related Documentation.getInServiceAddrTerminals() for more information.
CiscoAddrParkStatusEv
When parking a call using the Cisco Unified IP Phone, JTAPI reports park states by using this event. It is provided to all the applications, which have address observers added on the address, which has invoked park. This event gets delivered only when park gets invoked from Cisco Unified IP Phones.
Interface History
7.1(1 and 2)
Added interface for Park Monitoring and Assisted DPark feature.
Declaration
public interface CiscoAddrParkStatusEv extends CiscoAddrEv
Fields
Inherited Fields
None
Methods
Value Ranges
The following are values of fields:
•
•
•
•
•
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
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
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
Inherited Methods
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.AddrEv
getAddress
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Constant Field Values and CiscoAddrEv for more information.
CiscoAddrRemovedEv
JTAPI sends the CiscoAddrRemovedEv event when an Address gets removed from the Provider domain.
Interface History
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
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
Inherited Methods
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.ProvEv
getProvider
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Constant Field Values for more information.
CiscoAddrRemovedFromTerminalEv
The system sends the CiscoAddrRemovedFromTerminalEv event under the following conditions:
•
•
•
Interface History
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
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
Inherited Methods
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.ProvEv
getProvider
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Also Constant Field Values for more information.
CiscoAddrRestrictedEv
If an Address is observed and the restriction status is changed to restricted, the system sends this event to the application.
Applications will see this event whenever an Address or an associated Terminal is Restricted from Cisco Unified Communications Manager Administration. For restricted lines, the Address will go OUT_OF_SERVICE and will not come back IN_SERVICE until it is activated again. If an Address is restricted, addCallObserver and addObserver will throw an exception.
For shared lines, if a few shared lines are restricted, and others are not, the system does not throw an exception but the restricted shared lines will not receive any events. If all shared lines are restricted, an exception is thrown when application try adding observers. If an Address gets restricted after observers are added, applications will see CiscoAddrOutOfServiceEv, and when the Address is activated, the Address will go IN_SERVICE.
Interface History
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
Inherited Methods
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.ProvEv
getProvider
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Also Constant Field Values for more information.
CiscoAddrRestrictedOnTerminalEv
If the user has Shared lines in the control list, and one of those lines is marked restricted on Cisco Unified Communications Manager, the system sends this event.
Interface History
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
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
Inherited Methods
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.ProvEv
getProvider
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Constant Field Values for more information.
CiscoAddrVoiceMailPilotChangedEv
This event indicates that the voice mail pilot configuration on address is changed and is delivered to address observer. Application needs to enable the corresponding filter in CiscoAddrEvFilter to receive this event.
Interface History
Sample Code:
class myAddrObserver extends CiscoAddressObserver {public synchronized void addressChangedEvent ( AddrEv [] eventList ) {if ( eventList[i] instanceof CiscoAddrVoiceMailPilotChangedEv){CiscoAddrVoiceMailPilotChangedEv ev = (CiscoAddrVoiceMailPilotChangedEv) eventList[i];Address cAddr = ev.getAddress();String newVoiceMailPilot = ev.getVoiceMailPilot();System.out.println(" New voice mail pilot for " + ev.getAddress() + " is " + newVoiceMailPilot );}}}Superinterfaces
NA
Declaration
NA
Fields
Inherited Fields
Methods
Table 6-55 Methods in CiscoAddrVoiceMailPilotChangedEv
String
getVoiceMailPilot()
This method returns the new voice mail pilot of the address.
Inherited Methods
Related Documentation
See Constant Field Values for more information.
CiscoBaseMediaTerminal
The CiscoBaseMediaTerminal interface extends the CiscoTerminal interface.
Interface History
Declaration
public interface CiscoBaseMediaTerminal extends CiscoTerminal
Superinterfaces
NA
Fields
Inherited Fields
NA
Methods
Inherited Methods
NA
Parameters
•
•
•
•
•
•
•
•
Data Types
•
•
•
•
•
•
•
Range of Values
•
CiscoTerminal.IP_ADDRESSING_MODE_IPv4 or CiscoTerminal.IP_ADDRESSING_MODE_IPv6, or CiscoTerminal.IP_ADDRESSING_MODE_IPv4_v6•
CiscoTerminal.NO_MEDIA_REGISTATION (applicable only for route points)
CiscoTerminal.DYNAMIC_MEDIA_REGISTRATION
CiscoTerminal.DYNAMIC_MEDIA_REGISTRATION_FOR_GET_PORT_SUPPORT
CiscoTerminal.STATIC_MEDIA_REGISTRATION
CiscoTerminal.STATIC_MEIDA_TERMINAL_FOR_GET_PORT_SUPPORTCiscoCall
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
Superinterfaces
javax.telephony.Call, javax.telephony.callcontrol.CallControlCall, CiscoObjectContainer
Subinterfaces
CiscoConsultCall
Declaration
public interface CiscoCall extends javax.telephony.callcontrol.CallControlCall, CiscoObjectContainer
Fields
Inherited Fields
From Interface javax.telephony.Call
ACTIVE, IDLE, INVALID
Sample Code
public class MyCallObserver implements implements CallObserver, CallControlCallObserver, MediaCallObserver {public void callChangedEvent (CallEv[] evlist) {for(int i=0; evlist != null && i < evlist.length; i++){......If ( evlisth[i] instance of TermConnActiveEv){CiscoCall thisCall =(CiscoCall) ((TermConnActiveEv) evlist[i]).getCall();int cfaStatus = thisCall.getCFWDAllKeyPressIndicator();if (cfaStatus == CiscoCall.CFWD_ALL_SET || cfaStatus == CiscoCall.CFWD_ALL_CLEAR){System.out.println("Call is created due to CallFwdAll soft key press");}else {System.out.println("Call is NOT created due to CallFwdAll soft key press");}}}......}Methods
Note
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
•
•
•
•
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.
2.
3.
4.
5.
6.
7.
8.
9.
Post-Conditions
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
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.
2.
3.
4.
Post-Conditions
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
Parameters
•
•
•
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.
2.
3.
4.
Parameters
•
•
•
•
•
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
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
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
Inherited Methods
From Interface com.cisco.jtapi.extensions.CiscoCallEv
getCiscoCause, getCiscoFeatureReason
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.CallEv
getCall
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Constant Field Values for more information.
CiscoCallConsultCancelledEv
This event notifies applications that a cancel operation has been invoked.
Interface History
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
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
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
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
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
Inherited Fields
From Interface javax.telephony.callcontrol.events.CallCtlEv
CAUSE_ALTERNATE, CAUSE_BUSY, CAUSE_CALL_BACK, CAUSE_CALL_NOT_ANSWERED, CAUSE_CALL_PICKUP, CAUSE_CONFERENCE, CAUSE_DO_NOT_DISTURB, CAUSE_PARK, CAUSE_REDIRECTED, CAUSE_REORDER_TONE, CAUSE_TRANSFER, CAUSE_TRUNKS_BUSY, CAUSE_UNHOLD
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods
None
Inherited Methods
From Interface javax.telephony.callcontrol.events.CallCtlCallEv
getCalledAddress, getCallingAddress, getCallingTerminal, getLastRedirectedAddress
From Interface javax.telephony.callcontrol.events.CallCtlEv
getCallControlCause
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.CallEv
getCall
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.TermConnEv
getTerminalConnection
From Interface javax.telephony.events.CallEv
getCall
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Constant Field Values for more information.
CiscoCallEv
The CiscoCallEv interface, which extends the JTAPI core javax.telephony.events.CallEv interface, serves as the base interface for all Cisco-extended JTAPI Call events. Every Call-related event in this package extends this interface, directly or indirectly.
Interface History
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
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
Related Documentation
See Constant Field Values and CallEv for more information.
CiscoCallFeatureCancelledEv
This event notifies applications that the cancel operation has been invoked
Interface History
7.1(2)
Created history table to track changes.
Declaration
public interface CiscoCallFeatureCancelledEv
Methods
Related Documentation
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
7.1(1)
Created history table to track changes.
Superinterfaces
CiscoObjectContainer
Declaration
Public interface CiscoCallID extends CiscoObjectContainer
Fields
None
Methods
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
7.1(1 and 2)
Created history table to track changes.
Declaration
public interface CiscoMediaCallSecurityIndicator
Fields
None
Methods
Related Documentation
See CiscoRTPParams.
CiscoCallSecurityStatusChangedEv
Applications receive CiscoCallSecurityStatusChangedEv when the overall Call security status changes.
Interface History
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
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
Inherited Methods
From Interface com.cisco.jtapi.extensions.CiscoCallEv
getCiscoCause, getCiscoFeatureReason
From Interface javax.telephony.events.Ev
getCause, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.CallEv
getCall
From Interface javax.telephony.events.Ev
getCause, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Also Constant Field Values for more information.
CiscoConferenceChain
This interface provides links to conference chain connections for the conference calls that are linked together in a conference chain. You can obtain this object from CiscoConferenceChainAddedEv and CiscoConferenceChainRemovedEv.
Interface History
7.1(1)
Created history table to track changes.
Declaration
public interface CiscoConferenceChain
Fields
None
Methods
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
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
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
Inherited Methods
From Interface com.cisco.jtapi.extensions.CiscoCallEv
getCiscoCause, getCiscoFeatureReason
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.CallEv
getCall
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Constant Field Values for more information.
CiscoConferenceChainRemovedEv
The system sends a CiscoConferenceChainRemovedEv event when a conference chain connection gets removed from a call. This event gets sent whenever a conference chain connection gets removed. This event gets reported via theCallControlCallObserver interface.
Interface History
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
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
Inherited Methods
From Interface com.cisco.jtapi.extensions.CiscoCallEv
getCiscoCause, getCiscoFeatureReason
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.CallEv
getCall
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Constant Field Values for more information.
CiscoConferenceEndEv
The CiscoConferenceEndEv event indicates that a Conference operation completed. The system reports this event via the CallControlCallObserver interface.
Interface History
7.1(1)
Created history table to track changes.
Superinterfaces
javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev
Declaration
public interface CiscoConferenceEndEv extends CiscoCallEv
Fields
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
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 Also isSuccess()
CiscoConferenceStartEv
The CiscoConferenceStartEv event indicates that a conference operation started. The CallControlCallObserver interface reports this event.
Interface History
7.1(1 and 2)
Added getControllerTerminalName() method for Join Across Lines/Connected Conference feature.
Superinterfaces
javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev
Declaration
public interface CiscoConferenceStartEv extends CiscoCallEv
Fields
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
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
CiscoConnection
The CiscoConnection interface extends the CallControlConnection interface with additional Cisco specific capabilities. Applications can use the getReason method to obtain the reason for the creation of a connection.
Interface History
All Superinterfaces
javax.telephony.callcontrol.CallControlConnection, CiscoObjectContainer, javax.telephony.Connection
Declaration
public interface CiscoConnection extends javax.telephony.callcontrol.CallControlConnection, CiscoObjectContainer
Fields
Inherited Fields
From interface javax.telephony.callcontrol.CallControlConnection
ALERTING, DIALING, DISCONNECTED, ESTABLISHED, FAILED, IDLE, INITIATED, NETWORK_ALERTING, NETWORK_REACHED, OFFERED, OFFERING, QUEUED, UNKNOWN
From interface javax.telephony.Connection
CONNECTED, INPROGRESS
Methods
Table 6-82 Methods in CiscoConnection
Boolean
getAddressPI()
Returns Presentation Indicator (PI) associated with the Address on which the connection is created.
CiscoHuntConnection
getCiscoHuntConnection()
This method returns the associated CiscoHuntConnection or null.
CiscoConnectionID
getConnectionID()
Returns CiscoConnectionID for this CiscoConnection
java.lang.String
getDParkPrefixCode()
Returns the prefix code that needs to be dialed with the DPark DN to retrieve the call.
int
getReason()
Returns the reason for the creation of this Connection. To function properly, some applications need to know the reason for the creation of the connection is created at an endpoint.
The reason for a Connection creation may be any of the following constants:
•
•
•
BUSY•
ALL•
•
javax.telephony.TerminalConnection
getRequestController()
Returns the current request Controller for the Connection.
String
getUniqueID(Terminal term)
This method returns the updated uniqueID of the connection.
In case if there are no shared lines associated with this connection, application can just pass null object as parameter to this interface to get the Unique Identifier.
Unique Identifier will be same for all the shared lines, but if it's a barge scenario, different terminals would have different identifier.The returned Unique Identifier will be 32-character hex string. Please refer to End to End Call Tracing, page A-54, for more information.
Throws
PrivilegeVoilationException, InvalidStateException
Parameters
Terminal
boolean
isChaperone()
This method returns true if the connection is associated with a Chaperone call, and false if not.
java.lang.String
park()
This method parks the call at a system park DN and returns the address of the park DN.
javax.telephony.Connection
redirect(java.lang.String destinationAddress, int mode)
This method overloads the CallControlConnection.redirect() method.
Throws
javax.telephony.InvalidStateException, javax.telephony.InvalidPartyException, javax.telephony.MethodNotSupported
Exception, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailable
ExceptionParameters
Mode - This parameter can take one of the following two values:
•
•
javax.telephony.Connection
redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace)
This method overloads the CallControlConnection.redirect() method. It takes two new parameters: redirectMode and callingSearchSpace.
The redirectMode selects which type of redirect to perform. The callingSearchSpace tells the implementation to use either the calling party search space or the redirect controller search space.
Parameters
mode—One of the following:
•
•
callingSearchSpace—One of the following:
•
SPACE•
SEARCH_SPACE•
SPACEThrows
javax.telephony.InvalidStateException, javax.telephony.InvalidPartyException, javax.telephony.MethodNotSupported
Exception, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailable
Exceptionjavax.telephony.Connection
redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace, int calledAddressOption)
This method overloads the CallControlConnection.redirect() method.
It takes three new parameters: mode, callingSearchSpace, and calledAddressOption. The redirectMode selects the type of redirect to perform. The callingSearchSpace tells the implementation to use either the calling party search space or the redirect controller search space. The calledAddressOption parameter controls whether to reset the original called fields.
Parameters
mode—One of the following:
•
•
callingSearchSpace—One of the following:
•
SPACE•
SEARCH_SPACE•
SPACEcalledAddressOption—One of the following:
•
DEFAULT•
UNCHANGED•
SET_TO_REDIRECT_DESTINATIONThrows
javax.telephony.InvalidStateException, javax.telephony.InvalidPartyException, javax.telephony.MethodNotSupported
Exception, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailable
Exceptionjavax.telephony.Connection
redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace, int calledAddressOption, java.lang.String preferredOriginalCalledParty, java.lang.String facCode, java.lang.String cmcCode)
This method overloads the CallControlConnection.redirect() method. It takes three new parameters: mode, callingSearchSpace, and calledAddressOption.
The redirectMode selects the type of redirect to perform. The callingSearchSpace tells the implementation to use either the calling party search space or the redirect controller search space. The calledAddressOption parameter controls whether to reset the original called fields.
If the FAC and CMC codes are missing or invalid, the call might not get offered and platformException may contain one of the following error codes:
•
•
•
•
•
Parameters
mode—One of the following:
•
•
callingSearchSpace—One of the following:
•
SPACE•
SEARCH_SPACE•
SPACE•
calledAddressOption—One of the following:
•
•
•
preferredOriginalCalledParty—may be a DN that will be the originalCalledParty field when call is offered to destinationAddress. If this field * needs to be used, applications must set calledAddressOption as CALLED_ADDRESS_SET_TO_
PREFERREDCALLEDPARTY. If applications are not interested in this field, you must pass the default value of null.facCode—required if the destinationAddress requires a forced authorization code to offer the call. Pass the FAC in this parameter. Pass the default value of null if the destinationAddress does not require a FAC code.
cmcCode—required if the destinationAddress requires a client matter code to offer the call. Pass the CMC in this parameter. Pass the default value of null if the destinationAddress does not require a CMC code.
javax.telephony.Connection
redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace, int calledAddressOption, java.lang.String preferredOriginalCalledParty, java.lang.String facCode, java.lang.String cmcCode, int featurePriority)
This method overloads CallControlConnection.redirect(). It takes a new parameter, featurePriority, that sets the call priority. The featurePriority parameter may be:
•
•
•
EMERGENCYReturns
Connection
Throws
javax.telephony.InvalidStateException, javax.telephony.InvalidPartyException, javax.telephony.MethodNotSupported
Exception, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailable
Exceptionjavax.telephony.Connection
redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace, java.lang.String preferredOriginalCalledParty)
This method overloads the CallControlConnection.redirect() method. It takes three new parameters: mode, callingSearchSpace, and preferredOriginalCalledParty.
The redirectMode selects the type of redirect to perform. The callingSearchSpace tells the implementation to use either the calling party search space or the redirect controller search space.
Parameters
mode—One of the following:
•
•
callingSearchSpace—One of the following:
•
•
•
preferredOriginalCalledParty—May be a DN that will be the originalCalledParty field when the call gets offered to the destinationAddress.
Throws
javax.telephony.InvalidStateException, javax.telephony.InvalidPartyException, javax.telephony.MethodNotSupported
Exception, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailable
Exceptionvoid
setRequestController(javax.telephony.TerminalConnection tc)
This interface gets provided to a requesting TerminalConnection.
com.cisco.jtapi.extensions.Cisco
PartyInfo[]getPartyInfo()
Returns a list of participants.
java.lang.void
disconnect(CiscoPartyInfoparty
Info)Disconnects participant with whose CiscoPartyInfo matches the passed parameter value; throws exception otherwise.
Throws
PrivilegeViolationException, InvalidStateException
Inherited Methods
From Interface javax.telephony.callcontrol.CallControlConnection
accept, addToAddress, getCallControlState, park, redirect, reject
From Interface javax.telephony.Connection
disconnect, getAddress, getCall, getCapabilities, getConnectionCapabilities, getState, getTerminalConnections
From Interface com.cisco.jtapi.extensions.CiscoObjectContainer
getObject, setObject
Documentation
None
CiscoConnectionID
The CiscoConnectionID object represents a unique object that is associated with each connection. Applications may use the object itself or the integer representation of the object that the intValue() method returns.
Interface History
7.1(1 and 2)
Created history table to track changes.
Superinterfaces
CiscoObjectContainer
Declaration
public interface CiscoConnectionID extends CiscoObjectContainer
Fields
None
Methods
Inherited Methods
From Interface com.cisco.jtapi.extensions.CiscoObjectContainer
getObject, setObject
Related Documentation
None
CiscoConnectionUniqueIDChangedEv
It's a new event to highlight that uniqueID of the connection has changed.
Interface History
Declaration
public interface CiscoConnectionUniqueIDChangedEv extends ConnEv
Methods
Related Documentation
CiscoConsultCall
The CiscoConsultCall interface extends the CiscoCall interface to expose certain properties of calls that have been created as part of a consultative transfer or consultative conference.
Interface History
7.1(1 and 2)
Created history table to track changes.
Superinterfaces
javax.telephony.Call, javax.telephony.callcontrol.CallControlCall, CiscoCall, CiscoObjectContainer
Declaration
public interface CiscoConsultCall extends CiscoCall
Fields
None
Inherited Fields
From Interface com.cisco.jtapi.extensions.CiscoCall
CALLSECURITY_AUTHENTICATED, CALLSECURITY_ENCRYPTED, CALLSECURITY_NOTAUTHENTICATED, CALLSECURITY_UNKNOWN, FEATUREPRIORITY_EMERGENCY, FEATUREPRIORITY_NORMAL, FEATUREPRIORITY_URGENT, PLAYTONE_BOTHLOCALANDREMOTE, PLAYTONE_LOCALONLY, PLAYTONE_NOLOCAL_OR_REMOTE, PLAYTONE_REMOTEONLY, SILENT_MONITOR
From Interface javax.telephony.CallACTIVE, IDLE, INVALID
Methods
Inherited Methods
From Interface com.cisco.jtapi.extensions.CiscoCall
conference, connect, getCalledAddressPI, getCalledPartyInfo, getCallID, getCallingAddressPI, getCallSecurityStatus, getConferenceChain, getCurrentCalledAddress, getCurrentCalledAddressPI, getCurrentCalledDisplayNamePI, getCurrentCalledPartyDisplayName, getCurrentCalledPartyInfo, getCurrentCalledPartyUnicodeDisplayName, getCurrentCalledPartyUnicodeDisplayNamelocale, getCurrentCallingAddress, getCurrentCallingAddressPI, getCurrentCallingDisplayNamePI, getCurrentCallingPartyDisplayName, getCurrentCallingPartyInfo, getCurrentCallingPartyUnicodeDisplayName, getCurrentCallingPartyUnicodeDisplayNamelocale, getGlobalizedCallingParty, getLastRedirectedPartyInfo, getLastRedirectingAddressPI, getLastRedirectingPartyInfo, getModifiedCalledAddress, getModifiedCallingAddress, startMonitor, startMonitor, transfer
From Interface javax.telephony.callcontrol.CallControlCall
addParty, conference, consult, consult, drop, getCalledAddress, getCallingAddress, getCallingTerminal, getConferenceController, getConferenceEnable, getLastRedirectedAddress, getTransferController, getTransferEnable, offHook, setConferenceController, setConferenceEnable, setTransferController, setTransferEnable, transfer, transfer
From Interface javax.telephony.Call
addObserver, connect, getCallCapabilities, getCapabilities, getConnections, getObservers, getProvider, getState, removeObserver
From Interface com.cisco.jtapi.extensions.CiscoObjectContainer
getObject, setObject
Related Documentation
See CiscoCall for more information.
CiscoConsultCallActiveEv
The CiscoConsultCallActiveEv event interface extends the JTAPI CallActiveEv event. This event indicates that the state of the call object changed to Call.ACTIVE and that the call was initiated as a result of a consultative transfer or consultative conference operation (manual or programmatic). Applications can obtain the consulting TerminalConnection on the original (consulting) call by using the CiscoConsultCall.getConsultingTerminalConnection method.
The system reports this event to applications via the CallObserver interface.
Interface History
7.1(1 and 2)
Created history table to track changes.
Superinterfaces
javax.telephony.events.CallActiveEv, javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev
Declaration
public interface CiscoConsultCallActiveEv extends CiscoCallEv, javax.telephony.events.CallActiveEv
Fields
None
Inherited Fields
From Interface com.cisco.jtapi.extensions.CiscoCallEv
CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, CAUSE_CTICCMSIP400BADREQUEST, CAUSE_CTICCMSIP401UNAUTHORIZED, CAUSE_CTICCMSIP402PAYMENTREQUIRED, CAUSE_CTICCMSIP403FORBIDDEN, CAUSE_CTICCMSIP404NOTFOUND, CAUSE_CTICCMSIP405METHODNOTALLOWED, CAUSE_CTICCMSIP406NOTACCEPTABLE, CAUSE_CTICCMSIP407PROXYAUTHENTICATIONREQUIRED, CAUSE_CTICCMSIP408REQUESTTIMEOUT, CAUSE_CTICCMSIP410GONE, CAUSE_CTICCMSIP411LENGTHREQUIRED, CAUSE_CTICCMSIP413REQUESTENTITYTOOLONG, CAUSE_CTICCMSIP414REQUESTURITOOLONG, CAUSE_CTICCMSIP415UNSUPPORTEDMEDIATYPE, CAUSE_CTICCMSIP416UNSUPPORTEDURISCHEME, CAUSE_CTICCMSIP420BADEXTENSION, CAUSE_CTICCMSIP421EXTENSTIONREQUIRED, CAUSE_CTICCMSIP423INTERVALTOOBRIEF, CAUSE_CTICCMSIP480TEMPORARILYUNAVAILABLE, CAUSE_CTICCMSIP481CALLLEGDOESNOTEXIST, CAUSE_CTICCMSIP482LOOPDETECTED, CAUSE_CTICCMSIP483TOOMANYHOOPS, CAUSE_CTICCMSIP484ADDRESSINCOMPLETE, CAUSE_CTICCMSIP485AMBIGUOUS, CAUSE_CTICCMSIP486BUSYHERE, CAUSE_CTICCMSIP487REQUESTTERMINATED, CAUSE_CTICCMSIP488NOTACCEPTABLEHERE, CAUSE_CTICCMSIP491REQUESTPENDING, CAUSE_CTICCMSIP493UNDECIPHERABLE, CAUSE_CTICCMSIP500SERVERINTERNALERROR, CAUSE_CTICCMSIP501NOTIMPLEMENTED, CAUSE_CTICCMSIP502BADGATEWAY, CAUSE_CTICCMSIP503SERVICEUNAVAILABLE, CAUSE_CTICCMSIP504SERVERTIMEOUT, CAUSE_CTICCMSIP505SIPVERSIONNOTSUPPORTED, CAUSE_CTICCMSIP513MESSAGETOOLARGE, CAUSE_CTICCMSIP600BUSYEVERYWHERE, CAUSE_CTICCMSIP603DECLINE, CAUSE_CTICCMSIP604DOESNOTEXISTANYWHERE, CAUSE_CTICCMSIP606NOTACCEPTABLE, CAUSE_CTICONFERENCEFULL, CAUSE_CTIDEVICENOTPREEMPTABLE, CAUSE_CTIDROPCONFEREE, CAUSE_CTIMANAGER_FAILURE, CAUSE_CTIPRECEDENCECALLBLOCKED, CAUSE_CTIPRECEDENCELEVELEXCEEDED, CAUSE_CTIPRECEDENCEOUTOFBANDWIDTH, CAUSE_CTIPREEMPTFORREUSE, CAUSE_CTIPREEMPTNOREUSE, CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_DPARK, CAUSE_DPARK_REMINDER, CAUSE_DPARK_UNPARK, CAUSE_EXCHANGEROUTINGERROR, CAUSE_FAC_CMC, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, CAUSE_OUTOFBANDWIDTH, CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QSIG_PR,CAUSE_QUALOFSERVNAVAIL, CAUSE_QUIET_CLEAR, CAUSE_RECOVERYONTIMEREXPIRY, CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUBSCRIBERABSENT, CAUSE_SUSPCALLBUTNOTTHISONE, CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, CAUSE_USERBUSY
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods
javax.telephony.TerminalConnection getHeldTerminalConnection() Deprecated. Replaced by CiscoConsultCall.getConsultingTerminalConnection()
Inherited Methods
From Interface com.cisco.jtapi.extensions.CiscoCallEv
getCiscoCause, getCiscoFeatureReason
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.CallEv
getCall
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.CallEv
getCall
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Call, CallObserver, CallActiveEv and Constant Field Values for more information.
CiscoEv
The CiscoEv interface extends this code JTAPI javax.telephony.events.Ev interface and serves as the base interface for all Cisco-extended JTAPI events. Every event in this package extends this interface, directly or indirectly.
Interface History
7.1(1 and 2)
Created history table to track changes.
Superinterfaces
javax.telephony.events.Ev
Subinterfaces
CiscoAddrActivatedEv, CiscoAddrActivatedOnTerminalEv, CiscoAddrAddedToTerminalEv, CiscoAddrAutoAcceptStatusChangedEv, CiscoAddrCreatedEv, CiscoAddrEv, CiscoAddrInServiceEv, CiscoAddrIntercomInfoChangedEv, CiscoAddrIntercomInfoRestorationFailedEv, CiscoAddrOutOfServiceEv, CiscoAddrRecordingConfigChangedEv, CiscoAddrRemovedEv, CiscoAddrRemovedFromTerminalEv, CiscoAddrRestrictedEv, CiscoAddrRestrictedOnTerminalEv, CiscoCallChangedEv, CiscoCallEv, CiscoCallSecurityStatusChangedEv, CiscoConferenceChainAddedEv, CiscoConferenceChainRemovedEv, CiscoConferenceEndEv, CiscoConferenceStartEv, CiscoConsultCallActiveEv, CiscoMediaOpenLogicalChannelEv, CiscoOutOfServiceEv, CiscoProvCallParkEv, CiscoProvEv, CiscoProvFeatureEv, CiscoProvTerminalCapabilityChangedEv, CiscoRestrictedEv, CiscoRTPInputKeyEv, CiscoRTPInputStartedEv, CiscoRTPInputStoppedEv, CiscoRTPOutputKeyEv, CiscoRTPOutputStartedEv, CiscoRTPOutputStoppedEv, CiscoTermActivatedEv, CiscoTermButtonPressedEv, CiscoTermCreatedEv, CiscoTermDataEv, CiscoTermDeviceStateActiveEv, CiscoTermDeviceStateAlertingEv, CiscoTermDeviceStateHeldEv, CiscoTermDeviceStateIdleEv, CiscoTermDeviceStateWhisperEv, CiscoTermDNDOptionChangedEv, CiscoTermDNDStatusChangedEv, CiscoTermEv, CiscoTermInServiceEv, CiscoTermOutOfServiceEv, CiscoTermRegistrationFailedEv, CiscoTermRemovedEv, CiscoTermRestrictedEv, CiscoTermSnapshotCompletedEv, CiscoTermSnapshotEv, CiscoToneChangedEv, CiscoTransferEndEv, CiscoTransferStartEv
Declaration
public interface CiscoEv extends javax.telephony.events.Ev
Fields
None
Inherited Fields
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods
None
Inherited Methods
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Ev for more information.
CiscoFeatureReason
The CiscoFeatureReason interface specifies the feature reason that is associated with each delivered event.
Interface History
Declaration
public interface CiscoFeatureReason
Fields
Related Documentation
See Constant Field Values for more information.
CiscoHuntConnection
A CiscoHuntConnection in a call indicates that the call is routed through a hunt pilot.
Interface History
Declaration
public interface CiscoHuntConnection extends CiscoConnection.
Methods
Table 6-88 Methods in CiscoHuntConnection
Connection[]
getAgentConnections()
This method returns an array of connections to the hunt group member or null.
Related Documentation
CiscoIntercomAddress
The CiscoIntercomAddress interface extends the CiscoAddress interface with additional Cisco Unified Communications Manager-specific capabilities for intercom addresses. This interface lets applications initiate intercom calls and take advantage of other intercom-specific features.
Interface History
7.1(1 and 2)
Created history table to track changes.
Superinterfaces
javax.telephony.Address, CiscoAddress, CiscoObjectContainer
Declaration
public interface CiscoIntercomAddress extends CiscoAddress
Fields
None
Inherited Fields
From Interface com.cisco.jtapi.extensions.CiscoAddress
APPLICATION_CONTROLLED_RECORDING, AUTO_RECORDING, AUTOACCEPT_OFF, AUTOACCEPT_ON, AUTOANSWER_OFF, AUTOANSWER_UNKNOWN, AUTOANSWER_WITHHEADSET, AUTOANSWER_WITHSPEAKERSET, EXTERNAL, EXTERNAL_UNKNOWN, IN_SERVICE, INTERNAL, MONITORING_TARGET, NO_RECORDING, OUT_OF_SERVICE, RINGER_DEFAULT, RINGER_DISABLE, RINGER_ENABLE, UNKNOWN
Methods
Inherited Methods
From Interface com.cisco.jtapi.extensions.CiscoAddress
clearCallConnections, getAddressCallInfo, getAutoAcceptStatus, getAutoAnswerStatus, getInServiceAddrTerminals, getPartition, getRecordingConfig, getRegistrationState, getRestrictedAddrTerminals, getState, getType, isRestricted, setAutoAcceptStatus, setMessageWaiting, setRingerStatus
From Interface javax.telephony.Address
addCallObserver, addObserver, getAddressCapabilities, getCallObservers, getCapabilities, getConnections, getName, getObservers, getProvider, getTerminals, removeCallObserver, removeObserver
From Interface com.cisco.jtapi.extensions.CiscoObjectContainer
getObject, setObject
Related Documentation
See CiscoAddress for additional information.
CiscoIsacMediaCapability
The CiscoIsacMediaCapability object specifies the properties for a iSAC encoded RTP stream. Applications that support iSAC media termination use this object when registering a CiscoMediaTerminal.
The packet size and bit rate are variable.
Interface History
Superinterfaces
None
Declaration
public class CiscoIsacMediaCapabilityextends CiscoMediaCapability
Constuctors
Table 6-90 Constructor in CiscoIsacMediaCapability
public
CiscoIsacMediaCapability()
Constructs a CiscoIsacMediaCapability
Fields
None
Inherited Fields
From class com.cisco.jtapi.extensions.CiscoMediaCapability
G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, GSM_80_MILLISECONDS, ISAC, WIDEBAND_256K_10_MILLISECONDS
Methods
None
Inherited Methods
Inherited from class com.cisco.jtapi.extensions.CiscoMediaCapability
getMaxFramesPerPacket, getPayloadType, isSupported, toString
Inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
CiscoJtapiException
The CiscoJtapiException interface defines error codes that CTI requests may return. Cisco JTAPI extends all of the JTAPI exceptions to implement this interface. You can get the error codes by casting the exception to CiscoJtapiException and calling the method getErrorCode().
For example, if "e" is any exception caught by an application, the following code checks whether the exception is an instance of CiscoJtapiException.
try {// some code here}catch ( Exception e ) {if( e instanceof CiscoJtapiException){CiscoJtapiException ce = com.cisco.cti.client.CTIFAILURE.(CiscoJtapiException) eint errorCode = com.cisco.cti.client.CTIFAILURE.ce.getErrorCode() //returns the ErrorCode.}}Interface History
Declaration
public interface CiscoJtapiException
Fields
Inherited Fields
None
Methods
Inherited Methods
None
Related Documentation
See Constant Field Values for more information.
CiscoMediaStreamStartedEv
Applications receive the event when they observe a device that is the target of a "addMediaStream()" invocation. This is the Agent device. This event is sent when the media begins to play on the call.
This event is only deliviered to the device that invokes the original request. Multiple observers on the same address receive the events. Shared lines of the invoking device will not receive this event.
Declaration
public interface CiscoMediaStreamStartedEv extends CiscoCallEv
Fields
None
Inherited Fields
None
Methods
None
Inherited Methods
None
CiscoMediaStreamEndedEv
Applications receive the event when they observe a device that is the target of a "addMediaStream()" invocation. This is the Agent device. This event is sent when the media has finished playing on the call. It contains a field that it exposes if the media is played successfully, or if the end event is the result of an error.
This event is only deliviered to the device that invokes the original request. Shared lines of the invoking device will not receive this event.
Declaration
public interface CiscoMediaStreamEndedEv extends CiscoCallEv
Fields
Inherited Fields
None
Methods
Inherited Methods
None
CiscoJtapiPeer
By extending the com.cisco.services.tracing.TraceModule interface, CiscoJtapiPeer exposes trace information to applications. All instances of JtapiPeer objects that the Cisco JTAPI implementation creates implement this interface. Applications that want to manipulate the trace settings of the Cisco JTAPI implementation may use the CiscoJtapiPeer.getTraceManager method to obtain its TraceManager object. Applications can then manipulate the TraceManager object as described in the com.cisco.services.tracing package.
Interface History
7.1(1 and 2)
Created history table to track changes.
8.5(1)
Added a new API getprovider().
Superinterfaces
CiscoObjectContainer, javax.telephony.JtapiPeer, TraceModule
Declaration
public interface CiscoJtapiPeer extends TraceModule, javax.telephony.JtapiPeer, CiscoObjectContainer
Fields
None
Methods
Inherited Methods
From Interface com.cisco.services.tracing.TraceModule
getTraceManager, getTraceModuleName
From Interface javax.telephony.JtapiPeer
getName, getProvider, getServices
From Interface com.cisco.jtapi.extensions.CiscoObjectContainer
getObject, setObject
Related Documentation
See CiscoJtapiProperties and TraceModule for more information.
CiscoJtapiPeerImpl
This interface has a method called "getProvider()," which is the primary way for applications to open a JTAPI provider. This method takes a "provider string," and it was enhanced to take a new argument.
Declaration
public interface CiscoJtapiPeerImpl extends ObjectContainerImpl implements CiscoJtapiPeer
Fields
Methods
CiscoJtapiProperties
Cisco Unified JTAPI behavior and functionality is tailored by many parameters which are read in from the jtapi.ini file when an instance of CiscoJtapiPeer is instantiated. These parameters are now exposed to applications for control via this CiscoJtapiproperties interface.
Applications can query the CiscoJtapiproperties properties object and change these parameters to better suit the application functionality. Exposing these properties via the CiscoJtapiproperties interface also allows applications to have a single point of administration (at the application end) for these parameters. The most visible parameters are those describing the tracing levels and tracing destinations.
Usage
JtapiPeer peer = JtapiPeerFactory.getJtapiPeer ( null );if(peer instanceof CiscoJtapiPeer) {CiscoJtapiProperties jProps = ((CiscoJtapiPeer)peer).getJtapiProperties();jProps.setTracePath("\\D:\\Traces\\WorkFlow"); jProps.setUseJavaConsoleTrace(false);MyProviderObserver providerObserver = new MyProviderObserver ();provider = peer.getProvider ( providerName ); }In the above example an application has set the Java console tracing to off and set the trace path to D:\Traces\WorkFlowApp1.When the peer is obtained an object implementing CiscoJtapiProperties is created by reading parameters set in the jtapi.ini file. If no jtapi.ini file exists in the classpath default settings are used to create this object. The parameters used by Cisco Jtapi are read in and frozen when the first getProvider () call is made.
Interface History
Declaration
public interface CiscoJtapiProperties
Fields
None
Sample Code
try {JtapiPeer peer = JtapiPeerFactory.getJtapiPeer ( null );MyProviderObserver providerObserver = new MyProviderObserver ();provider = peer.getProvider ( ipaddress;login=useid;passwd=password );if ( provider != null ) {provider.addObserver ( providerObserver );provInService.waitTrue();boolean hlenabled = ((CiscoJtapiPeer)peer).getJtapiProperties().getHuntListEnabled();System.out.Println("Initial state of HuntList = " + hlenabled);CiscoJtapiProperties cjp = ((CiscoJtapiPeer)peer).getJtapiProperties();cjp.setHuntListEnabled(true);((CiscoJtapiPeer)peer).setJtapiProperties(cjp);boolean hlenabled = ((CiscoJtapiPeer)peer).getJtapiProperties().getHuntListEnabled();System.out.Println("Final state of HuntList = " + hlenabled);}Methods
Table 6-97 Methods in CiscoJtapiProperties
void
deleteCertificates(java.lang.String username, java.lang.String instanceID, java.lang.String ccmCAPFAddress, java.lang.String certificatePath)
Deletes X.509 client certificate installed for USER Instance in certificate store.
void
deleteSecurityPropertyForInstance(java.lang.String username, java.lang.String instanceID, java.lang.String capfIp, java.lang.String certPath)
Deletes security properly from jtapi.ini file and also delete certificate previously installed for username/instanceId.
java.lang.String
getAlarmServiceHostname()
Gets the alarm service host name.
int
getAlarmServicePort()
Gets the port number for the alarm service.
boolean
getCallSecurityStatusChangedEv()
Advises the application if it would receive the event CallSecurityStatusChangedEv when applicable.
int
getCtiRequestTimeout()
Gets the timout for cti requests, other than the provider open (seconds).
java.lang.String[]
getDebuggingNames()
Get names of supported debugging level jtapi traces.
boolean
getDebuggingValue(java.lang.String debuggingName)
Get the enabled or disabled state of a debugging level trace.
int
getDesiredServerHeartbeatInterval()
Get the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds).
boolean
getDiscConnBeforeCreatingInCPIC()
Controls the event order for the scenario when only redirected party in observed by Application This interface returns True if ConnDisconnectedEv is send before ConnCreatedEv, False otherwise.
java.lang.String
getFileNameBase()
Gets the filename for individual log files.
java.lang.String
getFileNameExtension()
Gets the filename extension for log files.
Boolean
getHuntListEnabled()
Returns true if HuntList is enabled else false.
int
getJavaSocketConnectTimeout()
Returns the value of service parameter for SOCKET CONNECT TIMEOUT in seconds.
int
getNumTraceFiles()
Gets the number of trace files before rollover.
boolean
getPeriodicWakeupEnabled()
Gets the enabled state of periodic wake up.
int
getPeriodicWakeupInterval()
Gets the interval for periodic wakeup (milliseconds).
boolean
getProcessOfferingAfterNewcallevent()
Retrieves the boolean value for the jtapi.ini parameter ProcessOfferringAfterNewcallEvent'. By default this interface returns false.
int
getProviderOpenRequestTimeout()
Gets the timout for a provider open request (seconds).
int
getProviderOpenRetryAttempts()
Returns the value of service parameter for maximum number of reconnect attempts to CTI Manager.
int
getProviderRetryInterval()
Gets the interval at which the connection to the CTI Manager will ge retried (seconds).
int
getQueueSizeThreshold()
Gets the threshold for the event queue size to trigger alarms.
boolean
getQueueStatsEnabled()
Gets the enabled state of event queue stats.
int
getRouteSelectTimeout()
Gets the route select timeout (milliseconds).
java.util.Hashtable
getSecurityPropertyForInstance()
Returns a Hash table with all the parameters set for users and InstanceIDs.
See User/InstanceID Hashtable for key and value pairs.
java.util.Hashtable
getSecurityPropertyForInstance(java.lang.String user, java.lang.String instanceID)
Teturn a Hash table with all the parameters set for users and InstanceIDs.
See User/InstanceID Hashtable for key and value pairs.
java.lang.String[]
getServices()
Returns the services that this implementation supports.
java.lang.String
getSyslogCollector()
Gets the syslog collector hostname.
int
getSyslogCollectorUDPPort()
Gets the syslog collector UDP port.
java.lang.String
getTraceDirectory()
Path directory where trace files will be written.
int
getTraceFileSize()
Trace file size before rollover.
java.lang.String[]
getTraceNames()
Gets the names of supported jtapi traces.
java.lang.String
getTracePath()
Gets the path where the trace files will be located.
boolean
getTraceValue(java.lang.String traceName)
Gets the enabled or disabled state of a trace.
boolean
getUpdateJtapiCalledWithOriginalCalled()
Queries the parameter setting that changes Jtapi behavior on updating called address.
boolean
getUseAlarmService()
gets the enabled/disabled state of the alarm service.
boolean
getUseFileTrace()
Gets the enabled or disabled state of jtapi log file tracing.
boolean
getUseJavaConsoleTrace()
Gets the enabled or disabled state of jtapi console tracing.
boolean
getUseSameDir()
Causes the traces to go to a single directory if UseSameDir is true.
boolean
getUseSyslog()
Gets the enabled or disabled state of syslog tracing.
boolean
IsCertificateUpdated(java.lang.String user, java.lang.String instanceID)
Provides information about where Client and Server certificates are updated for a given user/instanceID or if the Client and Server certificates are not updated.
void
setAlarmServiceHostname(java.lang.String hostname)
Sets the alarm service host name.
void
setAlarmServicePort(int portNumber)
Sets the port number the alarm service is listening on.
void
setCallSecurityStatusChangedEv(boolean val)
Enables applications to set the filter to receive CallSecurityStatusChangedEv to true or false.
void
setCtiRequestTimeout(int seconds)
Sets the time out for CTI requests other than provider open (seconds).
void
setDebuggingValue(java.lang.String debuggingName, boolean value)
Enables or disables a particular debugging level trace.
void
setDesiredServerHeartbeatInterval(int seconds)
Sets the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds).
void
setDiscConnBeforeCreatingInCPIC(boolean val)
Sets event order, sent Disconnect before Connection created during redirect at redirted party.
void
setFileNameBase(java.lang.String base)
Sets the filename for log files.
void
setFileNameExtension(java.lang.String extn)
Sets the filename extension for log files.
void
setHuntListEnabled (boolean)
Enables the Hunt List Feature in Cisco Unified JTAPI.
void
setJavaSocketConnectTimeout(int timeout)
Allows application to set the SOCKET CONNECT TIMEOUT in seconds.
void
setNumTraceFiles(int val)
Sets the number of trace files before rollover.
void
setPeriodicWakeupEnabled(boolean enabled)
Sets the enable/disable state for periodic wake up.
void
setPeriodicWakeupInterval(int milliseconds)
Sets the periodic wake up interval (milliseconds).
void
setProcessOfferingAfterNewcallevent(boolean val)
Controls the event order for the transfer scenario when only transfer destination observed by Application and transfer is completed in offering state.
void
setProviderOpenRequestTimeout(int seconds)
Sets the timeout for a provider open request (seconds).
void
setProviderOpenRetryAttempts(int retryAttempts)
Allows application to set the JTAPI Reconnect Attempts to CTI Manager.
void
setProviderRetryInterval(int seconds)
Sets the interval at which the connection to the CTI Manager will ge retried (seconds).
void
setQueueSizeThreshold(int size)
Sets the threshold for the event queue size to trigger alarms.
void
setQueueStatsEnabled(boolean enabled)
Enables and disables event queue statistics.
void
setRouteSelectTimeout(int milliseconds)
Sets the route select timeout milliseconds.
void
setSecurityPropertyForInstance(java.lang.String user, java.lang.String instanceID, java.lang.String authCode, java.lang.String tftp, java.lang.String tftpPort, java.lang.String capf, java.lang.String capfPort, java.lang.String certPath, boolean securityOption)
Deprecated
This method is replaced by overloaded method setSecurityPropertyForInstance which takes an extra parameter certStorePassphrase, a passphrase for java key store. This method might have some security vulnerability.
void
setSecurityPropertyForInstance(java.lang.String user, java.lang.String instanceID, java.lang.String authCode, java.lang.String tftp, java.lang.String tftpPort, java.lang.String capf, java.lang.String capfPort, java.lang.String certPath, boolean securityOption, java.lang.String certstorePassphrase)
Provides the application ability to downloading server/client cerfiticate and set security property for application instance in jtapi.ini file of JTAPI.
void
setSecurityPropertyForInstance(String user, String instanceID, String authCode, String tftp, String tftpPort, String capf, String capfPort, String certPath, boolean securityOption, String certstorePassphrase, boolean fipsCompliant)
This method provides applications the ability to download server/client certificate and set the security property for this application instance in the jtapi.ini file.
Specifying any value of fipsCompliant for this method will have no effect unless the securityOption is set to true.
It should be noted that this method will call updateCertificate() and updateServerCertificate(). This is the preferred way to acquire certificates.
void
setServices(java.lang.String[] services)
Sets a list of available services.
void
setSyslogCollector(java.lang.String value)
Sets the syslog collector hostname.
void
setSyslogCollectorUDPPort(int port)
Sets the syslog collector UDP port.
void
setTraceDirectory(java.lang.String dir)
Sets the directory where jtapi trace files should be written.
void
setTraceFileSize(int val)
Sets the size of the trace file.
void
setTracePath(java.lang.String path)
Sets the directory root where jtapi traces will be written.
void
setTraceValue(java.lang.String traceName, boolean value)
Enables or disables a particular trace.
void
setUpdateJtapiCalledWithOriginalCalled(boolean val)
Updates Jtapi Called information with original called once the parameter is set to true always.
void
setUseAlarmService(boolean value)
Enables or disables the alarm service.
void
setUseFileTrace(boolean value)
Enables or disables jtapi log file tracing.
void
setUseJavaConsoleTrace(boolean value)
Enables or disables jtapi console tracing.
void
setUseSameDir(boolean value)
Causes the traces to go to a single directory if UseSameDir is true.
void
setUseSyslog(boolean value)
Enables or disables syslog tracing.
void
updateCertificate(java.lang.String user, java.lang.String intanceID, java.lang.String authcode, java.lang.String ccmTFTPAddress, java.lang.String ccmTFTPPort, java.lang.String ccmCAPFAddress, java.lang.String ccmCAPFPort, java.lang.String certificatePath)
Deprecated
This method is replaced by overloaded method updateCertifcate which takes an extra parameter certStorePassphrase, a passphrase for java key store. This method might have some security vulnerability.
void
updateCertificate(java.lang.String user, java.lang.String intanceID, java.lang.String authcode, java.lang.String ccmTFTPAddress, java.lang.String ccmTFTPPort, java.lang.String ccmCAPFAddress, java.lang.String ccmCAPFPort, java.lang.String certificatePath, java.lang.String certStorePassphrase)
Installs an X.509 client certificate for USER Instance in cerfiticate store.
void
updateCertificate(String user, String intanceID, String authcode, String ccmTFTPAddress, String ccmTFTPPort, String ccmCAPFAddress, String ccmCAPFPort, String certificatePath, String certStorePassphrase, boolean fipsCompliant) throws Exception, IOException, UnknownHostException;
This method downloads the client and server certificates for the specified parameters.
void
updateServerCertificate(java.lang.String ccmTFTPAddress, java.lang.String ccmTFTPPort, java.lang.String ccmCAPFAddress, java.lang.String ccmCAPFPort, java.lang.String certificatePath)
Deprecated
This method is replaced by overloaded method updateServerCertifcate which takes an extra parameter certStorePassphrase, a passphrase for java key store. This method might have some security vulnerability.
void
updateServerCertificate(java.lang.String userName, java.lang.String instanceID, java.lang.String ccmTFTPAddress, java.lang.String ccmTFTPPort, java.lang.String ccmCAPFAddress, java.lang.String ccmCAPFPort, java.lang.String certificatePath, java.lang.String certStorePassphrase)
Installs an X.509 server certificate given certificate path.
void
updateServerCertificate(String userName, String instanceID, String ccmTFTPAddress, String ccmTFTPPort, String ccmCAPFAddress, String ccmCAPFPort, String certificatePath, String certStorePassphrase, boolean fipsCompliant) throws Exception, IOException, UnknownHostException;
This method downloads the server certificates for the specified parameters. It is called by updateCertificate().
User/InstanceID Hashtable
Related Documentation
CiscoLocales
This interface lists all the locales that Cisco Unified JTAPI supports.
Interface History
7.1(1 and 2)
Created history table to track changes.
Declaration
public interface CiscoLocales
Fields
Methods
None
Related Documentation
CiscoMediaConnectionMode
The CiscoMediaConnectionMode interface lists all of the media connection modes.
Interface History
7.1(1 and 2)
Created history table to track changes.
Declaration
public interface CiscoMediaConnectionMode
Fields
Methods
None
Related Documentation
CiscoMediaEncryptionAlgorithmType
The CiscoMediaEncryptionAlgorithmType interface indicates the SRTP algorithm type used for encryption. This interface lists all of the security indicator values that an application can get in CiscoRTPInputKeyEv and CiscoRTPOutputKeyEv. If an application is terminating its own media on CTIPorts and Media Terminated RPs, only one of the following algorithms needs to be provided in the register API.
Interface History
Superinterfaces
public interface CiscoMediaEncryptionAlgorithmType
Fields
Related Documentation
See Constant Field Values for additional information.
CiscoMediaEncryptionKeyInfo
The CiscoMediaEncryptionKeyInfo interface lets applications get information about SRTP keys.
Interface History
7.1(1 and 2)
Created history table to track changes.
Declaration
public interface CiscoMediaEncryptionKeyInfo
Fields
None
Methods
Related Documentation
See CiscoRTPInputKeyEv, CiscoRTPOutputKeyEv.
CiscoMediaOpenIPPortEv
CiscoMediaOpenIPPortEv event is delivered only if the terminal is registered with registration type as CiscoBaseTerminal.DYNAMIC_MEDIA_REGISTRATION_FOR_GET_PORT_SUPPORT or CiscoBaseTerminal.STATIC_MEDIA_REGISTRATION_FOR_GET_PORT_SUPPORT.
Interface History
Sample Code
public class MyTermObserver implements implements TerminalObserver, CallControlTerminalObserver, AgentTerminalObserver, PhoneTerminalObserver {public void termChangedEvent (TermEv[] evlist) {for(int i=0; evlist != null && i < evlist.length; i++){......If ( evlisth[i] instanceof CiscoMediaOpenIPPortEv){CiscoMediaOpenIPPortEv ev = (CiscoMediaOpenIPPortEv)evlist[i];if(((CiscoBaseMediaTerminal)(ev.getTerminal()))).getRegistrationType== CiscoTerminal.DYNAMIC_MEDIA_REGISTRATION_FOR_GET_PORT_SUPPORT){System.out.println("Set RTP parameters");System.out.println("open the port");} else {System.out.println("Open port");}}}......}Declaration
public interface CiscoMediaOpenIPPortEv
Superinterfaces
NA
Fields
NA
Inherited Fields
NA
Methods
Table 6-103 Methods in CiscoMediaOpenIPPortEv
int
getMediaIPAddressingMode()
CiscoRTPHandle
getCiscoRTPHandle()
Inherited Methods
NA
CiscoMediaOpenLogicalChannelEv
The system sends a CiscoMediaOpenLogicalChannelEv event each time that media gets established for a dynamically registered CiscoMediaTerminal or CiscoRouteTerminal. Upon receiving this event, applications must invoke setRTPParams on CiscoMediaTerminal or CiscoRouteTerminal and pass in the IP address and port number where they want to terminate the media, along with the rtpHandle that this event delivers.
Applications can get a call reference by using CiscoProvider.getCall(CiscoRTPHandle). Applications must be aware that the far end and local end may not be able to invoke features unless the setRTPParams method is invoked. If applications fail to respond to this event within the specified time, the call may get disconnected.
Interface History
7.0(1)
Added the getAddressingModeForMedia() method.
8.5(1)
Added the isRTPRequired() method.
Sample Code
public class MyTermObserver implements implements TerminalObserver, CallControlTerminalObserver, AgentTerminalObserver, PhoneTerminalObserver {public void termChangedEvent (TermEv[] evlist) {for(int i=0; evlist != null && i < evlist.length; i++){......If ( evlisth[i] instanceof CiscoMediaOpenLogicalChannelEv){CiscoMediaOpenLogicalChannelEv ev = (CiscoMediaOpenLogicalChannelEv)evlist[i];if(ev.isRTPRequired()){System.out.println("Set RTP parameters");} else {System.out.println("Do not set RTP parameters");}}}......}Superinterfaces
CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEv
Declaration
public interface CiscoMediaOpenLogicalChannelEv extends CiscoTermEv
Fields
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
Inherited Methods
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.TermEv
getTerminal
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
See Constant Field Values and CiscoRTPParams
CiscoMediaSecurityIndicator
CiscoMediaSecurityIndicator gets sent in CiscoRTPInputKeyEv, CiscoRTPOutputKeyEv, and CiscoSnapShotRTPEv. It shows the call security status.
Interface History
7.1(1 and 2)
Created history table to track changes.
Declaration
public interface CiscoMediaSecurityIndicator
Fields
Related Documentation
CiscoMediaTerminal
A CiscoMediaTerminal is a special kind of CiscoTerminal that allows applications to terminate RTP media streams. Unlike a CiscoTerminal, a CiscoMediaTerminal does not represent a physical telephony endpoint, which is observable and controllable in a third-party manner. Instead, a CiscoMediaTerminal is a logical telephony endpoint, which may be associated with any application that wants to terminate media. Such applications include voice messaging systems, interactive voice response (IVR), and softphones.
Note
Terminating media is a two-step process. To terminate media for a particular terminal, an application first adds an observer that implements the CiscoTerminalObserver interface using the Terminal.addObserver method. Finally, the application registers the IP address and port number to which incoming RTP streams for the terminal should be directed, by using the CiscoMediaTerminal.register method.
To supply an IP address and port number dynamically on a per-call basis, applications must register by only providing the capabilities that they support. Applications must react to the CiscoMediaOpenLogicalChannelEv that gets sent whenever media gets established. Applications registering with this type must be aware that, when this event is received, the far end and the local end may not be able to perform any feature operation unless media is established. If applications fail to respond to this event within the specified time, the call may get dropped.
Interface History
Superinterfaces
CiscoObjectContainer, CiscoTerminal, javax.telephony.Terminal
Declaration
public interface CiscoMediaTerminal extends CiscoTerminal
Fields
None
Inherited Fields
From Interface com.cisco.jtapi.extensions.CiscoTerminal
ASCII_ENCODING, DEVICESTATE_ACTIVE, DEVICESTATE_ALERTING, DEVICESTATE_HELD, DEVICESTATE_IDLE, DEVICESTATE_UNKNOWN, DEVICESTATE_WHISPER, DND_OPTION_CALL_REJECT, DND_OPTION_NONE, DND_OPTION_RINGER_OFF, IN_SERVICE, IP_ADDRESSING_MODE_IPV4, IP_ADDRESSING_MODE_IPV4_V6, IP_ADDRESSING_MODE_IPV6, IP_ADDRESSING_MODE_UNKNOWN, IP_ADDRESSING_MODE_UNKNOWN_ANATRED, NOT_APPLICABLE, OUT_OF_SERVICE, UCS2UNICODE_ENCODING, UNKNOWN_ENCODING
Methods
Inherited Methods
From Interface com.cisco.jtapi.extensions.CiscoTerminal
createSnapshot, getAltScript, getDeviceState, getDNDOption, getDNDStatus, getEMLoginUsername, getFilter, getLocale, getProtocol, getRegistrationState, getRTPInputProperties, getRTPOutputProperties, getState, getSupportedEncoding, isRestricted, sendData, sendData, setDNDStatus, setFilter, unPark
From Interface javax.telephony.Terminal
addCallObserver, addObserver, getAddresses, getCallObservers, getCapabilities, getName, getObservers, getProvider, getTerminalCapabilities, getTerminalConnections, removeCallObserver, removeObserver
From Interface com.cisco.jtapi.extensions.CiscoObjectContainer
getObject, setObject
Related Documentation
See CiscoTerminal and CiscoMediaOpenLogicalChannelEv.CiscoRTPParams
CiscoMonitorInitiatorInfo
This interface defines provides information about the monitor initiator.
Interface History
7.1(1 and 2)
Created history table to track changes.
Declaration
public interface CiscoMonitorInitiatorInfo
Fields
None
Methods
Related Documentation
None
CiscoMonitorTargetInfo
This interface provides information about the monitor target.
Declaration
public interface CiscoMonitorTargetInfo
Fields
None
Methods
Related Documentation
None
CiscoObjectContainer
The ApplicationObject interface allows applications to associate an application-defined object to objects that implement this interface.
Interface History
7.1(1 and 2)
Created history table to track changes.
Subinterfaces
CiscoAddress, CiscoCall, CiscoCallID, CiscoConnection, CiscoConnectionID, CiscoConsultCall, CiscoIntercomAddress, CiscoJtapiPeer, CiscoMediaTerminal, CiscoProvider, CiscoRouteTerminal, CiscoTerminal, CiscoTerminalConnection
Declaration
public interface CiscoObjectContainer
Fields
None
Methods
Related Documentation
None
CiscoOutOfServiceEv
The CiscoOutOfServiceEv event is the super class for the out-of-service events CiscoAddrOutOfServiceEv and CiscoTermOutOfServiceEv. This class defines the causes for out-of-service events.
Interface History
7.1(1 and 2)
Created history table to track changes.
Superinterfaces
CiscoEv, javax.telephony.events.Ev
Subinterfaces
CiscoAddrOutOfServiceEv, CiscoTermOutOfServiceEv
Declaration
public interface CiscoOutOfServiceEv extends CiscoEv
Fields
Inherited Fields
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Methods
None
Related Documentation
CiscoPartyInfo
This interface defines the party info of the call.
Interface History
7.1(1 and 2)
Created history table to track changes.
Declaration
public interface CiscoPartyInfo
Fields
Methods
Related Documentation
CiscoPickupGroup
CiscoPickupGroup is a new interface that represents a Pickup Group at the JTAPI layer. Currently, all a PickupGroup is a pair of String objects representing the Pickup Group's DN, and the Pickup Group's Partition.
Interface History
7.1(1 and 2)
Created history table to track changes.
8.0(1)
Following APIs are added:
•
•
Declaration
public interface CiscoPickupGroup
Methods
Related Documentation
None
CiscoProvCallParkEv
CiscoProvCallParkEv event is delivered to providerobserver when a call is parked/unparked from any device in the cluster. To receive this event application should register using CiscoProvider.registerFeature() and CiscoProvFeatureID.MONITOR_CALLPARK_DN. User profile used by the application should have the Call Park Retrieval Allowed flag enabled to receive this event.
Interface History
7.1(1 and 2)
Created history table to track changes.
Superinterfaces
CiscoEv, CiscoProvEv, CiscoProvFeatureEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
Declaration
public interface CiscoProvCallParkEv extends CiscoProvFeatureEv
Fields
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
Inherited Methods
From Interface com.cisco.jtapi.extensions.CiscoProvFeatureEv
getFeatureID
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
From Interface javax.telephony.events.ProvEv
getProvider
From Interface javax.telephony.events.Ev
getCause, getID, getMetaCode, getObserved, isNewMetaEvent
Related Documentation
CiscoProvEv
The CiscoProvEv interface, which extends JTAPI's core javax.telephony.events.ProvEv interface, serves as the base interface for all Cisco-extended JTAPI Provider events. Every Provider-related event in this package extends this interface, directly or indirectly.
Interface History
Superinterfaces
CiscoEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
Subinterfaces
CiscoAddrActivatedEv, CiscoAddrActivatedOnTerminalEv, CiscoAddrAddedToTerminalEv, CiscoAddrCreatedEv, CiscoAddrRemovedEv, CiscoAddrRemovedFromTerminalEv, CiscoAddrRestrictedEv, CiscoAddrRestrictedOnTerminalEv, CiscoProvCallParkEv, CiscoProvFeatureEv, CiscoProvTerminalCapabilityChangedEv, CiscoRestrictedEv, CiscoTermActivatedEv, CiscoTermCreatedEv, CiscoTermRemovedEv, CiscoTermRestrictedEv
Declaration
public interface CiscoProvEv extends CiscoEv, javax.telephony.events.ProvEv
Fields
None
Inherited Fields
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
From Interface javax.telephony.events.Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods
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
CiscoProvFeatureEv
The CiscoProvFeatureEv interface extends the com.cisco.jtapi.extensions.CiscoProvEv interface for provider events.
Interface History
7.1(1 and 2)
Created history table to track changes.
Superinterfaces
CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
Subinterfaces
CiscoProvCallParkEv
Declaration
public interface CiscoProvFeatureEv 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-118 Methods in CiscoProvFeatureEv
int
getFeatureID()
The feature ID for which the application wants to receive events.
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 CiscoProvEv.
ProvEv.
CiscoProvFeatureID
This interface lists the features that registerFeature supports.
Interface History
Declaration
public interface CiscoProvFeatureID
Fields
Sample Code:
To register for Terminal Register and Unregister event notification:
try{JtapiPeer peer = JtapiPeerFactory.getJtapiPeer ( null );} catch (JtapiPeerUnavailableException e){}MyProviderObserver providerObserver = new MyProviderObserver ();Try{provider = peer.getProvider ( ipaddress;login=useid;passwd=password );} catch (ProviderUnavailableException exp){}if ( provider != null ) {provider.addObserver ( providerObserver );provInService.waitTrue();System.out.Println("Enabling Register and Unregister events ");try{((CiscoProvider)provider).registerFeature(CiscoProvFeatureID. TERMINAL_REGISTER_UNREGISTER_EVENT_NOTIFY);} catch (InvalidStateException ec){}}// CiscoProvTerminalRegisteredEv and CiscoProvTerminalUnRegisteredEv are delivered to Provider Observer.
class MyProviderObserver implements ProviderObserver {public synchronized void providerChangedEvent ( ProvEv [] eventList ) {try {if ( eventList != null ) {for ( int i = 0; i < eventList.length; i++ ) {if ( eventList[i] instanceof CiscoProvTerminalRegisteredEv ){CiscoProvTerminalRegisteredEv ev = (CiscoProvTerminalRegisteredEv) eventList[i];System.out.Println( ev.getTerminal().getName() + " registered with CUCM" );}}} catch (Exception eee){}Methods
None
Related Documentation
CiscoProvPickupCallAlertEv
CiscoProvPickupCallAlertEvent is a new interface being added with Call Pickup feature development. This event is fired whenever there is a call to be picked up in a pickup group that the provider is observing. See previous changes to CiscoProvider for information about how to register to observe a pickup group.
Declaration
public interface CiscoProvPickupCallAlertEvent extends CiscoProvEv
Methods
CiscoProvTerminalRegisteredEv
This event is delivered to provider observer whenever a terminal registers with Cisco Unified Communication Manager. To receive this event, the application must use registerFeature API with CiscoFeatureID. TERMINAL_REGISTER_UNREGISTER_EVENT_NOTIFY. This event is delivered if a Terminal registers to Cisco Unified Communication Manager after the application registers for the feature using registerFeature API. During initialization time and JTAPI failover time the application can see this event for some the Terminals in the control list.
Interface History
Declaration
public interface CiscoProvTerminalRegisteredEv extends CiscoProvEv.
Fields
Table 6-121 Fields in CiscoProvTerminalRegisteredEv
Terminal
getTerminal()
Returns the terminal that registered with Cisco Unified Communications Manager.
Methods
None
Related Documentation
None
CiscoProvTerminalUnRegisteredEv
This event is delivered to provider observer when ever a terminal unregisters from Cisco Unified Communication Manager. To receive this event, the application must use the registerFeature API with CiscoFeatureID. TERMINAL_REGISTER_UNREGISTER_EVENT_NOTIFY.
Interface History
Declaration
public interface CiscoProvTerminalUnRegisteredEv extends CiscoProvEv.
Fields
Methods
None
Related Documentation
None
CiscoProvider
The CiscoProvider interface extends the Provider interface with additional Cisco capabilities.
Interface History
Superinterfaces
CiscoObjectContainer, javax.telephony.Provider.
Declaration
public interface CiscoProvider extends javax.telephony.Provider, CiscoObjectContainer
Fields
None
Inherited Fields
From Interface javax.telephony.Provider
IN_SERVICE, OUT_OF_SERVICE, SHUTDOWN
New Error Codes
CTIERR_ALREADY_REGISTERED
This error code indicates that the Pickup Group attempting to be registerred for has already been registerred by this provider.
CTIERR_REGISTRATION_NOT_FOUND
This error code indicates that an unregister attempt failed because the Pickup Group specified was not registerred for previously.
CTIERR_INVALID_PICKUPGROUP
This error code indicates that the Pickup Group specified in the register or unregister event is not valid.
Methods
Inherited Methods
From Interface javax.telephony.Provider
addObserver, createCall, getAddress, getAddressCapabilities, getAddressCapabilities, getAddresses, getCallCapabilities, getCallCapabilities, getCalls, getCapabilities, getConnectionCapabilities, getConnectionCapabilities, getName, getObservers, getProviderCapabilities, getProviderCapabilities, getState, getTerminal, getTerminalCapabilities, getTerminalCapabilities, getTerminalConnectionCapabilities, getTerminalConnectionCapabilities, getTerminals, removeObserver, shutdown
From Interface com.cisco.jtapi.extensions.CiscoObjectContainer
getObject, setObject
Related Documentation
None
CiscoProviderCapabilities
This interface defines the Cisco-specific provider capabilities that Cisco Unified JTAPI offers.
Interface History
Superinterfaces
javax.telephony.capabilities.ProviderCapabilities
Declaration
public interface CiscoProviderCapabilities extends javax.telephony.capabilities.ProviderCapabilities
Methods
Inherited Methods
From Interface javax.telephony.capabilities.ProviderCapabilities
isObservable
Related Documentation
See canObserveAnyTerminal().
CiscoProviderCapabilityChangedEv
Application provider observers receive this event when a user gets added or removed from user groups (capabilitied) in Cisco Unified Communications Manager. The methods for this event let you check which capabilities changed.
Interface History
7.1(1 and 2)
Added hasIPv6CapabilityChanged() method.
Declaration
public interface CiscoProviderCapabilityChangedEv
Fields
Methods
Related Documentation
CiscoProviderObserver
Implement this interface to receive CiscoProvEv events such as CiscoAddrCreatedEv and CiscoTermCreatedEv when observing a Provider via the Provider.addObserver method.
Interface History
7.1(1 and 2)
Created history table to track changes.
Superinterfaces
javax.telephony.ProviderObserver
Declaration
public interface CiscoProviderObserver extends javax.telephony.ProviderObserver
Methods
None
Inherited Methods
From Interface javax.telephony.ProviderObserver
providerChangedEvent
Related Documentation
See CiscoAddrCreatedEv and CiscoTermCreatedEv.
CiscoProvTerminalCapabilityChangedEv
This event is delivered to the Provider when Terminal Capability is changed. This event is provided on application observer .
Interface History
Superinterfaces
CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
Declaration
public interface CiscoProvTerminalCapabilityChangedEv extends CiscoProvEv
Fields
Table 6-127 Fields in CiscoProvTerminalCapabilityChangedEv
static int
ID
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
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
None
CiscoRecorderInfo
This interface provides information about the recorder in a recording session. When a recording session is active, this interface gives information about the recording device.
Interface History
7.1(1 and 2)
Created history table to track changes.
Declaration
public interface CiscoRecorderInfo
Fields
None
Methods
