Table Of Contents
Cisco Unified JTAPI Implementation
Cisco Unified JTAPI Extensions Hierarchy
Class com.cisco.jtapi.extensions
CiscoAddrActivatedOnTerminalEv
CiscoAddrAutoAcceptStatusChangedEv
CiscoAddrIntercomInfoChangedEv
CiscoAddrIntercomInfoRestorationFailedEv
CiscoAddrRestrictedOnTerminalEv
CiscoAddressRecordingConfigChangedEv
CiscoAddrRemovedFromTerminalEv
CiscoCallCtlTermConnHeldReversionEv
CiscoCallSecurityStatusChangedEv
CiscoMediaOpenLogicalChannelEv
CiscoMediaTerminalConnectionCapabilities
CiscoProvFeatureUnRegisteredEv
CiscoProviderCapabilityChangedEv
CiscoTermConnMonitorInitiatorInfoEv
CiscoTermConnMonitorTargetInfoEv
CiscoTermConnRecordingTargetInfoEv
CiscoTermDeviceStateAlertingEv
Class com.cisco.services.alarm
All Known Implementing Classes
All Known Implementing Classes
Class com.cisco.services.tracing
All Known Implementing Classes
Cisco Unified JTAPI Implementation
Cisco Unified JTAPI Implementation describes the interfaces and classes available. To create new applications, use these interfaces and classes with the standard JTAPI interfaces and classes described in the JTAPI v 1.2 specification.
This chapter contains the following sections:
•
Cisco Unified JTAPI Extensions Hierarchy
•
•
•
Cisco Unified JTAPI Extensions Hierarchy
Class Hierarchy
class java.lang.Object
class com.cisco.services.alarm.AlarmManager
class com.cisco.services.tracing.BaseTraceWriter (implements com.cisco.services.tracing.TraceWriter)
class com.cisco.services.tracing.ConsoleTraceWriter
class com.cisco.services.tracing.LogFileTraceWriter
class com.cisco.services.tracing.OutputStreamTraceWriter
class com.cisco.services.tracing.SyslogTraceWriter
class com.cisco.jtapi.extensions.CiscoAddressCallInfo
class com.cisco.jtapi.extensions.CiscoJtapiVersion
class com.cisco.jtapi.extensions.CiscoMediaCapability
class com.cisco.jtapi.extensions.CiscoG711MediaCapability
class com.cisco.jtapi.extensions.CiscoG723MediaCapability
class com.cisco.jtapi.extensions.CiscoG729MediaCapability
class com.cisco.jtapi.extensions.CiscoGSMMediaCapability
class com.cisco.jtapi.extensions.CiscoRTPParams
class com.cisco.services.alarm.DefaultAlarm
(implements com.cisco.services.alarm.Alarm)class com.cisco.services.alarm.DefaultAlarmWriter
(implements com.cisco.services.alarm.AlarmWriter)class com.cisco.services.alarm.ParameterList
class java.lang.Throwable
(implements java.io.Serializable)class java.lang.Exception
class com.cisco.jtapi.extensions.CiscoRegistrationException
class com.cisco.jtapi.extensions.CiscoUnregistrationException
class com.cisco.services.tracing.TraceManagerFactory
Interface Hierarchy
interface javax.telephony.Address
interface com.cisco.jtapi.extensions.CiscoAddress
(also extends com.cisco.jtapi.extensions.CiscoObjectContainer)interface javax.telephony.callcenter.RouteAddress
interface com.cisco.jtapi.extensions.CiscoRouteAddress
interface javax.telephony.AddressObserver
interface com.cisco.jtapi.extensions.CiscoAddressObserver
interface com.cisco.services.alarm.Alarm
interface com.cisco.services.alarm.AlarmWriter
interface javax.telephony.Call
interface javax.telephony.callcontrol.CallControlCall
interface com.cisco.jtapi.extensions.CiscoCall
(also extends com.cisco.jtapi.extensions.CiscoObjectContainer)interface com.cisco.jtapi.extensions.CiscoConsultCall
interface com.cisco.jtapi.extensions.CiscoPartyInfo
interface com.cisco.jtapi.extensions.CiscoJtapiException
interface com.cisco.jtapi.extensions.CiscoJtapiProperties
interface com.cisco.jtapi.extensions.CiscoObjectContainer
interface com.cisco.jtapi.extensions.CiscoAddress
(also extends javax.telephony.Address)interface com.cisco.jtapi.extensions.CiscoCall
(also extends javax.telephony.callcontrol.CallControlCall)interface com.cisco.jtapi.extensions.CiscoConsultCall
interface com.cisco.jtapi.extensions.CiscoCallID
interface com.cisco.jtapi.extensions.CiscoConnection
(also extends javax.telephony.callcontrol.CallControlConnection)interface com.cisco.jtapi.extensions.CiscoConnectionID
interface com.cisco.jtapi.extensions.CiscoJtapiPeer
(also extends javax.telephony.JtapiPeer, com.cisco.services.tracing.TraceModule)interface com.cisco.jtapi.extensions.CiscoProvider
(also extends javax.telephony.Provider)interface com.cisco.jtapi.extensions.CiscoTerminal
(also extends javax.telephony.Terminal)interface com.cisco.jtapi.extensions.CiscoMediaTerminal
interface com.cisco.jtapi.extensions.CiscoTerminalConnection
(also extends javax.telephony.callcontrol.CallControlTerminalConnection)interface com.cisco.jtapi.extensions.CiscoProvFeatureID
interface com.cisco.jtapi.extensions.CiscoRTPBitRate
interface com.cisco.jtapi.extensions.CiscoRTPInputProperties
interface com.cisco.jtapi.extensions.CiscoRTPOutputProperties
interface com.cisco.jtapi.extensions.CiscoRTPPayload
interface com.cisco.jtapi.extensions.CiscoSynchronousObserver
interface javax.telephony.Connection
interface javax.telephony.callcontrol.CallControlConnection
interface com.cisco.jtapi.extensions.CiscoConnection
(also extends com.cisco.jtapi.extensions.CiscoObjectContainer)interface javax.telephony.events.Ev
interface javax.telephony.events.AddrEv
interface com.cisco.jtapi.extensions.CiscoAddrEv
(also extends com.cisco.jtapi.extensions.CiscoEv)interface com.cisco.jtapi.extensions.CiscoAddrInServiceEv
interface com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv
(also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)interface javax.telephony.events.CallEv
interface javax.telephony.events.CallActiveEv
interface com.cisco.jtapi.extensions.CiscoConsultCallActiveEv
(also extends com.cisco.jtapi.extensions.)interface com.cisco.jtapi.extensions.CiscoCallEv
(also extends com.cisco.jtapi.extensions.CiscoEv)interface com.cisco.jtapi.extensions.CiscoConferenceEndEv
interface com.cisco.jtapi.extensions.CiscoConferenceStartEv
interface com.cisco.jtapi.extensions.CiscoConsultCallActiveEv
(also extends javax.telephony.events.CallActiveEv)interface com.cisco.jtapi.extensions.CiscoTransferEndEv
interface com.cisco.jtapi.extensions.CiscoTransferStartEv
interface com.cisco.jtapi.extensions.CiscoEv
interface com.cisco.jtapi.extensions.CiscoAddrEv
(also extends javax.telephony.events.AddrEv)interface com.cisco.jtapi.extensions.CiscoAddrInServiceEv
interface com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv
(also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)interface com.cisco.jtapi.extensions.CiscoCallEv
(also extends javax.telephony.events.CallEv)interface com.cisco.jtapi.extensions.CiscoConferenceEndEv
interface com.cisco.jtapi.extensions.CiscoConferenceStartEv
interface com.cisco.jtapi.extensions.CiscoConsultCallActiveEv
(also extends javax.telephony.events.CallActiveEv)interface com.cisco.jtapi.extensions.CiscoTransferEndEv
interface com.cisco.jtapi.extensions.CiscoTransferStartEv
interface com.cisco.jtapi.extensions.CiscoOutOfServiceEv
interface com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv
(also extends com.cisco.jtapi.extensions.CiscoAddrEv)interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv
(also extends com.cisco.jtapi.extensions.CiscoTermEv)interface com.cisco.jtapi.extensions.CiscoProvEv
(also extends javax.telephony.events.ProvEv)interface com.cisco.jtapi.extensions.CiscoAddrActivatedEv
interface com.cisco.jtapi.extensions.CiscoAddrActivatedOnTerminalEv
interface com.cisco.jtapi.extensions.CiscoAddrCreatedEv
interface com.cisco.jtapi.extensions.CiscoAddrRemovedEv
interface com.cisco.jtapi.extensions.CiscoProvFeatureEv
interface com.cisco.jtapi.extensions.CiscoProvCallParkEv
interface com.cisco.jtapi.extensions.CiscoProvFeatureUnRegisteredEv
interface com.cisco.jtapi.extensions.CiscoRestrictedEv
interface com.cisco.jtapi.extensions.CiscoAddrRestrictedEv
interface com.cisco.jtapi.extensions.CiscoAddrRestrictedOnTerminalEv
interface com.cisco.jtapi.extensions.CiscoTermActivatedEv
interface com.cisco.jtapi.extensions.CiscoTermRestrictedEv
interface com.cisco.jtapi.extensions.CiscoTermCreatedEv
interface com.cisco.jtapi.extensions.CiscoTermRemovedEv
interface com.cisco.jtapi.extensions.CiscoTermEv
(also extends javax.telephony.events.TermEv)interface com.cisco.jtapi.extensions.CiscoRTPInputStartedEv
interface com.cisco.jtapi.extensions.CiscoRTPInputStoppedEv
interface com.cisco.jtapi.extensions.CiscoRTPOutputStartedEv
interface com.cisco.jtapi.extensions.CiscoRTPOutputStoppedEv
interface com.cisco.jtapi.extensions.CiscoTermDataEv
interface com.cisco.jtapi.extensions.CiscoTermInServiceEv
interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv
(also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)interface javax.telephony.events.ProvEv
interface com.cisco.jtapi.extensions.CiscoProvEv
(also extends com.cisco.jtapi.extensions.CiscoEv)interface com.cisco.jtapi.extensions.CiscoAddrCreatedEv
interface com.cisco.jtapi.extensions.CiscoAddrRemovedEv
interface com.cisco.jtapi.extensions.CiscoProvFeatureEv
interface com.cisco.jtapi.extensions.CiscoProvCallParkEv
interface com.cisco.jtapi.extensions.CiscoProvFeatureUnRegisteredEv
interface com.cisco.jtapi.extensions.CiscoTermCreatedEv
interface com.cisco.jtapi.extensions.CiscoTermRemovedEv
interface javax.telephony.events.TermEv
interface com.cisco.jtapi.extensions.CiscoTermEv
(also extends com.cisco.jtapi.extensions.CiscoEv)interface com.cisco.jtapi.extensions.CiscoRTPInputStartedEv
interface com.cisco.jtapi.extensions.CiscoRTPInputStoppedEv
interface com.cisco.jtapi.extensions.CiscoRTPOutputStartedEv
interface com.cisco.jtapi.extensions.CiscoRTPOutputStoppedEv
interface com.cisco.jtapi.extensions.CiscoTermDataEv
interface com.cisco.jtapi.extensions.CiscoTermInServiceEv
interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv
(also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)interface javax.telephony.JtapiPeer
interface com.cisco.jtapi.extensions.CiscoJtapiPeer
(also extends com.cisco.jtapi.extensions.CiscoObjectContainer, com.cisco.services.tracing.TraceModule)interface javax.telephony.Provider
interface com.cisco.jtapi.extensions.CiscoProvider
(also extends com.cisco.jtapi.extensions.CiscoObjectContainer)interface javax.telephony.capabilities.ProviderCapabilities
interface com.cisco.jtapi.extensions.CiscoProviderCapabilities
interface javax.telephony.ProviderObserver
interface com.cisco.jtapi.extensions.CiscoProviderObserver
interface javax.telephony.callcenter.RouteSession
interface com.cisco.jtapi.extensions.
interface javax.telephony.Terminal
interface com.cisco.jtapi.extensions.CiscoTerminal
(also extends com.cisco.jtapi.extensions.CiscoObjectContainer)interface com.cisco.jtapi.extensions.CiscoMediaTerminal
interface javax.telephony.TerminalConnection
interface javax.telephony.callcontrol.CallControlTerminalConnection
interface com.cisco.jtapi.extensions.CiscoTerminalConnection
(also extends com.cisco.jtapi.extensions.CiscoObjectContainer)interface javax.telephony.TerminalObserver
interface com.cisco.jtapi.extensions.CiscoTerminalObserver
interface com.cisco.services.tracing.Trace
interface com.cisco.services.tracing.ConditionalTrace
interface com.cisco.services.tracing.UnconditionalTrace
interface com.cisco.services.tracing.TraceManager
interface com.cisco.services.tracing.TraceModule
interface com.cisco.jtapi.extensions.CiscoJtapiPeer
(also extends com.cisco.jtapi.extensions.CiscoObjectContainer, javax.telephony.JtapiPeer)interface com.cisco.services.tracing.TraceWriter
interface com.cisco.services.tracing.TraceWriterManager
Class com.cisco.jtapi.extensions
The Cisco Unified JTAPI extension consists of a set of classes and interfaces that expose the functionality available in Cisco Unified Communications Manager. This API allows programmers to create independent applications for Cisco Unified Communications Manager. The Cisco Unified JTAPI implementation offers additional functionality not readily exposed through the JTAPI 1.2 interfaces. Applications can use the interfaces and classes in the com.cisco.jtapi.extensions package with the standard JTAPI interfaces and classes described in the JTAPI v 1.2 Specification to create new applications.
CiscoAddrActivatedEv
If an address is monitored and the restriction status is changed to active, this event is sent to the application.
Declaration
public interface CiscoAddrActivatedEv extends CiscoProvEvAll Superinterfaces
CiscoEv,CiscoProvEv javax.telephony.events.Ev, javax.telephony.events.ProvEv
Description
Applications will see this event whenever a Line or associated device is in the control list and is removed from the restricted list from the Cisco Unified Communications Manager Admin pages. If there are any observers on the address already, then applications will see CiscoAddrInServiceEv. If there are none, applications can try to add observers and address will go in service.
Methods
getAddress()
public Address getAddress()getID()
public int getID()CiscoAddrActivatedOnTerminalEv
Declaration
public interface CiscoAddrActivtedOnTerminalEv extends CiscoProvEvAll Superinterfaces
CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
Description
When a shared line, or a device which has shared line, is removed from the restricted list then this event will be sent. Interface getTerminal() will return the terminal which is getting added to Address. Interface getAddress() will return the address on which new terminal is added.
Methods
getAddress()
public javax.telephony.Address getAddress()getTerminal()
public javax.telephony.Address getTerminal()CiscoAddrAddedToTerminalEv
Declaration
public interface CiscoAddrAddedToTerminalEv extends CiscoProvEvAll Superinterfaces
CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
Description
The CiscoAddrAddedToTerminalEv event gets sent under the following conditions:
•
•
•
Fields
ID
public static final int IDMethods
getAddress()
public javax.telephony.Address getAddress()getTerminal()
public javax.telephony.Address getTerminal()CiscoAddrAutoAcceptStatusChangedEv
Declaration
public interface CiscoAddrAutoAcceptStatusChangedEv extends CiscoAddrEvAll Superinterfaces
javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, javax.telephony.events.Ev
Description
The CiscoAddrAutoAcceptStatusChangedEv event is send to Applications whenever AutoAccept status for the Address on the Terminal is changed. If an Address has multiple Terminals, then this event will be sent for Address's AutoAccept status on each individual Terminals.
Fields
ID
public static final int IDMethods
getAutoAcceptStatus()
public int getAutoAcceptStatus()CiscoAddrAutoAcceptStatusChangedEv.getAutoAcceptStatus() returns following value of AutoAccept status of Address on Terminal CiscoAddress.AUTOACCEPT_OFF CiscoAddress.AUTOACCEPT_ON
See Also:
CiscoAddress.getAutoAcceptStatus()getTerminal()
public com.cisco.jtapi.extensions.CiscoTerminal getTerminal()Returns the terminal at which this address is going InService
In Shared Lines, applications may receive multiple CiscoAddressInService events and the same Address appears on different Terminals. In order for Application to find out which Shared Line is going in service, Applications can use this interface. This interface returns the terminal on which Address is going in Service.
Returns:
the terminal at which this address is going InService
CiscoAddrCreatedEv
Declaration
public interface CiscoAddrCreatedEv extends CiscoProvEvAll Superinterfaces
CiscoEv,CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
Description
The CiscoAddrCreatedEv event
Fields
ID
public static final int IDMethods
getAddress()
public javax.telephony.Address getAddress()CiscoAddrIntercomInfoChangedEv
public interface CiscoAddrIntercomInfoChangedEvextends com.cisco.jtapi.extensions.CiscoAddrEvDescription/Usage
This event is send to the application whenever the target DN or intercom target label changes for a CiscoIntercomAddress. This event is provided to all of the application observers added to the CiscoIntercomAddress.
Methods
getIntercomAddress()
CiscoIntercomAddress getIntercomAddress()This interface returns the intercom address for which the information changed.
CiscoAddrIntercomInfoRestorationFailedEv
This event is send to the application when JTAPI is not able to restore the application-set intercom target DN or the intercom target label for the intercom address during failover or failback. This event is provided on the application observer and is only provided to the application which has set the intercom target DN or the intercom target label.
Declaration
public interface CiscoAddrIntercomInfoRestorationFailedEvextends com.cisco.jtapi.extensions.CiscoAddrEv
Methods
getIntercomAddress()
CiscoIntercomAddress getIntercomAddress()This interface returns the address for which intercom information restoration failed.
CiscoAddrRestrictedEv
If an address is monitored and the restriction status is changed to restricted, this event is sent to the application.
Declaration
public interface CiscoAddrRestrictedEv extends CiscoRestrictedEvAll Superinterfaces
CiscoEv,CiscoProvEv, CiscoRestrictedEv javax.telephony.events.Ev, javax.telephony.events.ProvEv
Description
Applications will see this event whenever a Line or associated device is Restricted from the Cisco Unified Communications Manager Admin pages. 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, then addCallObserver and addObserver will throw an exception.
For shared lines, if few shared lines are restricted, and others are not, then no exception is thrown but restricted shared lines will not receive any events. If all shared lines are restricted, then exception is thrown when adding observers. If address is restricted after adding observers, then applications will see CiscoAddrOutOfServiceEv and when address is activated, then the address will go in service.
Methods
getAddress()
public Address getAddress()getID()
public int getID()CiscoAddrRestrictedOnTerminalEv
Declaration
public interface CiscoAddrRestrictedOnTerminalEv extends CiscoRestrictedEvAll Superinterfaces
CiscoEv, CiscoProvEv, CiscoRestrictedEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
Description
If the user has a Shared address in the control list, and if one of the lines is added into the restricted list, then this event will be sent. Interface getTerminal() will return the terminal on which the address is restricted. Interface getAddress() will return the address which is restricted
Methods
getAddress()
public javax.telephony.Address getAddress()getTerminal()
public javax.telephony.Address getTerminal()CiscoAddress
Declaration
public interface CiscoAddress extends javax.telephony.Address, CiscoObjectContainerAll Superinterfaces
javax.telephony.Address, CiscoObjectContainer
Description
The CiscoAddress interface extends the Address interface with additional Cisco Unified Communications Manager-specific capabilities.
See Also
javax.telephony.Address
Fields
AUTOACCEPT_OFF
public static final int AUTOACCEPT_OFFAutoAccept is off.
AUTOACCEPT_ON
public static final int AUTOACCEPT_ONAutoAccept is on.
AUTOANSWER_OFF
static int AUTOANSWER_OFFAuto Answer is off.
AUTOANSWER_UNKNOWN
static int AUTOANSWER_UNKNOWNAuto Answer status is unknown.
AUTOANSWER_WITHHEADSET
static int AUTOANSWER_WITHHEADSETAuto Answer is allowed with a head set.
AUTOANSWER_WITHSPEAKERSET
static int AUTOANSWER_WITHSPEAKERSETAuto Answer is allowed with a speaker set.
EXTERNAL
public static final int EXTERNALThis is an external address with a valid name. An address of this type is created when ANI or callerID is available on the call.
EXTERNAL_UNKNOWN
public static final int EXTERNAL_UNKNOWNThis is an external address with an unknown name. An address of this type is created to represent an endpoint for which there is insufficient information.
IN_SERVICE
public static final int IN_SERVICEThe address is out-of-service
INTERNAL
public static final int INTERNALThis is an internal address.
MONITORING_TARGET
static final int MONITORING_TARGETThis is an external address with a monitoring target or agent. This address type would be temporarily created to represent a connection to the monitoring target or agent. The interface Provider.getAddresses() does not return this type of address even though the monitoring target or agent is in the provider control list. If the monitoring target or agent is in the provider control list, Provider.getAddresses() returns an address of type CiscoAddress.INTERNAL with the same partition/DN value and the Connection for the monitoring target or agent would be represented by another Address object of type CiscoAddress.MONITORING_TARGET.
OUT_OF_SERVICE
public static final int OUT_OF_SERVICEThe address is in-service
RINGER_DEFAULT
public static final int RINGER_DEFAULTSets the ringer status to configured value
RINGER_DISABLE
public static final int RINGER_DISABLEDisables the ringer for the address
RINGER_ENABLE
public static final int RINGER_ENABLEEnables the ringer for the address
UNKNOWN
public static final int UNKNOWNThis is an external address with an unknown name. An address of this type is created to represent an endpoint for which there is insufficient information.
Methods
clearCallConnections()
public void clearCallConnections()throws PrivilegeViolationExceptionUse this interface to clear off any phantom calls on the address
Throws:
javax.telephony.PrivilegeViolationException
getAddressCallInfo(Terminal)
public com.cisco.jtapi.extensions.CiscoAddressCallInfogetAddressCallInfo(javax.telephony.Terminal iterminal)Use this Interface to get info of calls present at the terminal
getAutoAcceptStatus(Terminal)
public void getAutoAcceptStatus(javax.telephony.Terminal terminal)throws PlatformException, InvalidStateException, MethodNotSupportedException,CiscoAddress.getAutoAccept(Terminal iterminal) returns AutoAccept status of Address on Terminal. It may return one of the following constants: CiscoAddress.AUTOACCEPT_OFF CiscoAddress.AUTOACCEPT_ON.
Pre-conditions:
1.
2.
Post-conditions:
1.
2.
Parameters:
terminal - Terminal on which AutoAccept status of Address will be returned.
Throws:
javax.telephony.InvalidStateException - The Provider is not "in service".
javax.telephony.PlatformException - Terminal is not on the Address.
javax.telephony.MethodNotSupportedException - This method is not supported.
getInServiceAddrTerminals()
public javax.telephony.Terminal[] getInServiceAddrTerminals()Use this interface to find out which Shared Lines are in service. In Shared Lines, the same address appears on different Terminals.
Returns:
an array of terminals on which address is in service
getPartition ()
public string getPartition()
JTAPI uses this partition information to distinguish between addresses which have the same DN but belong to different partitions and sends the partition information to open the specific addresses.
Returns:
partition string of the address object
getRecordingConfig(Terminal term)
int getRecordingConfig(Terminal term)Returns the recording type configured on the address.
Returns:
CiscoAddress.NO_RECORDING
CiscoAddress.AUTO_RECORDING
CiscoAddress.APPLICATION_CONTROLLED_RECORDING
Default Value:
CiscoAddress.NO_RECORDING
getRegistrationState()
public int getRegistrationState()Returns:
the state of this address
The state may be any of the following constants:
•
•
Deprecated
This method has been replaced by the getState() method.
getRestrictedAddrTerminals()
public javax.telephony.Terminal[] getRestrictedAddrTerminals()Returns array of Terminals on which this address is restricted. If none is restricted is restricted, then this method returns null.
In shared lines, few lines on Terminals may be restricted. This method returns all the terminals on which this address is restricted. Applications will not be able to see any call events for restricted lines. If a restricted line is involved in a call with any other control device, an external connection is created for the restricted line.
getState()
public int getState()Returns:
the state of this address
The state may be any of the following constants:
•
•
getType()
public int getType()Returns:
The type of address
The type may be any of the following constants:
•
•
•
•
isRestricted(javax.telephony.Terminal terminal)
public boolean isRestricted(javax.telephony.Terminal terminal)Returns true if an address on this terminal is restricted.
setAutoAcceptStatus(int, Terminal)
public void getAutoAcceptStatus(int autoAcceptStatus, javax.telephony.Terminal terminal)throws PlatformException, InvalidStateException, MethodNotSupportedExceptionThis allows Application to enable AutoAccept for Addresses on CiscoMediaTerminal and/or CiscoRouteTerminal. Addresses on CiscoTerminal other than CiscoMediaTerminal or CiscoRouteTerminal will always have AutoAccept on. If Terminal passed in the parameter is not CiscoMediaTerminal or CiscoRouteTerminal, it will throw exception. For the CiscoMediaTerminal that have Shared Address with CiscoTerminal, it is recommended to enable AutoAccept on CiscoMediaTerminal.
Pre-conditions:
1.
2.
Post-conditions:
1.
2.
Parameters:
value - Can be either CiscoAddress.AUTOACCEPT_OFF or CiscoAddress.AUTOACCEPT_ON. If autoAcceptStatus is AUTOACCEPT_ON, it will enable AutoAccept for address on Terminal. If autoAcceptStatus is AUTOACCEPT_OFF, it will disable AutoAccept for address on Terminal.
terminal. - It the terminal on which AutoAccept will be enabled
Throws:
javax.telephony.InvalidStateException - The Provider is not "in service".
javax.telephony.PlatformException - Terminal is not on the Address.
javax.telephony.MethodNotSupportedException - This method is not supported ExtraProviderAddresses.
setMessageWaiting(java.lang.String destination, boolean enable)
public void setMessageWaiting(java.lang.String destination, boolean enable)throws MethodNotSupportedException, InvalidStateException, PrivilegeViolationExcep tionSpecifies whether the message-waiting indicator should be activated or deactivated for the Address specified by the destination. If enable is true, message-waiting is activated if not already activated. If enable is false, message-waiting is deactivated if not already deactivated.
Preconditions:
1.
Postconditions:
1.
Note
1.
2.
Parameters:
destination - DN whose message waiting indicator should be activated
enable - True to activate message-waiting, false to deactivate.
Throws:
javax.telephony.MethodNotSupportedException - This method is not supported by the given implementation.
javax.telephony.InvalidStateException - The Provider is not "in service".
javax.telephony.PrivilegeViolationException - The Provider user has insufficient privileges to invoke the message waiting indicator for this destination
setRingerStatus(int)
public void setRingerStatus(int status)throws MethodNotSupportedException, InvalidStateException, InvalidArgumentExceptionChanges the ringer status on this address
Accepts on of the following constants: CiscoAddress.RINGER_DEFAULT CiscoAddress.RINGER_DISABLE CiscoAddress.RINGER_ENABLE
Throws:
javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
CiscoAddressCallInfo
Declaration
public class CiscoAddressCallInfojava.lang.Object|+--com.cisco.jtapi.extensions.CiscoAddressCallInfo
Constructors
CiscoAddressCallInfo(int, int, int, int)
public CiscoAddressCallInfo(int inumActiveCalls,int imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold)CiscoAddressCallInfo(int, int, int, int, CiscoCall[])
public CiscoAddressCallInfo(int inumActiveCalls,int imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold, com.cisco.jtapi.extensions.CiscoCall[] icalls)Methods
getCalls()
public com.cisco.jtapi.extensions.CiscoCall[] getCalls()getMaxActiveCalls()
public int getMaxActiveCalls()getMaxCallsOnHold()
public int getMaxCallsOnHold()getNumActiveCalls()
public int getNumActiveCalls()getNumCallsOnHold()
public int getNumCallsOnHold()CiscoAddressObserver
Declaration
public interface CiscoAddressObserver extendsjavax.telephony.AddressObserverAll Superinterfaces
javax.telephony.AddressObserver
Description
Applications implement this interface in order to receive CiscoAddrEv events such as CiscoAddrInServiceEv and CiscoAddrOutOfServiceEv when observing Addresses via the Address.addObserver method.
See Also:
CiscoAddrInServiceEv, CiscoAddrOutOfServiceEv
CiscoAddressRecordingConfigChangedEv
Description/Usage
This event is delivered to the address observer if the record setting on the address is changed.
Methods
getRecordingConfig()
public Int getRecordingConfig()Returns the recording type configured for the address.
getTerminal()
public Terminal getTerminal()Returns the terminal on which the recording type is changed.
CiscoAddrEv
Declaration
public interface CiscoAddrEv extends CiscoEv,javax.telephony.events.AddrEvAll Superinterfaces
javax.telephony.events.AddrEv, CiscoEv, javax.telephony.events.Ev
All Known Subinterfaces
CiscoAddrAutoAcceptStatusChangedEv, CiscoAddrInServiceEv, CiscoAddrOutOfServiceEv
Description
The CiscoAddrEv interface, which extends JTAPI's core javax.telephony.events.AddrEv interface, 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.
See Also:
javax.telephony.events.AddrEv
CiscoAddrInServiceEv
Declaration
public interface CiscoAddrInServiceEv extends CiscoAddrEvAll Superinterfaces
javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, javax.telephony.events.Ev
Description
The CiscoAddrInServiceEv event
Fields
ID
public static final int IDMethods
getTerminal()
public com.cisco.jtapi.extensions.CiscoTerminal getTerminal()Returns the terminal at which this address is going InService
In Shared Lines, applications may receive multiple CiscoAddressInService events and the same Address appears on different Terminals. In order for Application to find out which Shared Line is going in service, Applications can use this interface. This interface returns the terminal on which Address is going in Service.
Returns:
the terminal at which this address is going InService
See Also:
CiscoAddress.getInServiceAddressTerminal()
CiscoAddrOutOfServiceEv
Declaration
public interface CiscoAddrOutOfServiceEv extends CiscoAddrEv,All Superinterfaces
javax.telephony.events.AddrEv,CiscoAddrEv, CiscoEv, CiscoOutOfServiceEv, javax.telephony.events.Ev
Description
The CiscoAddrOutOfServiceEv event
Fields
ID
public static final int IDMethods
getTerminal()
public com.cisco.jtapi.extensions.CiscoTerminal getTerminal()Returns the terminal at which this address is going OutOfService
In Shared Lines, applications may receive multiple CiscoAddressOutOfService events and the same Address appears on different Terminals. Applications use this interface to find out which Shared Line is going out of service.
Returns:
the terminal at which this address is going OutOfService
See Also:
CiscoAddress.getInServiceAddressTerminal()
CiscoAddrRemovedEv
Declaration
public interface CiscoAddrRemovedEv extends CiscoProvEvAll Superinterfaces
CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
Description
The CiscoAddrRemovedEv event
Fields
ID
public static final int IDMethods
getAddress()
public javax.telephony.Address getAddress()CiscoAddrRemovedFromTerminalEv
Declaration
public interface CiscoAddrRemovedEv extends CiscoProvEvAll Superinterfaces
CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
Description
The CiscoAddrRemovedFromTerminalEv event gets sent under the following conditions:
•
•
•
Fields
ID
public static final int IDMethods
getAddress()
public javax.telephony.Address getAddress()getTerminal()
public javax.telephony.Terminal getTerminal()CiscoCall
Declaration
public interface CiscoCall extendsjavax.telephony.callcontrol.CallControlCall, CiscoObjectContainerAll Superinterfaces
javax.telephony.Call, javax.telephony.callcontrol.CallControlCall, CiscoObjectContainer
All Known Subinterfaces
Description
The CiscoCall interface extends the CallControlCall interface with additional Cisco Unified Communications Manager-specific capabilities.
In Cisco Unified Communications Manager terms, 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 via its CallManagerID and CallID properties. Taken together, the CallManagerID and CallID form the global call handle maintained by the Cisco Unified Communications Manager. This pair of properties is 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, it is possible for an INACTIVE Call to have identical CallManagerID and CallID properties to those of a currently ACTIVE Call object.
Two versions of the startMonitor interface allow silent monitoring of calls. Both interfaces return the terminal connection of the monitor initiator created as a result of this request. See startMonitor.
See Also:
javax.telephony.Call
Methods
CiscoCall.CALLSECURITY_ AUTHENTICATED
public int CiscoCall.CALLSECURITY_ AUTHENTICATEDReturns a call security status of Authenticated.
CiscoCall.CALLSECURITY_ ENCRYPTED
public int CiscoCall.CALLSECURITY_ ENCRYPTEDReturns a call security status of Encrypted.
CiscoCall.CALLSECURITY_ NOTAUTHENTICATED
public int CiscoCall.CALLSECURITY_ NOTAUTHENTICATEDReturns a call security status of Not Authenticated.
CiscoCall.CALLSECURITY_UNKNOWN
public int CiscoCall.CALLSECURITY_UNKNOWNReturns a call security status of Unknown.
CiscoCall.FEATUREPRIORITY_NORMAL, CiscoCall.FEATUREPRIORITY_URGENT, CiscoCall.FEATUREPRIORITY_EMERGENCY
public int CiscoCall.FEATUREPRIORITY_NORMAL, CiscoCall.FEATUREPRIORITY_URGENT, CiscoCall.FEATUREPRIORITY_EMERGENCYSets feature Priority.
CiscoCall.PlayTone_NoLocalOrRemote, CiscoCall.PlayTone_LocalOnly, CiscoCall.PlayTone_RemoteOnly, CiscoCall.PlayTone_BothLocaland Remote
public int CiscoCall.PlayTone_NoLocalOrRemote, CiscoCall.PlayTone_LocalOnly, CiscoCall.PlayTone_RemoteOnly, CiscoCall.PlayTone_BothLocaland RemoteThis interface is used by the application in a startMonitor request to specify the parties to which a tone is played to indicate monitoring.
conference(Call[])
public voidconverence(javax.telephony.Call[] otherCalls)Throws:
InvalidStateException, InvalidArgumentException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableException
Merges N Calls together, resulting in the union of the participants of all the Calls being placed on a single Call. This method takes list of Calls as argument, referred to hereafter as the "secondary" Calls. All of the participants from the secondary call are moved to the Call on which this method is invoked.
The Conference Controller
In order for the conferencing feature to happen, there must be a common participant to all the Calls, as represented by a single Terminal and multiple TerminalConnections, one on all of the Calls. These TerminalConnections are known as the conference controllers. In the real-world, only one of the Calls would be active with respect to the controlling Terminal, and hence, the TerminalConnection on the secondary Call should be in the CallControlTerminalConnection.HELD state. The N conference controlling TerminalConnections are merged into one as a result of this method.
Applications can control which TerminalConnection acts as the conference controller when setting up a conference call via the CallControlCall.setConferenceController() method. The CallControlCall.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. Only the original conference controller can add new parties to a conference call. Attempting to change the conference controller while a conference is going on will not take effect; however, no error gets thrown in the "setConferenceController" API.
The Telephone Call Argument
All of the participants from the secondary Calls, passed as the argument to this method, are "moved" to the Call on which this method was invoked. That is, new Connections and TerminalConnections are created on this Call which are found on the secondary Calls. Those Connections and TerminalConnections on the secondary Calls are removed from the Call and the Call moves into the Call.INVALID state.
The conference controller TerminalConnections are merged into one on this Call. That is, the existing TerminalConnection controller on this Call remains unchanged, while the TerminalConnection on the secondary Calls gets removed from that Call.
Other Shared Participants
There may exist Address and Terminals which are part of some telephone calls in addition to the designated conference controller. In these instances, those participants which are shared between both Calls are merged into one. That is, the Connections and TerminalConnections on this Calls are left unchanged. The corresponding Connections and TerminalConnections on the secondary Calls are 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:
otherCall - The second Call which to merge with this Call object.
Throws:
javax.telephony.InvalidArgumentException - The Call object provided is not valid for the conference
javax.telephony.InvalidStateException - Either the Provider is not "in service", the Call is not "active", or the conference controllers are not in the proper state.
javax.telephony.MethodNotSupportedException - This method is not supported by the implementation.
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 not available.
See Also:
javax.telephony.events.ConnCreatedEv, javax.telephony.events.TermConnCreatedEv, javax.telephony.events.ConnDisconnectedEv, javax.telephony.events.TermConnDroppedEv, javax.telephony.events.CallInvalidEv, javax.telephony.callcontrol.events.CallCtlConnDisconnectedEv, javax.telephony.callcontrol.events.CallCtlTermConnDroppedEv
connect(Terminal, Address, String, CiscoRTPParams)
public javax.telephony.Connection[]connect(javax.telephony.Terminal origterm, javax.telephony.Address origaddr, java.lang.String dialedDigits, com.cisco.jtapi.extensions.CiscoRTPParams rtpParams)throws ResourceUnavailableException, PrivilegeViolationException, InvalidPartyException, InvalidArgumentException, InvalidStateException, MethodNotSup portedExceptionFrom CallEvent perspective, this method behaves similar to Call.connect(Terminal terminal, Address origaddr, String dialedDigits). This method may only be invoked when making a call from CiscoMediaTerminal want to specify media parameters for this call. Establishes the media at the specified CiscoRTPParams parameters if the request is successful.
Throws:
javax.telephony.MethodNotSupportedException, javax.telephony.InvalidStateException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidPartyException, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailableException
getCalledAddressPI()
public boolean getCallAddressPI()Returns Presentation Indicator (PI) associated with getCalledAddressPI. If it returns true, Application can display this address name to the end users. If it returns false, Application should not display this Address name to the end user.
getCallID()
public com.cisco.jtapi.extensions.CiscoCallID getCallID()CallID is a unique identifier among all ACTIVE calls with the same CallManagerID.
Returns:
the CallID property of this Call
getCalledPartyInfo()
CiscoPartyInfo getCalledPartyInfo()Returns CalledPartyInfo object.
getCallingAddressPI()
public boolean getCallingAddressPI()Returns Presentation Indicator (PI) associated with getCallingAddressPI. If it returns true, Application can display this address name to the end users. If it returns false, Application should not display this Address name to the end user.
getCallSecurityStatus()
public int getCallSecurityStatus()Returns the call security status of the call (0-UNKNOWN, 1-NOTAUTHENTICATED, 2-AUTHENTICATED, 3-ENCRYPTED).
getConferenceChain
CiscoConferenceChain getConferenceChain()This interface returns a CiscoConferenceChain object if this call is a chained conference call. Otherwise, this interface returns null.
getCurrentCalledAddress()
public javax.telephony.Address getCurrentCalledAddress()This interface returns current calling address for the call this will return updated called address every time call gets redirected or transferred.
For example, in the CiscoJtapi implementation, CallControlCall.getCalledAddress() returns the first called party of the call.
getCurrentCalledAddressPI()
public javax.telephony.Address getCurrentCalledAddressPI()Returns Presentation Indicator (PI) associated with getCalledAddressPI. If it returns true, Application can display this address name to the end users. If it returns false, Application should not display this Address name to the end user.
getCurrentCalledDisplayNamePI()
public boolean getCurrentCalledDisplayNamePI()Returns Presentation Indicator (PI) associated with CurrentCalledAddress. If it returns true, Application can display this address name to the end users. If it returns false, Application should not display this Address name to the end user.
getCurrentCalledPartyDisplayName()
public java.lang.String getCurrentCalledPartyDisplayName()This interface returns the display of the called party in the call. It returns null if display name is unknown.
getCurrentCalledPartyInfo()
CiscoPartyInfo getCurrentCalledPartyInfo()This interface returns the PartyInfo of the current called party of the call.
getCurrentCallingAddress()
public javax.telephony.Address getCurrentCallingAddress()This interface returns current called address for the call this will return updated calling address every time call is redirected or transferred
Note
Usage:if ( call instanceof CiscoCall ) {Address currentCalled = ((CiscoCall)call).getCurrentCalling ();}See Also:
javax.telephony.callcontrol.CallControlCall
getCurrentCallingAddressPI()
public boolean getCurrentCallingAddressPI()Returns Presentation Indicator(PI) associated with getCurrentCallingAddress. If it returns true, Application can display this Address to end users. If it returns false, Applications should not display this Address name to end user
getCurrentCallingDisplayNamePI()
public boolean getCurrentCallingDisplayNamePI()Returns Presentation Indicator(PI) associated with getCurrentCalledDisplayNamePI. If it returns true, Application can display this DisplayName to end users. If it returns false, Applications should not display this DisplayName to end user
getCurrentCallingPartyDisplayName()
public java.lang.String getCurrentCallingPartyDisplayName()This interface returns the display name of the calling party. It returns null if display name is unknown.
getLastRedirectedPartyInfo()
CiscoPartyInfo getLastRedirectedPartyInfo()This interface returns the PartyInfo of the last redirecting party of the call.
getLastRedirectingAddressPI()
public boolean getLastRedirectingAddressPI()Returns Presentation Indicator(PI) associated with getLastRedirectingAddressPI. If it returns true, Application can display this Address name to end users. If it returns false, Applications should not display this Address name to end user
getModifiedCalledAddress()
public javax.telephony.Address getModifiedCalledAddress()This interface returns modified called address for the call if an application modifies its calling party using from selectRoute API. However, this information may not be accurate if an application is only controlling the Route Point that is modifying the calling number. If no modified calling number is performed, this is similar to getCurrentCalledAddress interface. Typically, this is varied from getCurrentCalledAddress when a feature is invoked after modified calling number modifications.
Usage:
if ( call instanceof CiscoCall ) {Address currentCalled = ((CiscoCall)call).getModifiedCalledAddress ();}See Also:
javax.telephony.callcontrol.CallControlCall
getModifiedCallingAddress()
public javax.telephony.Address getModifiedCallingAddress()This interface returns modified calling address for the call if an application modifies its calling party using from selectRoute API. However, this information may not be accurate if an application is only controlling the RP that is modifying the calling number. If no modified calling number is performed, this is similar to getCurrentCallingAddress interface.
Usage:
if ( call instanceof CiscoCall ) {Address currentCalled = ((CiscoCall)call).getModifiedCallingAddress ();}See Also:
javax.telephony.callcontrol.CallControlCall
startMonitor
public connection[] startMonitor(terminal MonitorInitiatorterminal, Address MonitorInitiatoraddress, TerminalConnection termConnofMonitorTarget, int monitorType, int PlayToneDirection)public connection[] startMonitor(terminal MonitorInitiatorterminal, Address monitorInitiatoraddress, int monitorTargetcallid, String monitorTargetDN, String monitorTargetTerminalName, int monitorType, int PlayToneDirection)If an application already has a callObserver on the monitor target, the application can begin monitoring the call by specifying the monitor target terminal connection as shown in the first interface above.
If an application is not monitoring the monitor target, the application can use the second method to begin monitoring a call by specifying the terminal, the address, and the integer value of the connectionID of the monitor target.
To stop monitoring, the application can drop the call at the monitor initiator. This will have no impact on the monitored call at the monitor target.
Preconditions for startMonitor:
–
–
Post condition for startMonitor:
–
Parameters:
MonitorInitiatorterminal: the terminal from which the application would like to monitor a call on the monitor target.
MonitorInitiatoraddress: the address from which application would like to monitor a call on the monitor target.
MonitorTargetCallID: an intValue() from the CiscoConnectionID of the connection on the monitor target. The application should have the monitor target in its control list or get this from an application which has the monitor target in its control list.
MonitorTargetDN: the DN of the monitor target, which has the monitored call.
MonitorTargetTerminalName: The name of the monitor target device.
MonitorType: the type of monitor. Only Silent_Monitor is supported in this version.
PlayToneDirection: indicates whether a tone needs to be played to the target, the initiator, or both. The value should be one of CiscoCall.PlayTone_NoLocalOrRemote, CiscoCall.PlayTone_LocalOnly, CiscoCall.PlayTone_RemoteOnly, or CiscoCall.PlayTone_BothLocalandRemote.
transfer(String, String, String)
javax.telephony.Connection transfer(java.lang.String destinationAddress, java.lang.String facCode, java.lang.String cmcCode)This method overloads the CallControlCall.transfer(String) method. It takes two new parameters: facCode and cmcCode. The facCode is the forced authorization code (FAC), and cmcCode is the client matter code (CMC).
See Also:
javax.telephony.callcontrol.CallControlCall
CiscoCallChangedEv
Declaration
public interface CiscoCallChangedEv extends CiscoCallEv, javax.telephony.events.CallEvAll Superinterfaces
javax.telephony.events.CallEv, CiscoCallEv, javax.telephony.events.Ev
Description
The CiscoCallChangedEv event is delivered to the call observer for all supported features whenever the Global Call ID (GCID) of the call changes. In previous releases, CiscoCallChangedEv was delivered only when the GCID of the call was changed due to path replacement (QSIG_PR). Starting with this release CiscoCallChangedEv will be delivered for other features (transfer, conference, barge, cbarge, unpark) as well. In the case of shared lines, multiple CiscoCallChangedEv events would be delivered.
When the GCID of the call changes, GlobalCallHandleChangedEvent is received from CTI.
This event is also delivered when two or more calls are merged into one. Transfer, conference, unpark, Barge, and CBarge are features that will cause this event to be delivered. In addition to the current interfaces on this event, getCiscoFeatureReason() will return the feature code defined in the CiscoFeatureReason interface.
Methods
getSurvivingCall()
public com.cisco.jtapi.extensions.CiscoCall getSurvivingCall()Returns a reference to the new call, which would be the surviving call.
getOriginalCall()
public com.cisco.jtapi.extensions.CiscoCall getOriginalCall()Returns a reference to the old call, which will go to INVALID state.
getCiscoCause()
public int getCiscoCause()Returns CiscoCallEv.CAUSE_QSIG_PR when the GCID is changed by QSIG path replacement.
getCiscoFeatureReason()
public int getCiscoFeatureReason()Returns the feature that caused the event. The reasons returned by this method are defined in CiscoFeatureReason.
Caution
getConnection()
public com.cisco.jtapi.extensions.CiscoConnection getConnection()Returns the connection of the call on which the change has occurred.
getTerminalConnection()
public javax.telephony.TerminalConnection getTerminalConnection()Returns the terminal connection of the call on which the GCID has changed. A Null is returned if there is no terminal connection.
CiscoCallCtlTermConnHeldReversionEv
Declaration
public interface CiscoCallCtlTermConnHeldReversionEvDescription/Usage
The CiscoCallCtlTermConnHeldReversionEv event indicates that hold reversion notification has been received on the TerminalConnection from Cisco Unified Communications Manager.
ID
static final int IDCiscoCallCtlConnOfferedEv
Declaration
public interface CiscoCallCtlConnOfferedEvextends javax.telephony.callcontrol.events.CallCtlConnOfferedEvDescription/Usage
Applications can use this method to obtain the IP address of the calling party device.
The IP address information might not be available for all calling party devices. A return value of 0 indicates that the information is not available.
Methods
getCallingPartyIpAddr()
public InetAddress getCallingPartyIpAddr()Returns the IP address of the calling party, or 0 if the address is not available.
CiscoCallEv
Declaration
public interface CiscoCallEv extends CiscoEv,javax.telephony.events.CallEvAll Superinterfaces
javax.telephony.events.CallEv, CiscoEv, javax.telephony.events.Ev
All Known Subinterfaces
CiscoConferenceEndEv, CiscoConferenceStartEv, CiscoConsultCallActiveEv, CiscoTransferEndEv, CiscoTransferStartEv, CiscoCallChangedEv
Description
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.
See Also:
javax.telephony.events.CallEv
Fields
CAUSE_ACCESSINFORMATIONDISCARDED
public static final int CAUSE_ACCESSINFORMATIONDISCARDEDCAUSE_BARGE
public static final int CAUSE_BARGECAUSE_BCBPRESENTLYAVAIL
public static final int CAUSE_BCBPRESENTLYAVAILCAUSE_BCNAUTHORIZED
public static final int CAUSE_BCNAUTHORIZEDCAUSE_BEARERCAPNIMPL
public static final int CAUSE_BEARERCAPNIMPLCAUSE_CALLBEINGDELIVERED
public static final int CAUSE_CALLBEINGDELIVEREDCAUSE_CALLIDINUSE
public static final int CAUSE_CALLIDINUSECAUSE_CALLMANAGER_FAILURE
public static final int CAUSE_CALLMANAGER_FAILURECAUSE_CALLREJECTED
public static final int CAUSE_CALLREJECTEDCAUSE_CALLSPLIT
public static final int CAUSE_CALLSPLITCAUSE_CHANTYPENIMPL
public static final int CAUSE_CHANTYPENIMPLCAUSE_CHANUNACCEPTABLE
public static final int CAUSE_CHANUNACCEPTABLECAUSE_CTIMANAGER_FAILURE
public static final int CAUSE_CTIMANAGER_FAILURECAUSE_DESTINATIONOUTOFORDER
public static final int CAUSE_DESTINATIONOUTOFORDERCAUSE_DESTNUMMISSANDDCNOTSUB
public static final int CAUSE_DESTNUMMISSANDDCNOTSUBCAUSE_DEVICE_RESTRICTED
public static final int CAUSE_DEVICE_RESTRICTEDCAUSE_FACILITYREJECTED
public static final int CAUSE_FACILITYREJECTEDCAUSE_IDENTIFIEDCHANDOESNOTEXIST
public static final int CAUSE_IDENTIFIEDCHANDOESNOTEXISTCAUSE_IENIMPL
public static final int CAUSE_IENIMPLCAUSE_INBOUNDBLINDTRANSFER
public static final int CAUSE_INBOUNDBLINDTRANSFERCAUSE_INBOUNDCONFERENCE
public static final int CAUSE_INBOUNDCONFERENCECAUSE_INBOUNDTRANSFER
public static final int CAUSE_INBOUNDTRANSFERCAUSE_INCOMINGCALLBARRED
public static final int CAUSE_INCOMINGCALLBARREDCAUSE_INCOMPATABLEDDESTINATION
public static final int CAUSE_INCOMPATABLEDDESTINATIONCAUSE_INTERWORKINGUNSPECIFIED
public static final int CAUSE_INTERWORKINGUNSPECIFIEDCAUSE_INVALIDCALLREFVALUE
public static final int CAUSE_INVALIDCALLREFVALUECAUSE_INVALIDIECONTENTS
public static final int CAUSE_INVALIDIECONTENTSCAUSE_INVALIDMESSAGEUNSPECIFIED
public static final int CAUSE_INVALIDMESSAGEUNSPECIFIEDCAUSE_INVALIDNUMBERFORMAT
public static final int CAUSE_INVALIDNUMBERFORMATCAUSE_INVALIDTRANSITNETSEL
public static final int CAUSE_INVALIDTRANSITNETSELCAUSE_LINE_RESTRICTED
public static final int CAUSE_LINE_RESTRICTEDCAUSE_MANDATORYIEMISSING
public static final int CAUSE_MANDATORYIEMISSINGCAUSE_MSGNCOMPATABLEWCS
public static final int CAUSE_MSGNCOMPATABLEWCSCAUSE_MSGTYPENCOMPATWCS
public static final int CAUSE_MSGTYPENCOMPATWCSCAUSE_MSGTYPENIMPL
public static final int CAUSE_MSGTYPENIMPLCAUSE_NETOUTOFORDER
public static final int CAUSE_NETOUTOFORDERCAUSE_NOANSWERFROMUSER
public static final int CAUSE_NOANSWERFROMUSERCAUSE_NOCALLSUSPENDED
public static final int CAUSE_NOCALLSUSPENDEDCAUSE_NOCIRCAVAIL
public static final int CAUSE_NOCIRCAVAILCAUSE_NOERROR
public static final int CAUSE_NOERRORCAUSE_NONSELECTEDUSERCLEARING
public static final int CAUSE_NONSELECTEDUSERCLEARINGCAUSE_NORMALCALLCLEARING
public static final int CAUSE_NORMALCALLCLEARINGCAUSE_NORMALUNSPECIFIED
public static final int CAUSE_NORMALUNSPECIFIEDCAUSE_NOROUTETODDESTINATION
public static final int CAUSE_NOROUTETODDESTINATIONCAUSE_NOROUTETOTRANSITNET
public static final int CAUSE_NOROUTETOTRANSITNETCAUSE_NOUSERRESPONDING
public static final int CAUSE_NOUSERRESPONDINGCAUSE_NUMBERCHANGED
public static final int CAUSE_NUMBERCHANGEDCAUSE_ONLYRDIVEARERCAPAVAIL
public static final int CAUSE_ONLYRDIVEARERCAPAVAILCAUSE_OUTBOUNDCONFERENCE
public static final int CAUSE_OUTBOUNDCONFERENCECAUSE_OUTBOUNDTRANSFER
public static final int CAUSE_OUTBOUNDTRANSFERCAUSE_PROTOCOLERRORUNSPECIFIED
public static final int CAUSE_PROTOCOLERRORUNSPECIFIEDCAUSE_QUALOFSERVNAVAIL
public static final int CAUSE_QUALOFSERVNAVAILCAUSE_RECOVERYONTIMEREXPIRY
public static final int CAUSE_RECOVERYONTIMEREXPIRYCAUSE_REDIRECTED
public static final int CAUSE_REDIRECTEDCAUSE_REQCALLIDHASBEENCLEARED
public static final int CAUSE_REQCALLIDHASBEENCLEAREDCAUSE_REQCIRCNAVIL
public static final int CAUSE_REQCIRCNAVILCAUSE_REQFACILITYNIMPL
public static final int CAUSE_REQFACILITYNIMPLCAUSE_REQFACILITYNOTSUBSCRIBED
public static final int CAUSE_REQFACILITYNOTSUBSCRIBEDCAUSE_RESOURCESNAVAIL
public static final int CAUSE_RESOURCESNAVAILCAUSE_RESPONSETOSTATUSENQUIRY
public static final int CAUSE_RESPONSETOSTATUSENQUIRYCAUSE_SERVNOTAVAILUNSPECIFIED
public static final int CAUSE_SERVNOTAVAILUNSPECIFIEDCAUSE_SERVOPERATIONVIOLATED
public static final int CAUSE_SERVOPERATIONVIOLATEDCAUSE_SERVOROPTNAVAILORIMPL
public static final int CAUSE_SERVOROPTNAVAILORIMPLCAUSE_SUSPCALLBUTNOTTHISONE
public static final int CAUSE_SUSPCALLBUTNOTTHISONECAUSE_SWITCHINGEQUIPMENTCONGESTION
public static final int CAUSE_SWITCHINGEQUIPMENTCONGESTIONCAUSE_TEMPORARYFAILURE
public static final int CAUSE_TEMPORARYFAILURECAUSE_UNALLOCATEDNUMBER
public static final int CAUSE_UNALLOCATEDNUMBERCAUSE_USERBUSY
public static final int CAUSE_USERBUSYREASON_BARGE
public static final int REASON_BARGEREASON_BLINDTRANSFER
public static final int REASON_BLINDTRANSFERREASON_CALLPICKUP
public static final int REASON_CALLPICKUPREASON_CM_REDIRECTION
public static final int REASON_CM_REDIRECTIONREASON_CONFERENCE
public static final int REASON_CONFERENCEREASON_FAC_CMC
public static final int REASON_FAC_CMCREASON_FORWARDALL
public static final int REASON_FORWARDALLREASON_FORWARDBUSY
public static final int REASON_FORWARDBUSYREASON_FORWARDNOANSWER
public static final int REASON_FORWARDNOANSWERREASON_IMMDIVERT
public static final int REASON_IMMDIVERTREASON_NORMAL
public static final int REASON_NORMALREASON_PARK
public static final int REASON_PARKREASON_PARKREMAINDER
public static final int REASON_PARKREMAINDERREASON_QSIG_PR
public static final int REASON_QSIG_PRREASON_REDIRECT
public static final int REASON_REDIRECTREASON_REFER
public static final int REASON_REFERREASON_TRANSFER
public static final int REASON_TRANSFERREASON_UNPARK
public static final int REASON_UNPARKMethods
getCiscoCause()
public int getCiscoCause()Returns the Cisco Unified Communications Manager cause for this event.
In order to function properly, some applications need to know the reason why an event happened at an endpoint that the application is observing. For example, a Connection may be disconnected because the call was not answered (CAUSE_NOANSWERFROMUSER), or whether the caller it was disconnected because it was rejected (CAUSE_CALLREJECTED).
getCiscoFeatureReason
public int getCiscoFeatureReason()Returns the Cisco Unified Communications Manager Feature Reason for this event.
In order to function properly, some applications need to know the reason why an event happened. This interface provides the CiscoFeatureReason in JTAPI Call events for current and new features. Existing features, such as transfer, will continue to receive the CiscoCause provided by interface current CiscoCallEv.getCiscoCause(), while this interface will provide REASON_TRANSFER for transfer.
Caution
getCurrentCalledPartyUnicodeDisplayName()
public java.lang.String getCurrentCalledPartyUnicodeDisplayName()Returns the Unicode display name of the current called party in the call.
getCurrentCalledPartyUnicodeDisplayNamelocale()
public int getCurrentCalledPartyUnicodeDisplayNamelocale()Returns the locale of the current called party Unicode display name. The CiscoLocales interface lists the supported locales.
getCurrentCallingPartyUnicodeDisplayName()
public java.lang.String getCurrentCallingPartyUnicodeDisplayName()Returns the Unicode display name of the current calling party in the call.
getCurrentCallingPartyUnicodeDisplayNamelocale()
public int getCurrentCallingPartyUnicodeDisplayNamelocale()Returns the locale of the current calling party Unicode display name. The CiscoLocales interface lists the supported locales.
CiscoCallID
Declaration
public interface CiscoCallID extends CiscoObjectContainerAll Superinterfaces
Description
The CiscoCallID object represents a unique object associated with each call. Applications may use the object itself or the integer representation of the object returned by the intValue() method.
Methods
getCall()
public com.cisco.jtapi.extensions.CiscoCall getCall()getCallManagerID()
public int getCallManagerID()returns the call manager nodeID of the call
getGlobalCallID()
public int getGlobalCallID()returns the GlobalCallID of the call
intValue()
public int intValue()Returns an integer representation of this object, currently a bitwise OR of the CallManagerID and GlobalCallID properties (shifted and truncated appropriately)
Returns:
an integer representation of this object
CiscoCallSecurityStatusChangedEv
Description/Usage
Applications receive this event when the overall call security status changes.
Methods
getCallSecurityStatus()
public int getCallSecurityStatus()Returns the call security status of the call.
callSecurityStatus
public int callSecurityStatusRange of Values
0 - CiscoCall.CALLSECURITY_UNKNOWN
1- CiscoCall.CALLSECURITY _NOTAUTHENTICATED
2 - CiscoCall.CALLSECURITY _AUTHENTICATED
3 - CiscoCall. CALLSECURITY _ENCRYPTED
Default Value
1 - CiscoCall.CALLSECURITY_ NOTAUTHENTICATED
CiscoConferenceChain
Declaration
public interface CiscoConferenceChainDescription/Usage
This interface provides links to conference chain connections for the conference calls that are linked together in a conference chain. This object will be provided in CiscoConferenceChainAddedEv and CiscoConferenceChainRemovedEv.
Methods
getChainedConferenceConnections()
javax.telephony.Connection[] getChainedConferenceConnections()This interface returns a list of connections for conference calls that are chained together in a single conference. With the list of connection, applications can get all of the conference calls that are linked together. To get the list of connections for all the calls that are chained together in conference, the provider must have an observer on at least one party in the every conference call.
getChainedConferenceCalls()
CiscoCall[] getChainedConferenceCalls()This interface returns a list of calls that are chained together in a single conference. This interface returns only those calls in that are in the chain conference and are also observed in the provider.
CiscoConferenceChainAddedEv
Declaration
public interface CiscoConferenceChainAddedEvDescription/Usage
The CiscoConferenceChainAddedEv event indicates that a conference chain connection has been added to the call. This event is provided every time a new conference chain connection is added. This event is reported via theCallControlCallObserver interface.
Fields
ID
static final int IDMethods
getAddedConnection
javax.telephony.Connection getAddedConnection()This interface returns the conference chain connection that has been added to the call.
getConferenceChain
CiscoConferenceChain getConferenceChain()This interface returns the CiscoConferenceChain that contains all the conference connections for the calls that are linked together.
CiscoConferenceChainRemovedEv
Declaration
public interface CiscoConferenceChainRemovedEvextends CiscoCallEvDescription/Usage
The CiscoConferenceChainRemovedEv event indicates that a conference chain connection has been removed from the call. This event is provided whenever a conference chain connection is removed. This event is reported via theCallControlCallObserver interface.
Fields
ID
static final int IDMethods
getRemovedConnection
javax.telephony.Connection getRemovedConnection()This interface returns the conference chain Connection that is just removed from the call.
getConferenceChain
CiscoConferenceChain getConferenceChain()This interface returns the CiscoConferenceChain that contains all the conference connections for the calls that are linked together.
CiscoConferenceEndEv
Declaration
public interface CiscoConferenceEndEv extends CiscoCallEvAll Superinterfaces
javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev
Description
The CiscoConferenceEndEv event indicates that a transfer operation has completed. This event is reported via the CallControlCallObserver interface.
Fields
ID
static int IDMethods
getConferenceControllerAddress()
public javax.telephony.Address getConferenceControllerAddress()Returns the Address which currently acts as the conference controller for this call —- the initiating call.
getConferencedCall()
public javax.telephony.Call getConferencedCall()Returns the call that has been merged. This call is in the Call.INVALID state.
getFailedCalls()
public favax.telephony.Call[] getFailedCalls{}Returns the list of the calls that could not be conferenced.
Returns:
Null, if conference is successful.
See Also:
getFinalCall()
public javax.telephony.Call getFinalCall()Returns the call that remains active after the conference is completed.
getHeldConferenceController()
public javax.telephony.TerminalConnectiongetHeldConferenceController()Returns the TerminalConnection which currently acts as the conference controller for this call —- the final call. This is the TerminalConnection that was in HELD state when conference was initiated. This method returns null if the conference controller is not being observed.
getHeldConferenceControllers()
public javax.telephony.TerminalConnection[]getHeldConferenceControllers()Returns the TerminalConnection which currently acts as the conference controller for this call: the initiating call. This is the TerminalConnection that was in the HELD state. This method returns null if the conference controller is not being observed. This method returns the first held Controller for multiple call join scenario.
getTalkingConferenceController()
public javax.telephony.TerminalConnectiongetTalkingConferenceController()Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in TALKING state. This method returns null if the conference controller is not being observed.
isSuccess()
public boolean isSuccess()Returns True or False depending on whether the Conference successful or failed. Application can use interface to find whether Conference is successful.
The following are defined as Conference Fail:
•
•
•
CiscoConferenceStartEv
Declaration
public interface CiscoConferenceStartEv extends CiscoCallEvAll Superinterfaces
javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev
Description
The CiscoConferenceStartEv event indicates that a conference operation has started. This event is reported via the CallControlCallObserver interface.
Fields
ID
public static final int IDMethods
getConferenceControllerAddress()
public javax.telephony.Address getConferenceControllerAddress()Returns the Address which currently acts as the conference controller for this call —- the initiating call.
getConferencedCall()
public javax.telephony.Call getConferencedCall()Returns the call that will be conferenced. This is the call that will be merged into the initiating call.
getConferencedCalls()
public javax.telephony.Call getConferencedCalls()Returns the list of calls that will be conferenced. This is the call that will be merged into the final call.
getFinalCall()
public javax.telephony.Call getFinalCall()Returns the call that will remain active after the conference is completed. This is the call all calls are finally merged into.
getHeldConferenceController()
public javax.telephony.TerminalConnectiongetHeldConferenceController()Returns the TerminalConnection that currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in HELD state. This method returns null if the conference controller is not being observed.
getHeldConferenceControllers()
public javax.telephony.TerminalConnectiongetHeldConferenceControllers()Returns the TerminalConnection that currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in HELD state. This method returns null if the conference controller is not being observed. This method returns all held controllers joining into the finalCall.
getOriginalConferenceControllerAddress()
public javax.telephony.Address getOriginalConferenceControllerAddress()Returns the address of the participant that initiated the conference.
getTalkingConferenceController()
public javax.telephony.TerminalConnectiongetTalkingConferenceController()Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in TALKING state. This method returns null if the conference controller is not being observed.
CiscoConnection
Declaration
public interface CiscoConnection extendsjavax.telephony.callcontrol.CallControlConnection, CiscoObjectContainerAll Superinterfaces
javax.telephony.callcontrol.CallControlConnection, CiscoObjectContainer, javax.telephony.Connection
Description
The CiscoConnection interface extends the CallControlConnection interface with additional Cisco Unified Communications Manager-specific capabilities.
Applications can use the getReason method to obtain the reason for the creation of this Connection.
Fields
ADDRESS_SEARCH_SPACE
public static final int ADDRESS_SEARCH_SPACEThis indicates that the redirect should be done using the search space of the redirect controller's address.
CALLED_ADDRESS_DEFAULT
public static final int CALLED_ADDRESS_DEFAULTThis option indicates that the default behavior for Cisco Unified JTAPI should apply. Cisco Unified JTAPI's default behavior is the same as CALLED_ADDRESS_UNCHANGED.
CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION
public static final int CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATIONThis option indicates that the calledAddress should be reset to the redirect destination.
CALLED_ADDRESS_UNCHANGED
public static final int CALLED_ADDRESS_UNCHANGEDThis option indicates that the calledAddress should remain unchanged after the redirect operation.
CALLINGADDRESS_SEARCH_SPACE
public static final int CALLINGADDRESS_SEARCH_SPACEThis indicates that the redirect should be done using the search space of the calling address.
DEFAULT_SEARCH_SPACE
public static final int DEFAULT_SEARCH_SPACEThis indicates that the redirect should be done using the search space that is the default for the implementation. The default is to use the calling address's search space.
REASON_DIRECTCALL
public static final int REASON_DIRECTCALLThis Connection was the result of a direct call.
REASON_FORWARDALL
public static final int REASON_FORWARDALLThis Connection was the result of unconditional forwarding.
REASON_FORWARDBUSY
public static final int REASON_FORWARDBUSYThis Connection was the result of a forwarding on busy.
REASON_FORWARDNOANSWER
public static final int REASON_FORWARDNOANSWERThis Connection was the result of a forwarding on no answer.
REASON_OUTBOUND
public static final int REASON_OUTBOUNDThis Connection is an originating Connection, not a destination Connection.
REASON_REDIRECT
public static final int REASON_REDIRECTThis Connection was the result of a redirection.
REASON_TRANSFERREDCALL
public static final int REASON_TRANSFERREDCALLThis Connection was the result of a transfer.
REDIRECT_DROP_ON_FAILURE
public static final int REDIRECT_DROP_ON_FAILUREThis redirect mode instructs the implementation to perform redirect without checking the validity or availability of the destination. The original call will be dropped if the destination is not valid or if it's busy.
REDIRECT_NORMAL
public static final int REDIRECT_NORMALThis redirect mode instructs the implementation to perform redirect if the destination is valid and available. Otherwise, the request will return error. The original call will not be dropped on failure.
Methods
getAddressPI()
public boolean getAddressPI()Returns Presentation Indicator(PI) associated with Address on which the connection is created. If it returns true, Application can display this Address Name to end users. If it returns false, Applications should not display this Address Name to end user
getConnectionID()
public com.cisco.jtapi.extensions.CiscoConnectionID getConnectionID()CiscoConnectionID is a unique object that identifier among all ACTIVE calls with the same CallManagerID.
Returns:
the CallID property of this Call
getReason()
public int getReason()Returns the reason for the creation of this Connection.
In order to function properly, some applications need to know the reason why a Connection is created at an endpoint that the application is observing. For example, a voice mail application may want to know whether a caller is someone that wants to leave a message in a voice mailbox (REASON_FORWARDNOANSWER), or whether the caller is trying to access a voice mail box (REASON_DIRECTCALL).
The reason for a Connection creation may be any of the following constants:
· CiscoConnection.REASON_DIRECTCALL· CiscoConnection.REASON_TRANSFERREDCALL· CiscoConnection.REASON_FORWARDNOANSWER· CiscoConnection.REASON_FORWARDBUSY· CiscoConnection.REASON_FORWARDALL· CiscoConnection.REASON_REDIRECT· CiscoConnection.REASON_NORMALAll of the reasons except for REASON_TRANSFERORIGINATION and REASON_NORMAL are associated with inbound, or destination Connections. The REASON_NORMAL reason is associated without outbound, or originating Connections.
Returns:
the reason for the creation of this Connection
getRedirectController()
public javax.telephony.TerminalConnection getRedirectController()Returns the current redirectController for the connection.
park()
public java.lang.String park()throws InvalidArgumentException, PrivilegeViolationException,ResourceUnavailableException, InvalidStateExceptionThis method parks the call at a system park port and returns the address of the port. The call can be unparked using this address.
Throws:
javax.telephony.InvalidStateException, javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidArgumentException
redirect(String, int, int, int, String, String, String, int)
redirect( String destinationAddress, int mode, int callingSearchSpace, int calledAddressOption, String preferredOriginalCalledParty, String facCode, String cmcCode, int featurePriority )Extends CallControlConnection and CiscoObjectContainer.This method overloads redirect() with the featurePriority parameter.
Range of Values:
The featurePriority parameter can take the following values:
–
–
–
Default Value:
CiscoCall.FEATUREPRIORITY_NORMAL
redirect(String, int)
public javax.telephony.Connection redirect(java.lang.StringdestinationAddress, int mode)throws InvalidStateException, InvalidPartyException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableExceptionThis method overloads the CallControlConnection.redirect() method. It takes a new parameter —- redirectMode. When this parameter is:
1.
2.
Throws:
javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException
redirect(String, int, int)
public javax.telephony.Connection redirect(java.lang.StringdestinationAddress, int mode, int callingSearchSpace) throws InvalidStateException, InvalidPartyException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableExceptionThis method overloads the CallControlConnection.redirect() method. It takes two new parameters —- redirectMode and callingSearchSpace. The redirectMode is used to select which type of redirect to perform, and the callingSearchSpace is used to instruct the implementation to use either the calling party's search space or the redirect controller's search space.
The redirectMode parameter may be:
1.
2.
Read above for a description of what each of these means.
The callingSearchSpace parameter may be:1.
2.
3.
Note
Throws:
javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException
redirect(String, int, int, int)
public javax.telephony.Connection redirect(java.lang.StringdestinationAddress, int mode, int callingSearchSpace, int calledAddressOption) throws InvalidStateException, InvalidPartyException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableExceptionThis method overloads the CallControlConnection.redirect() method. It takes three new parameters —- redirectMode, callingSearchSpace, and calledAddressOption. The redirectMode is used to select which type of redirect to perform, and the callingSearchSpace is used to instruct the implementation to use either the calling party's search space or the redirect controller's search space. The calledAddressOption parameter is used to decide whether to reset the original called fields or not.
The redirectMode parameter may be:
1.
2.
The callingSearchSpace parameter may be:
1.
2.
3.
Note
The calledAddressOption parameter may be:
1.
2.
3.
Throws:
javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException
redirect(String, int, int, String)
public javax.telephony.Connection redirect(java.lang.StringdestinationAddress, int mode, int callingSearchSpace, java.lang.String preferredOriginalCalledParty)throws InvalidStateException, InvalidPartyException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableExceptionThis method overloads the CallControlConnection.redirect() method. It takes three new parameters -- redirectMode, callingSearchSpace, preferredOriginalCalledParty.
The redirectMode is used to select which type of redirect to perform, and the callingSearchSpace is used to instruct the implementation to use either the calling party's search space or the redirect controller's search space.
The redirectMode parameter may be:
1.
2.
Read above for a description of what each of these means.
The callingSearchSpace parameter may be:
1.
2.
3.
Read above for a description of what each of these means.
Note
PreferredOriginalCalledParty parameter may be: a DN which will be the originalCalledParty field when call is offered to destinationAddress.
Throws:
javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException
redirect(String, int, int, int, String, String, String)
public javax.telephony.Connection redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace, int calledAddressOption, java.lang.String preferredOriginalCalledParty, java.lang.String facCode, java.lang.String cmcCode)This method overloads the CallControlConnection.redirect() method. It takes five new parameters —- redirectMode, callingSearchSpace, calledAddressOption, facCode, and cmcCode. The redirectMode is used to select which type of redirect to perform, and the callingSearchSpace is used to instruct the implementation to use either the calling party's search space or the redirect controller's search space. The calledAddressOption parameter is used to decide whether to reset the original called fields or not.
The redirectMode parameter may be:
1.
2.
The callingSearchSpace parameter may be:
1.
2.
3.
Note
The calledAddressOption parameter may be:
1.
2.
3.
Throws:
javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException
PreferredOriginalCalledParty parameter may be a DN that will be the originalCalledParty field when the call is offered to destinationAddress.
The facCode is the forced account code (FAC), and cmcCode is the client matter code (CMC).
setRequestController(TerminalConnection)
public voidsetRequestController(javax.telephony.TerminalConnection tc)throws InvalidArgumentException, InvalidStateExceptionThis interface is provided to Requesting TerminalConnection. Applications are required to call this method prior to redirecting /Parking/disconnecting the Call for a Connection for a SharedLine Call. On a SharedLine address, there will be more that one TerminalConnection for a connection.
When there is only one active terminalConnection, applications may not specify RequestController, however if there is more that one active TerminalConnection in same connection e.g for BargedCall/ConferenceCall then Applications must specify RequestController. RequestController is the TerminalConnection which will be used for completing request. RequestController will be set to null/0 after request is completed/executed.
The following examples show how this interface can be used.
Example 4-1 Redirect: Address A has two active terminalConnection TC1 and TC2 Application want to redirect Call T2 to C.
CiscoConnection.setRequqestController(TC2);
CiscoConnection.redirect(C);
Example 4-2 Park: Address A have two active TerminalConnection TC1 and TC2 Application want to Park the Call at T2
CiscoConnection.setRequestController(TC2);
CiscoConnection.park();
Throws:
javax.telephony.InvalidStateException, javax.telephony.InvalidArgumentException
CiscoConnectionID
Declaration
public interface CiscoConnectionID extends CiscoObjectContainerAll Superinterfaces
Description
The CiscoConnectionID object represents a unique object associated with each connection. Applications may use the object itself or the integer representation of the object returned by the intValue() method.
Methods
getConnection()
public com.cisco.jtapi.extensions.CiscoConnection getConnection()intValue()
public int intValue()Returns an integer representation of this object, currently the Cisco Unified Communications Manager CallLeg ID.
Returns:
an integer representation of this object
CiscoConsultCall
Declaration
public interface CiscoConsultCall extends CiscoCallAll Superinterfaces
javax.telephony.Call, javax.telephony.callcontrol.CallControlCall, CiscoCall, CiscoObjectContainer
Description
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.
See Also:
javax.telephony.Call
Methods
consultWithoutMedia(TerminalConnection, String)
public javax.telephony.Connection[]consultWithoutMedia(javax.telephony.TerminalConnection tc, java.lang.String dialedDigits)throws InvalidStateException, InvalidArgumentException, MethodNotSupportedExceptio n,ResourceUnavailableException, PrivilegeViolationException, InvalidPartyExceptionFrom CallEvent perspective, this method behaves similar to CallControlCall.consult(TerminalConnection tc, String dialedDigits). Creates a consultation between this Call and an active Call without establishing the media. This consult call may only be transferred, not conferenced.
The Consultation Purpose
This method does not support if invoked with CallControlCall.setConferneceEnable(). It only supports if invoked with CallControlCall.setTransferEnable().
Throws:
javax.telephony.InvalidPartyException, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailableException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException
getConsultingTerminalConnection()
public javax.telephony.TerminalConnectiongetConsultingTerminalConnection()Returns the consulting TerminalConnection that was used to create this CiscoConsultCall.
If this Call was created as part of a consultative transfer or consultative conference, the TerminalConnection which was used to perform the consultation on the original Call is returned by the getConsultingTerminalConnection method. This may be useful to applications that wish to correlate a ConsultCall with its original Call. Note that the original Call does not have any methods which may be used to determine the ConsultCall, if any, to which it is related.
Returns:
null if this Call is not the result of a consultation, or the consulting TerminalConnection of the original Call if this Call is the result of a consultation.
CiscoConsultCallActiveEv
Declaration
public interface CiscoConsultCallActiveEv extends CiscoCallEv,javax.telephony.events.CallActiveEvAll Superinterfaces
javax.telephony.events.CallActiveEv, javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev
Description
The CiscoConsultCallActiveEv event interface extends the JTAPI CallActiveEv. It indicates that the state of the Call object has 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.
This event is reported to applications via the CallObserver interface.
See Also:
javax.telephony.Call, javax.telephony.CallObserver, javax.telephony.events.CallActiveEv
Fields
ID
public static final int IDMethods
getHeldTerminalConnection()
public javax.telephony.TerminalConnectiongetHeldTerminalConnection()This may be useful to applications that wish to correlate a consultation Call with its original Call. Note that the original Call does not have any methods which may be used to determine the consultation Call, if any, to which it is related.
Returns:
the consulting TerminalConnection of the Call that created the Call referenced by this event.
Deprecated:
replaced by CiscoConsultCall.getConsultingTerminalConnection ()
CiscoEv
Declaration
public interface CiscoEv extends javax.telephony.events.EvAll Superinterfaces
javax.telephony.events.Ev
All Known Subinterfaces
CiscoAddrAddedToTerminalEv, CiscoAddrAutoAcceptStatusChangedEv, CiscoAddrCreatedEv, CiscoAddrEv, CiscoAddrInServiceEv, CiscoAddrOutOfServiceEv, CiscoAddrRemovedEv, CiscoCallEv, CiscoConferenceEndEv, CiscoConferenceStartEv, CiscoConsultCallActiveEv, CiscoOutOfServiceEv, CiscoProvCallParkEv, CiscoProvEv, CiscoProvFeatureEv, CiscoProvFeatureUnRegisteredEv, CiscoRTPInputStartedEv, CiscoRTPInputStoppedEv, CiscoRTPOutputStoppedEv, CiscoRTPOutputStartedEv, CiscoTermButtonPressedEv, CiscoTermButtonPressedEv, CiscoTermCreatedEv, CiscoTermDataEv, CiscoTermEv, CiscoTerminal, CiscoTerminal, CiscoTermInServiceEv, CiscoTermOutOfServiceEv, CiscoTermRemovedEv, CiscoTransferEndEv, CiscoTransferStartEv
Description
The CiscoEv interface, which extends JTAPI's core javax.telephony.events.Ev interface, serves as the base interface for all Cisco-extended JTAPI events. Every event in this package extends this interface, directly or indirectly.
See Also:
javax.telephony.events.Ev
CiscoG711MediaCapability
Declaration
public class CiscoG711MediaCapability extends CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.CiscoMediaCapability|+--com.cisco.jtapi.extensions.CiscoG711MediaCapabilityDescription
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.
Fields
FRAMESIZE_SIXTY_MILLISECOND_PACKET
public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKETThe frames-per-packet value for 60 millisecond packets
FRAMESIZE_THIRTY_MILLISECOND_PACKET
public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKETThe frames-per-packet value for 30 millisecond packets
FRAMESIZE_TWENTY_MILLISECOND_PACKET
public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKETThe frames-per-packet value for 20 millisecond packets
Constructors
CiscoG711MediaCapability()
public CiscoG711MediaCapability()Constructs a CiscoG711MediaCapability</CODE object with a default thirty millisecond packet size.
CiscoG711MediaCapability(int)
public CiscoG711MediaCapability(int maxFramesPerPacket)Constructs a CiscoG711MediaCapability</CODE object with the specified packet size.
CiscoG723MediaCapability
Declaration
public class CiscoG723MediaCapability extends CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.CiscoMediaCapability|+--com.cisco.jtapi.extensions.CiscoG723MediaCapabilityDescription
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.
Fields
FRAMESIZE_SIXTY_MILLISECOND_PACKET
public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKETThe frames-per-packet value for 60 millisecond packets
FRAMESIZE_THIRTY_MILLISECOND_PACKET
public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKETThe frames-per-packet value for 30 millisecond packets
FRAMESIZE_TWENTY_MILLISECOND_PACKET
public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKETThe frames-per-packet value for 20 millisecond packets
Constructors
CiscoG723MediaCapability()
public CiscoG723MediaCapability()Constructs a CiscoG723MediaCapability</CODE object with a default thirty millisecond packet size and 6.4k bit rate.
CiscoG723MediaCapability(int, int)
public CiscoG723MediaCapability(int maxFramesPerPacket,int bitRate)Constructs a CiscoG723MediaCapability</CODE object with the specified packet size and bit rate.
Methods
getBitRate()
public int getBitRate()Returns:
a bit rate from the RTPBitRate interface specified by this capability object
toString()
public java.lang.String toString()Overrides:
toString in class CiscoMediaCapability
CiscoG729MediaCapability
Declaration
public class CiscoG729MediaCapability extends CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.CiscoMediaCapability|+--com.cisco.jtapi.extensions.CiscoG729MediaCapabilityDescription
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.
Fields
FRAMESIZE_SIXTY_MILLISECOND_PACKET
public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKETThe frames-per-packet value for 60 millisecond packets
FRAMESIZE_THIRTY_MILLISECOND_PACKET
public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKETThe frames-per-packet value for 30 millisecond packets
FRAMESIZE_TWENTY_MILLISECOND_PACKET
public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKETThe frames-per-packet value for 20 millisecond packets
Constructors
CiscoG729MediaCapability()
public CiscoG729MediaCapability()Constructs a CiscoG729MediaCapability</CODE object with a default G729 payload and thirty millisecond packet size.
CiscoG729MediaCapability(int, int)
public CiscoG729MediaCapability(int payload,int maxFramesPerPacket)Constructs a CiscoG729MediaCapability</CODE object with the specified packet size and payload. The choice of payload is specified in CiscoRTPPayload with the options CiscoRTPPayload.G729 and CiscoRTPPayload.G729ANNEXA
CiscoGSMMediaCapability
Declaration
public class CiscoGSMMediaCapability extends CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.CiscoMediaCapability|+--com.cisco.jtapi.extensions.CiscoGSMMediaCapabilityDescription
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.
Fields
FRAMESIZE_EIGHTY_MILLISECOND_PACKET
public static final int FRAMESIZE_EIGHTY_MILLISECOND_PACKETThe frames-per-packet value for 30 millisecond packets
Constructors
CiscoGSMMediaCapability()
public CiscoGSMMediaCapability()Constructs a CiscoGSMMediaCapability</CODE object with a default eighty millisecond packet size.
CiscoGSMMediaCapability(int)
public CiscoGSMMediaCapability(int maxFramesPerPacket)Constructs a CiscoGSMMediaCapability</CODE object with the specified packet size.
CiscoIntercomAddress
Declaration
public interface CiscoIntercomAddressextends CiscoAddressDescription/Usage
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 API features.
Methods
connectIntercom(javax.telephony.Terminal terminal, java.lang.String targetDN)
javax.telephony.Connection[] connectIntercom(javax.telephony.Terminal terminal, java.lang.String targetDN)Places a intercom call from an originating intercom address to a destination intercom address.
connectIntercom(javax.telephony.Terminal terminal, java.lang.String targetDN, com.cisco.jtapi.extensions.CiscoRTPParams rtpParams)
javax.telephony.Connection[] connectIntercom(javax.telephony.Terminal terminal, java.lang.String targetDN, com.cisco.jtapi.extensions.CiscoRTPParams rtpParams)Places an intercom call from an originating intercom address to a destination intercom address.
getDefaultIntercomTargetDN()
java.lang.String getDefaultIntercomTargetDN()Returns the default intercom target DN which is configured through CCMAdmin
getDefaultIntercomTargetLabel()
java.lang.String getDefaultIntercomTargetLabel()Returns the default current intercom target label which is configured through CCMAdmin
getDefaultIntercomUnicodeTargetLabel()
java.lang.String getDefaultIntercomUnicodeTargetLabel()Returns the default current intercom target label which is configured through CCMAdmin
getIntercomTargetDN()
java.lang.String getIntercomTargetDN()Returns the current intercom target DN which is set by the application.
getIntercomTargetLabel()
java.lang.String getIntercomTargetLabel()Returns the current intercom target label which is set by the application
getIntercomUnicodeTargetLabel()
java.lang.String getIntercomUnicodeTargetLabel()Returns the current intercom target label which is set by the application.
resetIntercomTarget()
public void resetIntercomTarget()Lets applications reset the intercom target DN, intercom target label, and intercom target unicode label to their default values.
setIntercomTarget(java.lang.String targetDN, java.lang.String targetLabel, java.lang.String UnicodeTargetLabel)
public void setIntercomTarget(java.lang.String targetDN, java.lang.String targetLabel, java.lang.String UnicodeTargetLabel)Lets applications set the intercom target DN, intercom target label, and intercom target unicode label that are shown next to the intercom line on the phone.
Error Codes
CTIERR_INTERCOM_SPEEDDIAL_ALREADY_SET = 0x8CCC00DB
This error code is returned in exceptions if an application's attempt to set the intercom target fails because the target is already set. CiscoJTAPIExcecption.getErrorCode() will return the value.
CTIERR_INTERCOM_SPEEDDIAL_DESTN_INVALID = 0x8CCC00DC
This error code is returned in exceptions if the intercom target is not within the intercom group. CiscoJTAPIExcecption.getErrorCode() will return the value.
CTIERR_DEVICE_REGISTRATION_FAILED_NOT_SUPPORTED_MEDIATYPE = 0X8CCC00DD
This error code is returned in exceptions if an application tried to register a CTIPort configured with an intercom address with static registration. For a CTIPort with an intercom address, only dynamic port registration is allowed. CiscoJTAPIExcecption.getErrorCode() will return the value.
CiscoJtapiException
Declaration
public interface CiscoJtapiExceptionDescription
The CiscoJtapiException interface defines CTI error codes. These are the error codes that may be returned by CTI requests. All the JTAPI exceptions have been extended to implement this interface. The Error codes can be got by casting the exception to CiscoJtapiException and calling the method getErrorCode(). If 'e' is any exception caught in an application, see if its 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 Error Code.} }
