Feedback
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.} }
Fields
ASSOCIATED_LINE_NOT_OPEN
public static final int ASSOCIATED_LINE_NOT_OPENCALL_ALREADY_EXISTS
public static final int CALL_ALREADY_EXISTSCALL_DROPPED
public static final int CALL_DROPPEDThe call is dropped after the feature request (hold, unhold, transfer, conference) but before completing the request.
CALLHANDLE_NOTINCOMINGCALL
public static final int CALLHANDLE_NOTINCOMINGCALLCALLHANDLE_UNKNOWN_TO_LINECONTROL
public static final int CALLHANDLE_UNKNOWN_TO_LINECONTROLCANNOT_OPEN_DEVICE
public static final int CANNOT_OPEN_DEVICECANNOT_TERMINATE_MEDIA_ON_PHONE
public static final int CANNOT_TERMINATE_MEDIA_ON_PHONECFWDALL_ALREADY_OFF
public static final int CFWDALL_ALREADY_OFFCFWDALL_ALREADY_SET
public static final int CFWDALL_ALREADY_SETCFWDALL_DESTN_INVALID
public static final int CFWDALL_DESTN_INVALIDCLUSTER_LINK_FAILURE
public static final int CLUSTER_LINK_FAILURECOMMAND_NOT_IMPLEMENTED_ON_DEVICE
public static final int COMMAND_NOT_IMPLEMENTED_ON_DEVICECONFERENCE_ALREADY_PRESENT
public static final int CONFERENCE_ALREADY_PRESENTCONFERENCE_FAILED
public static final int CONFERENCE_FAILEDCONFERENCE_FULL
public static final int CONFERENCE_FULLCONFERENCE_INACTIVE
public static final int CONFERENCE_INACTIVECONFERENCE_INVALID_PARTICIPANT
public static final int CONFERENCE_INVALID_PARTICIPANTCTIERR_ACCESS_TO_DEVICE_DENIED
public static final int CTIERR_ACCESS_TO_DEVICE_DENIEDCTIERR_APP_SOFTKEYS_ALREADY_CONTROLLED
public static final int CTIERR_APP_SOFTKEYS_ALREADY_CONTROLLEDCTIERR_APPLICATION_DATA_SIZE_EXCEEDED
public static final int CTIERR_APPLICATION_DATA_SIZE_EXCEEDEDCTIERR_BIB_RESOURCE_NOT_AVAILABLE
public static final int CTIERR_BIB_RESOURCE_NOT_AVAILABLECTIERR_CALL_MANAGER_NOT_AVAILABLE
public static final int CTIERR_CALL_MANAGER_NOT_AVAILABLECTIERR_CALL_NOT_EXISTED
public static final int CTIERR_CALL_NOT_EXISTEDCTIERR_CALL_PARK_NO_DN
public static final int CTIERR_CALL_PARK_NO_DNCTIERR_CALL_REQUEST_ALREADY_OUTSTANDING
public static final int CTIERR_CALL_REQUEST_ALREADY_OUTSTANDINGCTIERR_CALL_UNPARK_FAILED
public static final int CTIERR_CALL_UNPARK_FAILEDCTIERR_CAPABILITIES_DO_NOT_MATCH
public static final int CTIERR_CAPABILITIES_DO_NOT_MATCHCTIERR_CLOSE_DELAY_NOT_SUPPORTED_WITH_REG_TYPE
public static final int CTIERR_CLOSE_DELAY_NOT_SUPPORTED_WITH_REG_TYPECTIERR_CONFERENCE_ALREADY_EXISTED
public static final int CTIERR_CONFERENCE_ALREADY_EXISTEDCTIERR_CONFERENCE_NOT_EXISTED
public static final int CTIERR_CONFERENCE_NOT_EXISTEDCTIERR_CONNECTION_ON_INVALID_PORT
public static final int CTIERR_CONNECTION_ON_INVALID_PORTCTIERR_CONSULT_CALL_FAILURE
public static final int CTIERR_CONSULT_CALL_FAILURECTIERR_CONSULTCALL_ALREADY_OUTSTANDING
public static final int CTIERR_CONSULTCALL_ALREADY_OUTSTANDINGCTIERR_CTIHANDLER_PROCESS_CREATION_FAILED
public static final int CTIERR_CTIHANDLER_PROCESS_CREATION_FAILEDCTIERR_DEVICE_ALREADY_OPENED
public static final int CTIERR_DEVICE_ALREADY_OPENEDCTIERR_DEVICE_NOT_OPENED_YET
public static final int CTIERR_DEVICE_NOT_OPENED_YETCTIERR_DEVICE_OWNER_ALIVE_TIMER_STARTED
public static final int CTIERR_DEVICE_OWNER_ALIVE_TIMER_STARTEDCTIERR_DEVICE_RESTRICTED
public static final int CTIERR_DEVICE_RESTRICTEDCTIERR_DN_RESTRICTED
public static final int CTIERR_DN_RESTRICTEDCTIERR_DEVICE_SHUTTING_DOWN
public static final int CTIERR_DEVICE_SHUTTING_DOWNCTIERR_DUPLICATE_CALL_REFERENCE
public static final int CTIERR_DUPLICATE_CALL_REFERENCECTIERR_FAC_CMC_REASON_CMC_INVALID
public static final int CTIERR_FAC_CMC_REASON_CMC_INVALIDCTIERR_FAC_CMC_REASON_CMC_NEEDED
public static final int CTIERR_FAC_CMC_REASON_CMC_NEEDEDCTIERR_FAC_CMC_REASON_FAC_INVALID
public static final int CTIERR_FAC_CMC_REASON_FAC_INVALIDCTIERR_FAC_CMC_REASON_FAC_CMC_NEEDED
public static final int.CTIERR_FAC_CMC_REASON_FAC_CMC_NEEDEDCTIERR_FAC_CMC_REASON_FAC_NEEDED
public static final int CTIERR_FAC_CMC_REASON_FAC_NEEDEDCTIERR_FEATURE_ALREADY_REGISTERED
public static final int CTIERR_FEATURE_ALREADY_REGISTEREDCTIERR_FEATURE_DATA_REJECT
public static final int CTIERR_FEATURE_DATA_REJECTCTIERR_ILLEGAL_DEVICE_TYPE
public static final int CTIERR_ILLEGAL_DEVICE_TYPECTIERR_INCOMPATIBLE_AUTOINSTALL_PROTOCOL_VERSION
public static final int CTIERR_INCOMPATIBLE_AUTOINSTALL_PROTOCOL_VERSIONCTIERR_INCORRECT_MEDIA_CAPABILITY
public static final int CTIERR_INCORRECT_MEDIA_CAPABILITYCTIERR_INFORMATION_NOT_AVAILABLE
public static final int CTIERR_INFORMATION_NOT_AVAILABLECTIERR_INTERCOM_SPEEDDIAL_ALREADY_CONFIGURED
public static final int CTIERR_INTERCOM_SPEEDDIAL_ALREADY_CONFIGUREDCTIERR_INTERCOM_TALKBACK_ALREADY_PENDING
public static final int CTIERR_INTERCOM_TALKBACK_ALREADY_PENDINGCTIERR_INTERNAL_FAILURE
public static final int CTIERR_INTERNAL_FAILURECTIERR_INVALID_CALLID
public static final int CTIERR_INVALID_CALLIDCTIERR_INVALID_DEVICE_NAME
public static final int CTIERR_INVALID_DEVICE_NAMECTIERR_INVALID_DTMFDIGITS
public static final int CTIERR_INVALID_DTMFDIGITSCTIERR_INVALID_MEDIA_DEVICE
public static final int CTIERR_INVALID_MEDIA_DEVICECTIERR_INVALID_MEDIA_PARAMETER
public static final int CTIERR_INVALID_MEDIA_PARAMETERCTIERR_INVALID_MEDIA_PROCESS
public static final int CTIERR_INVALID_MEDIA_PROCESSCTIERR_INVALID_MEDIA_RESOURCE_ID
public static final int CTIERR_INVALID_MEDIA_RESOURCE_IDCTIERR_INVALID_MESSAGE_HEADER_INFO
public static final int CTIERR_INVALID_MESSAGE_HEADER_INFOCTIERR_INVALID_MESSAGE_LENGTH
public static final int CTIERR_INVALID_MESSAGE_LENGTHCTIERR_INVALID_MONITOR_DN_TYPE
public static final int CTIERR_INVALID_MONITOR_DN_TYPECTIERR_INVALID_PARAMETER
public static final int CTIERR_INVALID_PARAMETERCTIERR_INVALID_PARK_DN
public static final int CTIERR_INVALID_PARK_DNCTIERR_INVALID_PARK_REGISTRATION_HANDLE
public static final int CTIERR_INVALID_PARK_REGISTRATION_HANDLECTIERR_INVALID_RESOURCE_TYPE
public static final int CTIERR_INVALID_RESOURCE_TYPECTIERR_MAXCALL_LIMIT_REACHED
public static final int CTIERR_MAXCALL_LIMIT_REACHEDCTIERR_INCORRECT_MEDIA_CAPABILITY
public static final int CTIERR_INCORRECT_MEDIA_CAPABILITYCTIERR_INVALID_DTMFDIGITS
public static final int CTIERR_INVALID_DTMFDIGITSCTIERR_MEDIA_ALREADY_TERMINATED_DYNAMIC
public static final int CTIERR_MEDIA_ALREADY_TERMINATED_DYNAMICCTIERR_MEDIA_ALREADY_TERMINATED_NONE
public static final int CTIERR_MEDIA_ALREADY_TERMINATED_NONECTIERR_MEDIA_ALREADY_TERMINATED_STATIC
public static final int CTIERR_MEDIA_ALREADY_TERMINATED_STATICCTIERR_MEDIA_CAPABILITY_MISMATCH
public static final int CTIERR_MEDIA_CAPABILITY_MISMATCHCTIERR_MEDIA_RESOURCE_NAME_SIZE_EXCEEDED
public static final int CTIERR_MEDIA_RESOURCE_NAME_SIZE_EXCEEDEDCTIERR_MEDIAREGISTRATIONTYPE_DO_NOT_MATCH
public static final int CTIERR_MEDIAREGISTRATIONTYPE_DO_NOT_MATCHCTIERR_MESSAGE_TOO_BIG
public static final int CTIERR_MESSAGE_TOO_BIGCTIERR_MORE_ACTIVE_CALLS_THAN_RESERVED
public static final int CTIERR_MORE_ACTIVE_CALLS_THAN_RESERVEDCTIERR_NO_EXISTING_CALLS
public static final int CTIERR_NO_EXISTING_CALLSCTIERR_NO_EXISTING_CONFERENCE
public static final int CTIERR_NO_EXISTING_CONFERENCECTIERR_NO_RESPONSE_FROM_MP
public static final int CTIERR_NO_RESPONSE_FROM_MPCTIERR_NOT_PRESERVED_CALL
public static final int CTIERR_NOT_PRESERVED_CALLCTIERR_OPERATION_FAILED_QUIETCLEAR
public static final int CTIERR_OPERATION_FAILED_QUIETCLEARCTIERR_OPERATION_NOT_ALLOWED
public static final int CTIERR_OPERATION_NOT_ALLOWEDCTIERR_OWNER_NOT_ALIVE
public static final int CTIERR_OWNER_NOT_ALIVECTIERR_PENDING_ACCEPT_OR_ANSWER_REQUEST
public static final int CTIERR_PENDING_ACCEPT_OR_ANSWER_REQUESTCTIERR_PRIMARY_CALL_INVALID
static final int CTIERR_PRIMARY_CALL_INVALIDCTIERR_PRIMARY_CALL_STATE_INVALID
static final int CTIERR_PRIMARY_CALL_STATE_INVALIDCTIERR_REDIRECT_UNAUTHORIZED_COMMAND_USAGE
public static final int CTIERR_REDIRECT_UNAUTHORIZED_COMMAND_USAGECTIERR_REGISTER_FEATURE_ACTIVATION_FAILED
public static final int CTIERR_REGISTER_FEATURE_ACTIVATION_FAILEDCTIERR_RESOURCE_NOT_AVAILABLE
public static final int CTIERR_RESOURCE_NOT_AVAILABLECTIERR_STATION_SHUT_DOWN
public static final int CTIERR_STATION_SHUT_DOWNCTIERR_SYSTEM_ERROR
public static final int CTIERR_SYSTEM_ERRORCTIERR_UNKNOWN_EXCEPTION
public static final int CTIERR_UNKNOWN_EXCEPTIONCTIERR_UNSUPPORTED_CALL_PARK_TYPE
public static final int CTIERR_UNSUPPORTED_CALL_PARK_TYPECTIERR_USER_NOT_AUTH_FOR_SECURITY
public static final int CTIERR_USER_NOT_AUTH_FOR_SECURITYDARES_INVALID_REQ_TYPE
public static final int DARES_INVALID_REQ_TYPEDATA_SIZE_LIMIT_EXCEEDED
public static final int DATA_SIZE_LIMIT_EXCEEDEDDB_ERROR
public static final int DB_ERRORDB_ILLEGAL_DEVICE_TYPE
public static final int DB_ILLEGAL_DEVICE_TYPEDB_NO_MORE_DEVICES
public static final int DB_NO_MORE_DEVICESDESTINATION_BUSY
public static final int DESTINATION_BUSYDESTINATION_UNKNOWN
public static final int DESTINATION_UNKNOWNDEVICE_ALREADY_REGISTERED
public static final int DEVICE_ALREADY_REGISTEREDDEVICE_NOT_OPEN
public static final int DEVICE_NOT_OPENDEVICE_OUT_OF_SERVICE
public static final int DEVICE_OUT_OF_SERVICEDIGIT_GENERATION_ALREADY_IN_PROGRESS
public static final int DIGIT_GENERATION_ALREADY_IN_PROGRESSDIGIT_GENERATION_CALLSTATE_CHANGED
public static final int DIGIT_GENERATION_CALLSTATE_CHANGEDDIGIT_GENERATION_WRONG_CALL_HANDLE
public static final int DIGIT_GENERATION_WRONG_CALL_HANDLEDIGIT_GENERATION_WRONG_CALL_STATE
public static final int DIGIT_GENERATION_WRONG_CALL_STATEDIRECTORY_LOGIN_FAILED
public static final int DIRECTORY_LOGIN_FAILEDDIRECTORY_LOGIN_NOT_ALLOWED
public static final int DIRECTORY_LOGIN_NOT_ALLOWEDDIRECTORY_TEMPORARY_UNAVAILABLE
public static final int DIRECTORY_TEMPORARY_UNAVAILABLEEXISTING_FIRSTPARTY
public static final int EXISTING_FIRSTPARTYHOLDFAILED
public static final int HOLDFAILEDILLEGAL_CALLINGPARTY
public static final int ILLEGAL_CALLINGPARTYILLEGAL_CALLSTATE
public static final int ILLEGAL_CALLSTATEILLEGAL_HANDLE
public static final int ILLEGAL_HANDLEILLEGAL_MESSAGE_FORMAT
public static final int ILLEGAL_MESSAGE_FORMATINCOMPATIBLE_PROTOCOL_VERSION
public static final int INCOMPATIBLE_PROTOCOL_VERSIONINVALID_LINE_HANDLE
public static final int INVALID_LINE_HANDLEINVALID_RING_OPTION
public static final int INVALID_RING_OPTIONLINE_INFO_DOES_NOT_EXIST
public static final int LINE_INFO_DOES_NOT_EXISTLINE_NOT_PRIMARY
public static final int LINE_NOT_PRIMARYLINECONTROL_FAILURE
public static final int LINECONTROL_FAILUREMAX_NUMBER_OF_CTI_CONNECTIONS_REACHED
public static final int MAX_NUMBER_OF_CTI_CONNECTIONS_REACHEDMSGWAITING_DESTN_INVALID
public static final int MSGWAITING_DESTN_INVALIDNO_ACTIVE_DEVICE_FOR_THIRDPARTY
public static final int NO_ACTIVE_DEVICE_FOR_THIRDPARTYNO_CONFERENCE_BRIDGE
public static final int NO_CONFERENCE_BRIDGENOT_INITIALIZED
public static final int NOT_INITIALIZEDPROTOCOL_TIMEOUT
public static final int PROTOCOL_TIMEOUTPROVIDER_ALREADY_OPEN
public static final int PROVIDER_ALREADY_OPENPROVIDER_CLOSED
public static final int PROVIDER_CLOSEDPROVIDER_NOT_OPEN
public static final int PROVIDER_NOT_OPENREDIRECT_CALL_CALL_TABLE_FULL
public static final int REDIRECT_CALL_CALL_TABLE_FULLREDIRECT_CALL_DESTINATION_BUSY
public static final int REDIRECT_CALL_DESTINATION_BUSYREDIRECT_CALL_DESTINATION_OUT_OF_ORDER
public static final int REDIRECT_CALL_DESTINATION_OUT_OF_ORDERREDIRECT_CALL_DIGIT_ANALYSIS_TIMEOUT
public static final int REDIRECT_CALL_DIGIT_ANALYSIS_TIMEOUTREDIRECT_CALL_DOES_NOT_EXIST
public static final int REDIRECT_CALL_DOES_NOT_EXISTREDIRECT_CALL_INCOMPATIBLE_STATE
public static final int REDIRECT_CALL_INCOMPATIBLE_STATEREDIRECT_CALL_MEDIA_CONNECTION_FAILED
public static final int REDIRECT_CALL_MEDIA_CONNECTION_FAILEDREDIRECT_CALL_NORMAL_CLEARING
public static final int REDIRECT_CALL_NORMAL_CLEARINGREDIRECT_CALL_ORIGINATOR_ABANDONED
public static final int REDIRECT_CALL_ORIGINATOR_ABANDONEDREDIRECT_CALL_PARTY_TABLE_FULL
public static final int REDIRECT_CALL_PARTY_TABLE_FULLREDIRECT_CALL_PENDING_REDIRECT_TRANSACTION
public static final int REDIRECT_CALL_PENDING_REDIRECT_TRANSACTIONREDIRECT_CALL_PROTOCOL_ERROR
public static final int REDIRECT_CALL_PROTOCOL_ERRORREDIRECT_CALL_UNKNOWN_DESTINATION
public static final int REDIRECT_CALL_UNKNOWN_DESTINATIONREDIRECT_CALL_UNKNOWN_ERROR
public static final int REDIRECT_CALL_UNKNOWN_ERRORREDIRECT_CALL_UNKNOWN_PARTY
public static final int REDIRECT_CALL_UNKNOWN_PARTYREDIRECT_CALL_UNRECOGNIZED_MANAGER
public static final int REDIRECT_CALL_UNRECOGNIZED_MANAGERREDIRECT_CALLINFO_ERR
public static final int REDIRECT_CALLINFO_ERRREDIRECT_ERR
public static final int REDIRECT_ERRRETRIEVEFAILED
public static final int RETRIEVEFAILEDRETRIEVEFAILED_ACTIVE_CALL_ON_LINE
public static final int RETRIEVEFAILED_ACTIVE_CALL_ON_LINESSAPI_NOT_REGISTERED
public static final int SSAPI_NOT_REGISTEREDTIMEOUT
public static final int TIMEOUTTRANSFER_INACTIVE
public static final int TRANSFER_INACTIVETRANSFERFAILED
public static final int TRANSFERFAILEDTRANSFERFAILED_CALLCONTROL_TIMEOUT
public static final int TRANSFERFAILED_CALLCONTROL_TIMEOUTTRANSFERFAILED_DESTINATION_BUSY
public static final int TRANSFERFAILED_DESTINATION_BUSYTRANSFERFAILED_DESTINATION_UNALLOCATED
public static final int TRANSFERFAILED_DESTINATION_UNALLOCATEDTRANSFERFAILED_OUTSTANDING_TRANSFER
public static final int TRANSFERFAILED_OUTSTANDING_TRANSFERUNDEFINED_LINE
public static final int UNDEFINED_LINEUNKNOWN_GLOBAL_CALL_HANDLE
public static final int UNKNOWN_GLOBAL_CALL_HANDLEUNRECOGNIZABLE_PDU
public static final int UNRECOGNIZABLE_PDUUNSPECIFIED
public static final int UNSPECIFIEDThe CTI error codes. These are the error codes that may be returned by CTI requests.
Methods
getErrorCode()
public int getErrorCode()Returns:
errorCode in an integer representation
getErrorDescription()
public java.lang.String getErrorDescription()Returns:
String detail description of the errorCode
getErrorDescription(int)
public java.lang.String getErrorDescription(int errorCode)Deprecated.
instead use String getErrorDescription ();
Returns:
String detail description of the errorCode
getErrorName()
public java.lang.String getErrorName()Returns:
String representation of the error code
getErrorName(int)
public java.lang.String getErrorName(int errorCode)Deprecated.
instead use String getErrorName ();
Returns:
String representation of the error code
CiscoJtapiPeer
Declaration
public interface CiscoJtapiPeer extendscom.cisco.services.tracing.TraceModule, javax.telephony.JtapiPeer, CiscoObjectContainerAll Superinterfaces
CiscoObjectContainer, javax.telephony.JtapiPeer, com.cisco.services.tracing.TraceModule
Description
By extending the com.cisco.services.tracing.TraceModule interface, the CiscoJtapiPeer exposes trace information to applications. All instances of JtapiPeer objects created by Cisco Unified JTAPI implement this interface. Applications that wish to manipulate the trace settings of the Cisco Unified JTAPI implementation may use the CiscoJtapiPeer.getTraceManager method to obtain its TraceManager object. The TraceManager object may then be manipulated as described in the com.cisco.services.tracing package.
See Also:
com.cisco.services.tracing.TraceModule
Methods
getJtapiProperties()
public com.cisco.jtapi.extensions.CiscoJtapiPropertiesgetJtapiProperties()CiscoJtapiProperties defines the various methods that applications can use to modify the parameters that the JTAPI layer will use.
See Also:
CiscoJtapiProperties
Declaration
public interface CiscoJtapiPropertiesDescription
Cisco Unified JTAPI's behavior and functionality is tailored by many parameters which are read in from the jtapi.ini file when an instance of CiscoJtapiPeer is instantiated. These parameters are now exposed to applications for control via this CiscoJtapiproperties interface.
Applications can query the CiscoJtapiproperties object and change these parameters to better suit the applications functionality. Exposing these properties via the CiscoJtapiproperties interface also allows applications to have a single point of administration (at the application end) for these parameters.
In this release, JTAPI provides an interface on CiscoJtapiProperties to enable or disable the security option and install the client/server certificates required to establish secure TLS socket connections.
The most visible parameters are those describing the tracing levels and tracing destinations.
Usage:
JtapiPeer peer = JtapiPeerFactory.getJtapiPeer ( null ); if(peer instanceof CiscoJtapiPeer){ CiscoJtapiProperties jProps = ((CiscoJtapiPeer)peer).getJtapiProperties(); jProps.setTracePath("\\D:\\Traces\\WorkFlow"); jProps.setUseJavaConsoleTrace(false); MyProviderObserver providerObserver = new MyProviderObserver (); provider = peer.getProvider ( providerName ); }where an application sets the java console tracing to off and the trace path to D:\Traces\WorkFlowApp1.
When the peer gets obtained, an object implementing CiscoJtapiProperties gets created by reading parameters set in the jtapi.ini file. If no jtapi.ini file exists in the classpath, the default settings get used to create this object.
The parameters used by Cisco Unified JTAPI are read in and frozen when the first getProvider () call is made.
Methods
getAlarmServiceHostname()
public java.lang.String getAlarmServiceHostname()get the alarm service host name
getAlarmServicePort()
public int getAlarmServicePort()get the port number for the alarm service
getCallSecurityStatusChangedEv()
public boolean getCallSecurityStatusChangedEv()returns the service parameter value that is set by the application
Range of Values:
True or False
Default Value:
False, for service parameter
getCtiRequestTimeout()
public int getCtiRequestTimeout()get the timeout for cti requests, other than the provider open (seconds)
getDebuggingNames()
public java.lang.String[] getDebuggingNames()get names of supported debugging level jtapi traces
getDebuggingValue(String)
public boolean getDebuggingValue(java.lang.String debuggingName)get the enabled or disabled state of a debugging level trace
getDesiredServerHeartbeatInterval()
public int getDesiredServerHeartbeatInterval()get the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds). The actual interval is decided by the server at connect time.
getFileNameBase()
public java.lang.String getFileNameBase()the filename for individual log files.
getFileNameExtension()
public java.lang.String getFileNameExtension()get the filename extension for log files
getNumTraceFiles()
public int getNumTraceFiles()number of trace files before rollover
getPeriodicWakeupEnabled()
public boolean getPeriodicWakeupEnabled()get the enabled state of periodic wake up
getPeriodicWakeupInterval()
public int getPeriodicWakeupInterval()get the interval for periodic wake up (milliseconds)
getProviderOpenRequestTimeout()
public int getProviderOpenRequestTimeout()get the timeout for a provider open request (seconds)
getProviderRetryInterval()
public int getProviderRetryInterval()get the interval at which the connection to the CTI Manager will be retried (seconds)
getQueueSizeThreshold()
public int getQueueSizeThreshold()get the threshold for the event queue size to trigger alarms
getQueueStatsEnabled()
public boolean getQueueStatsEnabled()get the enabled state of event queue statistics
getRouteSelectTimeout()
public int getRouteSelectTimeout()get the route select timeout (milliseconds)
getSecurityPropertyForInstance()
public java.util.Hashtable getSecurityPropertyForInstance()Returns a hash table with all the parameters set for the first User/InstanceID. The hash table is set with the following "key"/ "value" pairs:
Returns:
Hash table in above format for first user and instance.
getSecurityPropertyForInstance(java.lang.String user, java.lang.String instanceID)
public java.util.Hashtable getSecurityPropertyForInstance(java.lang.String user, java.lang.String instanceID)Returns a hash table with all the parameters set for the specified User/InstanceID. The hash table is set with the following "key"/ "value" pairs:
Parameters:
user - UserName for which we are getting security parameter
instanceID - InstanceID for which we are getting security parameter
Returns:
Hash table in above format for the specified user and instance.
getServices()
public java.lang.String[] getServices()Returns the services that this implementation supports. Note: This is a static list administered in the jtapi.ini file. There is no automatic discovery mechanism to locate available cti services
getSyslogCollector()
public java.lang.String getSyslogCollector()get the syslog collector hostname
getSyslogCollectorUDPPort()
public int getSyslogCollectorUDPPort()get the syslog collector UDP port
getTraceDirectory()
public java.lang.String getTraceDirectory()The directory in the path where trace files will be written
getTraceFileSize()
public int getTraceFileSize()The size of the trace files before rollover
getTraceNames()
public java.lang.String[] getTraceNames()get the names of supported jtapi traces
getTracePath()
public java.lang.String getTracePath()get the path where the trace files will be located
getTraceValue(String)
public boolean getTraceValue(java.lang.String traceName)get the enabled or disabled state of a trace
getUseAlarmService()
public boolean getUseAlarmService()get the enabled/disabled state of the alarm service
getUseFileTrace()
public boolean getUseFileTrace()get the enabled or disabled state of jtapi log file tracing
getUseJavaConsoleTrace()
public boolean getUseJavaConsoleTrace()get the enabled or disabled state of jtapi console tracing
getUseSameDir()
public boolean getUseSameDir()if UseSameDir is true this will cause the traces to go to a single directory. Otherwise each instance of a jtapi application will cause the traces to go to a separate directory, indexed in sequence from the last directory written or available.
getUseSyslog()
public boolean getUseSyslog()get the enabled or disabled state of syslog tracing
IsCertificateUpdated
public boolean IsCertificateUpdated(java.lang.String user,java.lang.String instanceID)Provides information as to whether Client and Server certificates are updated for the specified user/instanceID.
Parameters:
user—Takes UserName as defined in the Cisco Unified Communications Manager admin pages
instanceID—Takes instanceID for UserName
Returns:
true if certificates are updated, false if certificates are not updated.
setAlarmServiceHostname(String)
public void setAlarmServiceHostname(java.lang.String hostname)set the alarm service host name
setAlarmServicePort(int)
public void setAlarmServicePort(int portNumber)set the port number the alarm service is listening on
setCallSecurityStatusChangedEv(boolean)
public void setCallSecurityStatusChangedEv(boolean)Sets the service parameter value to receive or not receive the event. The default is false.
setCtiRequestTimeout(int)
public void setCtiRequestTimeout(int seconds)set the timeout for cti requests other than provider open (seconds)
setDebuggingValue(String, boolean)
public void setDebuggingValue(java.lang.String debuggingName,boolean value)enable or disable a particular debugging level trace
setDesiredServerHeartbeatInterval(int)
public void setDesiredServerHeartbeatInterval(int seconds)set the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds). The actual interval is decided by the server at connect time.
setFileNameBase(String)
public void setFileNameBase(java.lang.String base)set the filename for log files
setFileNameExtension(String)
public void setFileNameExtension(java.lang.String extn)set the filename extension for log files
setNumTraceFiles(int)
public void setNumTraceFiles(int val)set the number of trace files before rollover
setPeriodicWakeupEnabled(boolean)
public void setPeriodicWakeupEnabled(boolean enabled)set the enable/disable state for periodic wake up
setPeriodicWakeupInterval(int)
public void setPeriodicWakeupInterval(int milliseconds)set the periodic wake up interval (milliseconds)
setProviderOpenRequestTimeout(int)
public void setProviderOpenRequestTimeout(int seconds)set the timeout for a provider open request (seconds)
setProviderRetryInterval(int)
public void setProviderRetryInterval(int seconds)set the interval at which the connection to the CTI Manager will be retried (seconds)
setQueueSizeThreshold(int)
public void setQueueSizeThreshold(int size)set the threshold for the event queue size to trigger alarms
setQueueStatsEnabled(boolean)
public void setQueueStatsEnabled(boolean enabled)enable / disable event queue statistics
setRouteSelectTimeout(int)
public void setRouteSelectTimeout(int milliseconds)set the route select timeout in milliseconds
setSecurityPropertyForInstance
public void setSecurityPropertyForInstance(java.lang.String user,java.lang.String instanceID,java.lang.String authCode,java.lang.String tftp,java.lang.String tftpPort,java.lang.String capf,java.lang.String capfPort,java.lang.String certPath,boolean securityOption)used to set security properties for the specified User/InstanceID
Parameters:
user—UserName for which security parameter is being updated
instanceID—InstanceID for which security parameter is being updated
authCode—Authorization String
capf—IP-Address of CAPF Server
capfPort—IP-Address port number on which CAPF server is running, this defined in CallManger Service Parameter. If null is specific default value 3804 will be taken
tftp—IP-Address of TFTP Server
tftpPort—IP-Address port number on which TFTP server is running, Cisco Unified Communications Manager TFTP server usually runs on port 69, if null is specific default value 69 will be taken.
certPath—path where certificate needs to be installed
setServices(String[])
public void setServices(java.lang.String[] services)set a list of available services
setSyslogCollector(String)
public void setSyslogCollector(java.lang.String value)set the syslog collector hostname
setSyslogCollectorUDPPort(int)
public void setSyslogCollectorUDPPort(int port)set the syslog collector UDP port
setTraceDirectory(String)
public void setTraceDirectory(java.lang.String dir)set the directory where jtapi trace files should be written
setTraceFileSize(int)
public void setTraceFileSize(int val)set the size of the trace file
setTracePath(String)
public void setTracePath(java.lang.String path)set the directory root where jtapi traces will be written
setTraceValue(String, boolean)
public void setTraceValue(java.lang.String traceName,boolean value)enable or disable a particular trace
setUseAlarmService(boolean)
public void setUseAlarmService(boolean value)enable the alarm service
setUseFileTrace(boolean)
public void setUseFileTrace(boolean value)enable or disable jtapi log file tracing
setUseJavaConsoleTrace(boolean)
public void setUseJavaConsoleTrace(boolean value)enable or disable jtapi console tracing
setUseSameDir(boolean)
public void setUseSameDir(boolean value)if UseSameDir is true this will cause the traces to go to a single directory. Otherwise each instance of a jtapi application will cause the traces to go to a separate directory, indexed in sequence from the last directory written or available.
setUseSyslog(boolean)
public void setUseSyslog(boolean value)enable or disable syslog tracing
updateCertificate
public void updateCertificate(java.lang.String user,java.lang.String instanceID,java.lang.String authcode,java.lang.String ccmTFTPAddress,java.lang.String ccmTFTPPort,java.lang.String ccmCAPFAddress,java.lang.String ccmCAPFPort,java.lang.String certificatePath)installs an X.509 client certificate for user/instanceID in certificate store and downloads server Certificate Trust List (CTL) from Cisco Unified Communications Manager TFTP server. For getting the client X.509 certificate, connects to Cisco Unified Communications Manager CAPF(Certificate Authority Proxy Function) server. If user credentials provided are not valid, this method throws PrivilegeViolationException. If the TFTP server or CAPF server address provided is not correct, this method throws an InvalidArgumentException. Every instance of an Application requires a unique client certificate. If the multiple instanceID is configured in the Cisco Unified Communications Manager database, Applications can call this interface multiple times to install a client certificate for every instance.
Pre-conditions:
When calling this interface, Applications should have Network connectivity with the Cisco Unified Communications Manager CAPF and TFTP servers.
Post-conditions:
This method installs client and server certificates on the JTAPI Application machine.
Parameters:
user—The name of the CTI Application user configured in the Cisco Unified Communications Manager database.
instanceID—Application instance ID configured in the Cisco Unified Communications Manager database. Every instance of an Application requires a unique ID to be configured.
authcode—Authorization string configured in the Cisco Unified Communications Manager database. Can be used only once for getting certificate.
ccmTFTPAddress—The IP address of the Cisco CallManger TFTP server.
ccmTFTPPort—Port number on which the Cisco Unified Communications Manager TFTP Server is running. If null, the specified default value 69 is used.
ccmCAPFAddress—The IP Address of the Cisco Unified Communications Manager CAPF server.
ccmCAPFPort—Port number on which the Cisco Unified Communications Manager CAPF server is running. If null, the specified default value 3804 is used.
certificatePath—The directory path where the certificates need to be installed.
Throws:
InvalidArgumentException—If either the TFTP server or the CAPF server addresses is not valid, this exception is thrown.
PrivilegeViolationException—If the user, instanceID, or authcode provided is not valid, this exception is thrown.
updateServerCertificate
public void updateServerCertificate(java.lang.String ccmTFTPAddress,java.lang.String ccmTFTPPort,java.lang.String ccmCAPFAddress,java.lang.String ccmCAPFPort,java.lang.String certificatePath)This interface installs an X.509 server certificate on a specified certificate path. If the TFTP server address provided is not correct, this method throws an InvalidArgumentException. Auto update Applications should use this interface to update the server certificate before invoking an HTTPS connection with Cisco Unified Communications Manager.
Pre-conditions:
When calling this interface, Application should have network connectivity with the TFTP server.
Post-conditions:
This method installs the server certificate on the JTAPI Application machine.
Parameters:
ccmTFTPAddress—The IP address of the Cisco Unified Communications Manager TFTP server.
ccmTFTPPort—Port number on which the Cisco Unified Communications Manager TFTP Server is running. If null, the specified default value 69 is used.
certificatePath—The path for installing the server certificate.
ccmCAPFAddress—The IP Address of the Cisco Unified Communications Manager CAPF server.
ccmCAPFPort—Port number on which the Cisco Unified Communications Manager CAPF server is running. If null, the specified default value 3804 is used.
Throws:
InvalidArgumentException—If the TFTP server address is invalid, this exception is thrown.
CiscoJtapi Version
Declaration
public class CiscoJtapiVersionjava.lang.Object|+--com.cisco.jtapi.extensions.CiscoJtapiVersionDescription
This class gives the version information of the installed Cisco Unified JTAPI. Programs can get the version number using the accessor methods. Cisco Unified JTAPI Version is in a.b(x.y) format where a indicates the major version b indicates the minor version x indicates the revision number y indicates the build number.
Constructors
CiscoJtapiVersion()
public CiscoJtapiVersion()Methods
getBuildDescription()
public java.lang.String getBuildDescription()Returns 'release' if it is a release version or debug if it is not a release version
getBuildNumber()
public int getBuildNumber()This returns the build number of the version
getExtendedBuildNumber ()
public int getExtendedBuildNumber()Returns an integer between 1-65535.
getMajorVersion()
public int getMajorVersion()This method returns the major version number
getMinorVersion()
public int getMinorVersion()This method returns the minor version number
getRevisionNumber()
public int getRevisionNumber()This method returns the revision number of the version
getVersion()
public java.lang.String getVersion()returns the version information in a.b(x.y) format without name
IS_GREATER_EXTENDEDBUILD_VERSION
public int IS_GREATER_EXTENDEDBUILD_VERSIONThis is returned if this component in thisComponent.compareTo(otherComponent) is greater than the other component only by the extended build number.
IS_LESSER_EXTENDEDBUILD_VERSION
public int IS_LESSER_EXTENDEDBUILD_VERSIONThis is returned if this component in thisComponent.compareTo(otherComponent) is less than the other component only by the extended build number.
toString()
public java.lang.String toString()returns the 5 digit version information in a.b(x.y) format
Overrides:
toString in class Object
CiscoLocales
Declaration
public interface CiscoLocalesDescription
This interface lists all the locales supported by Cisco Unified JTAPI.
Fields
LOCALE_ENGLISH_UNITED_STATES
static final int LOCALE_ENGLISH_UNITED_STATES;LOCALE_FRENCH_FRANCE
static final int LOCALE_FRENCH_FRANCELOCALE_GERMAN_GERMANY
static final int LOCALE_GERMAN_GERMANYLOCALE_RUSSIAN_RUSSIA
static final int LOCALE_RUSSIAN_RUSSIALOCALE_SPANISH_SPAIN
static final int LOCALE_SPANISH_SPAINLOCALE_ITALIAN_ITALY
static final int LOCALE_ITALIAN_ITALYLOCALE_DUTCH_NETHERLAND
static final int LOCALE_DUTCH_NETHERLANDLOCALE_NORWEGIAN_NORWAY
static final int LOCALE_NORWEGIAN_NORWAYLOCALE_PORTUGUESE_PORTUGAL
static final int LOCALE_PORTUGUESE_PORTUGALLOCALE_SWEDISH_SWEDEN
static final int LOCALE_SWEDISH_SWEDENLOCALE_DANISH_DENMARK
static final int LOCALE_DANISH_DENMARKLOCALE_JAPANESE_JAPAN
static final int LOCALE_JAPANESE_JAPANLOCALE_HUNGARIAN_HUNGARY
static final int LOCALE_HUNGARIAN_HUNGARYLOCALE_POLISH_POLAND
static final int LOCALE_POLISH_POLANDLOCALE_GREEK_GREECE
static final int LOCALE_GREEK_GREECELOCALE_TRADITIONAL_CHINESE_CHINA
static final int LOCALE_TRADITIONAL_CHINESE_CHINALOCALE_SIMPLIFIED_CHINESE_CHINA
static final int LOCALE_SIMPLIFIED_CHINESE_CHINALOCALE_KOREAN_KOREA
static final int LOCALE_KOREAN_KOREALOCALE_FINNISH_FINLAND
static final int LOCALE_FINNISH_FINLANDLOCALE_PORTUGUESE_BRAZIL
static final int LOCALE_PORTUGUESE_BRAZILLOCALE_CHINESE_HONG_KONG
static final int LOCALE_CHINESE_HONG_KONGLOCALE_SLOVAK_SLOVAKIA
static final int LOCALE_SLOVAK_SLOVAKIALOCALE_CZECH_CZECH_REPUBLIC
static final int LOCALE_CZECH_CZECH_REPUBLICLOCALE_BULGARIAN_BULGARIA
static final int LOCALE_BULGARIAN_BULGARIALOCALE_CROATIAN_CROATIA
static final int LOCALE_CROATIAN_CROATIALOCALE_SLOVENIAN_SLOVENIA
static final int LOCALE_SLOVENIAN_SLOVENIALOCALE_ROMANIAN_ROMANIA
static final int LOCALE_ROMANIAN_ROMANIALOCALE_CATALAN_SPAIN
static final int LOCALE_CATALAN_SPAINLOCALE_ENGLISH_UNITED_KINGDOM
static final int LOCALE_ENGLISH_UNITED_KINGDOMLOCALE_ARABIC_UNITED_ARAB_EMIRATES
static final int LOCALE_ARABIC_UNITED_ARAB_EMIRATESLOCALE_ARABIC_OMAN
static final int LOCALE_ARABIC_OMANLOCALE_ARABIC_SAUDI_ARABIA
static final int LOCALE_ARABIC_SAUDI_ARABIALOCALE_ARABIC_KUWAIT
static final int LOCALE_ARABIC_KUWAITLOCALE_HEBREW_ISRAEL
static final int LOCALE_HEBREW_ISRAELLOCALE_SERBIAN_REPUBLIC_OF_SERBIA
static final int LOCALE_SERBIAN_REPUBLIC_OF_SERBIALOCALE_SERBIAN_REPUBLIC_OF_MONTENEGRO
static final int LOCALE_SERBIAN_REPUBLIC_OF_MONTENEGROLOCALE_THAI_THAILAND
static final int LOCALE_THAI_THAILANDLOCALE_ARABIC_ALGERIA
static final int LOCALE_ARABIC_ALGERIALOCALE_ARABIC_BAHRAIN
static final int LOCALE_ARABIC_BAHRAINLOCALE_ARABIC_EGYPT
static final int LOCALE_ARABIC_EGYPTLOCALE_ARABIC_IRAQ
static final int LOCALE_ARABIC_IRAQLOCALE_ARABIC_JORDAN
static final int LOCALE_ARABIC_JORDANLOCALE_ARABIC_LEBANON
static final int LOCALE_ARABIC_LEBANONLOCALE_ARABIC_MOROCCO
static final int LOCALE_ARABIC_MOROCCOLOCALE_ARABIC_QATAR
static final int LOCALE_ARABIC_QATARLOCALE_ARABIC_TUNISIA
static final int LOCALE_ARABIC_TUNISIALOCALE_ARABIC_YEMEN
static final int LOCALE_ARABIC_YEMENCiscoCallSecurityIndicator
Declaration
public interface CiscoCallSecurityIndicatorDescription
Methods
getCallID()
CiscoCallID getCallID()Returns CiscoCallID object if there is already CiscoCall present when this event is sent. If there is no CiscoCall present, then this method will return null.
getCiscoSecurityIndicator()
public int getCiscoSecurityIndicator()Returns one of the following constants from CiscoSecurityIndicator:
_ENCRYPTED_KEYS_AVAILABLE
MEDIA_ENCRYPT_USER_NOT_AUTHORIZED
MEDIA_ENCRYPTED_KEYS_UNAVAILABLE
MEDIA_NOT_ENCRYPTED
getCiscoRTPHandle()
CiscoRTPHandle getCiscoRTPHandle()Returns CiscoRTPHandle object. Applications can get call reference using CiscoProvider.getCall ( CiscoRTPHandle ).If there is no callobserver or if there was no callobserver when this event is delivered, then CiscoProvider.getCall( CiscoRTPHandle ) may return null.
CiscoMediaCapability
Declaration
public class CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.CiscoMediaCapabilityDirect Known Subclasses
CiscoG711MediaCapability, CiscoG723MediaCapability, CiscoG729MediaCapability, CiscoGSMMediaCapability, CiscoWideBandMediaCapability
Description
The CiscoMediaCapability object specifies the properties of a particular media format that an application can support for CiscoMediaTerminals that it registers. Because CiscoMediaCapability is an abstract class, applications may only construct its subclasses directly.
See Also:
CiscoG711MediaCapability, CiscoG723MediaCapability, CiscoG729MediaCapability, CiscoGSMMediaCapability, CiscoRTPBitRate, CiscoRTPPayload
Fields
G711_64K_30_MILLISECONDS
public static finalcom.cisco.jtapi.extensions.CiscoMediaCapability G711_64K_30_MILLISECONDSG.711 capability with default parameters
See Also:
G723_6K_30_MILLISECONDS
public static finalcom.cisco.jtapi.extensions.CiscoMediaCapability G723_6K_30_MILLISECONDSG.723 capability with default parameters
See Also:
G729_30_MILLISECONDS
public static finalcom.cisco.jtapi.extensions.CiscoMediaCapability G729_30_MILLISECONDSG.729 capability with default parameters
See Also:
GSM_80_MILLISECONDS
public static finalcom.cisco.jtapi.extensions.CiscoMediaCapability GSM_80_MILLISECONDSGSM capability with default parameters
See Also:
WIDEBAND_256K_10_MILLISECONDS
public static finalcom.cisco.jtapi.extensions.CiscoMediaCapability WIDEBAND_256K_10_MILLISECONDSWideband capability with default parameters
See Also:
Constructors
CiscoMediaCapability(int, int)
public CiscoMediaCapability(int payloadType,int maxFramesPerPacket)Constructs a CiscoMediaCapability object for the specified payload type and packet size.
Methods
getMaxFramesPerPacket()
public int getMaxFramesPerPacket()Returns the packet size (in milliseconds) specified by this object.
Returns:
the packet size, specified as a number of milliseconds. The maxFramesPerPacket parameter is a carry over from the H.245 protocol definition. Cisco Unified Communications Manager does not use this field as the number of frames per RTP packet, but rather as the number of milliseconds of audio per RTP packet that the device can receive. Non-Cisco IP Phones may utilize different (higher) rates even though these rates may not be exceeded to and or from Cisco IP Phones.
getPayloadType()
public int getPayloadType()Returns the payload type specified by this object.
Returns:
a payload type from the RTPPayload interface
isSupported()
public boolean isSupported()Returns whether the payload of this object is supported or not.
Returns:
true if the payloadType gets supported; otherwise, false.
toString()
public java.lang.String toString()Overrides:
toString in class Object
CiscoMediaConnectionMode
Declaration
public interface CiscoMediaConnectionModeDescription
This is a new interface introduced in this release that lists all the media connection modes:
•
•
•
•
Fields
NONE
public static final int NONERECEIVE_ONLY
public static final int RECEIVE_ONLYTRANSMIT_ONLY
public static final int TRANSMIT_ONLYTRANSMIT_AND_RECEIVE
public static final int TRANSMIT_AND_RECEIVECiscoMediaEncryptionKeyInfo
Declaration
public interface CiscoMediaEncryptionKeyInfoDescription
This is a new interface introduced in this release for SRTP Key Materials.
Methods
getAlgorithmID()
public int getAlgorithmID()This method returns the media encryption algorithm for the current stream
getIsMKIPresent()
public int getIsMKIPresent()An MKI Indicator which indicates whether MKI is present or not.The MKI is defined, signaled, and used by key management.
getKeyLength()
public int getKeyLength()This method returns master Key Length
getKey()
byte[] getKey()This method returns master key for the stream
getSaltLength()
public int getSaltLength()This method returns salt length
getSalt()
byte[] getSalt()This method returns salt key for the stream
keyDerivationRate()
public int getDerivationRate()Indicates SRTP key Derivation rate for this session.
CiscoMediaOpenLogicalChannelEv
Declaration
public interface CiscoMediaOpenLogicalChannelEv extends CiscoTermEvAll Superinterfaces:
CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEv
Description
The CiscoMediaOpenLogicalChannelEv event is sent each time when media is established for dynamically registered CiscoMediaTerminals or CiscoRouteTerminals. Upon receiving this event applications must invoke setRTPParams on CiscoMediaTerminal or CiscoRouteTerminal and pass in the IP Address and port number where to terminate media along with rtpHandle that is delivered in this event. Applications can get call reference using CiscoProvider.getCall(CiscoRTPHandle). Applications need to be aware that the far end and local end may not be able to invoke features unless setRTPParams method is invoked. If applications fail to respond to this event within the specified time, the call may be disconnected.
Fields
ID
public static final int IDMethods
getCiscoRTPHandle()
public com.cisco.jtapi.extensions.CiscoRTPHandle getCiscoRTPHandle()Returns CiscoRTPHandle object. Applications should pass this handle along with RTP Parameters to CiscoMediaTerminal or CiscoRouteTerminal. Applications can get call reference using CiscoProvider.getCall. If there is no callobserver or there was no callobserver when this event gets delivered, then CiscoProvider.getCall may return null.
See Also:
CiscoRTPParams
getMediaConnectionMode()
public int CiscoMediaConnectionMode getMediaConnectionMode()This interface returns CiscoMediaConnectionMode. Applications could get the following values for mediaMode:
•
•
You should never get an event with mode NONE; however, if that happens Applications should ignore the event and log an error.
getPacketSize()
public int getPacketSize()Returns the packet size of the far end in milliseconds.
getPayLoadType()
public int getPayLoadType()Returns the payload format of the far end, one of the following constants:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
CiscoMediaSecurityIndicator
Description
This is sent in the CiscoRTPInputKeyEv and CiscoRTPOutputKeyEv messages. It indicates the security status of the call and has one of the following values:
•
•
•
•
Fields
static int MEDIA_ENCRYPTED_KEYS_AVAILABLEIndicates that media terminated is secured and keys are available.
static int MEDIA_ENCRYPTED_KEYS_UNAVAILABLEIndicates that media is terminated in secured mode, but keys are not available because SRTP is not enabled in Cisco Unified Communications Manager Admin User pages. This could be because either there is no TLS or no IPSec configured for this application.
static int MEDIA_ENCRYPTED_USER_NOT_AUTHORIZEDIndicates that media is terminated in secured mode, but keys are not available because user is not authorized to get the keys.
static int MEDIA_NOT_ENCRYPTEDIndicates that media is not encrypted for this call.
CiscoMediaTerminal
Declaration
public interface CiscoMediaTerminal extends CiscoTerminalAll Superinterfaces
CiscoObjectContainer, CiscoTerminal, javax.telephony.Terminal
Description
A CiscoMediaTerminal is a special kind of CiscoTerminal that allows applications to terminate RTP media streams. Unlike a CiscoTerminal, a CiscoMediaTerminal does not represent a physical telephony endpoint, which is observable and controllable in a third-party manner. Instead, a CiscoMediaTerminal is a logical telephony endpoint, which may be associated with any application that desires to terminate media. Such applications include voice mail systems, interactive voice response (IVR), and "soft" phones.
Note
Terminating media is a two-step process. To terminate media for a particular terminal, an application adds an observer that implements the CiscoTerminalObserver interface using the Terminal.addObserver method. Finally, the application registers its IP address and port number to which the Terminal's incoming RTP streams are to be directed using the CiscoMediaTerminal.register method.
See Also:
Methods
changeRTPDefaults(InetAddress, int)
public void changeRTPDefaults(java.net.InetAddress address,int port) throws CiscoRegistrationExceptionChanges the default registration parameters to specified address and port. Only Registered application may invoke this method.
Parameters:
address - the internet address for inbound RTP streams on this terminal
port - the UDP port for inbound RTP streams on this terminal
Throws:
isRegistered()
public boolean isRegistered()This method returns true if the CiscoMediaTerminal is registered and false otherwise.
isRegisteredByThisApp()
public boolean isRegisteredByThisApp()This method returns true if this application issued a successful registration request. This if valid even if device is out of service because of CTIManager failure. This will be set to true until this application unregisters the device.
register(CiscoMediaCapability[], int)
public voidregister(com.cisco.jtapi.extensions.CiscoMediaCapability[] capabilities, int failureCloseDelay) throws CiscoRegistrationExceptionThe CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to register the MediaTerminal. Registers a Terminal with specified CiscoMediaCapabilities. Indicates that application is interested in supplying ipAddress and port dynamically for each call. Applications registering with this method receive CiscoMediaOpenLogicalChannelEv for each call and will have to supply ipAddress and port number using setRTPParams method on CiscoTerminalConnection.
Method Arguments
Arguments indicate the type of RTP encodings that the application is willing to support for this Terminal and the application or CTIManager failure persistence delay
Method Post-conditions
This method returns successfully when the CiscoMediaTerminal is registered.
Parameters:
capabilities - the list of RTP encodings supported by this terminal
failureCloseDelay - persistence delay seconds on application or CTIManager failure
Throws:
CiscoRegistrationException
See Also:
CiscoMediaOpenLogicalChannelEv
register(InetAddress, int)
public void register(java.net.InetAddress address, int portthrows CiscoRegistrationExceptionDeprecated.
Registers a Terminal with the specified address and port, defaulting to G.711 64KHz u-law encoding with a thirty millisecond packet size.
Parameters:
address - the internet address for inbound RTP streams on this terminal
port - the UDP port for inbound RTP streams on this terminal
Throws:
register(InetAddress, int, CiscoMediaCapability[])
public void register(java.net.InetAddress address, int port,com.cisco.jtapi.extensions.CiscoMediaCapability[] capabilities) throws CiscoRegistrationExceptionThe CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to register the MediaTerminal.
Method Arguments
This method has three arguments. The first argument specifies the internet address at which the RTP media stream for this Terminal will be terminated, the second indicates the UDP port at which RTP packets will be directed, and the final argument indicates the type of RTP encodings that the application is willing to support for this Terminal.
Method Post-conditions
This method returns successfully when the MediaTerminal is registered.
Parameters:
address - the internet address for inbound RTP streams on this terminal
port - the UDP port for inbound RTP streams on this terminal
capabilities - the list of RTP encodings supported by this terminal
Throws:
register(CiscoMediaCapability[] capabilities, int[] supportedAlgorithms)
public void register(CiscoMediaCapability[] capabilities, int[] supportedAlgorithms)The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. This interface is provided for dynamic registration with secure media. By default if applications do not invoke this method, media is terminated in non-secure mode.
register(java.net.InetAddress address, int port, CiscoMediaCapability[] capabilities, int[] algorithmIDs)
public void register(java.net.InetAddress address, int port,CiscoMediaCapability[] capabilities, int[] algorithmIDs)The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. This interface is provided for static registration with secure media. By default media is non-secured if applications do not register this interface. AlgorithmIDs indicates SRTP algorithms that this CTIPort supports. AlgorithmIDs may only be one of CiscoSupportedAlgorithms
register(InetAddress, int, CiscoMediaCapability[], int)
public void register(java.net.InetAddress address, int port,com.cisco.jtapi.extensions.CiscoMediaCapability[] capabilities, int failureCloseDelay) throws CiscoRegistrationExceptionThe CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to register the MediaTerminal.
Method Arguments
This method has four arguments. The first argument specifies the internet address at which the RTP media stream for this Terminal will be terminated, the second indicates the UDP port at which RTP packets will be directed, the third argument indicates the type of RTP encodings that the application is willing to support for this Terminal, and the final argument is the application or CTIManager failure persistence delay
Method Post-conditions
This method returns successfully when the MediaTerminal is registered.
Parameters:
address - the internet address for inbound RTP streams on this terminal
port - the UDP port for inbound RTP streams on this terminal
capabilities - the list of RTP encodings supported by this terminal
failureCloseDelay - persistence delay seconds on application or CTIManager failure
Throws:
setRTPParams(CiscoRTPHandle, CiscoRTPParams)
public void setRTPParams(com.cisco.jtapi.extensions.CiscoRTPHandle0 rtpHandle, com.cisco.jtapi.extensions.CiscoRTPParams rtpParams)throws InvalidStateException, InvalidArgumentException, PrivilegeViolationExceptionApplications can set ipAddress and RTP Port number to dynamically stream media for a call. In order to do this, applications will have to register MediaTerminal or CiscoRouteTeminal by providing only capabilities. Applications will have to invoke this method upon receiving CiscoCallOpenLogicalChannel on terminalObserver. Applications need to pass in rtpHandle that is received in CiscoCallOpenLogicalChannelEv. Applications can get CiscoCall reference using CiscoProvider.getRTPHandle(rtpHandle) method. This may return null if either no callobserver is added on the terminal or no callobserver at the time when this event was sent or there is no call associated with this handle.
Throws:
javax.telephony.PrivilegeViolationException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException
See Also:
unregister()
public void unregister()throws CiscoUnregistrationExceptionThe CiscoMediaTerminal must not be registered and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to unregister the MediaTerminal.
Method Post-conditions
This method returns successfully when the MediaTerminal is unregistered.
Throws:
CiscoMediaTerminalConnection
Description/Usage
Applications can use these methods to start and stop recording. If the startRecording() interface is used, no tone is played to the caller or the recording initiator.
Methods
GetMediaState()
public int GetMediaState()Returns MediaTerminalConnection.RECORDING when recording is in progress and MediaTerminalConnection.NOACTIVITY if there is no recording.
startRecording()
public void startRecording()MethodNotSupportedException, ResourceUnavailableException, InvalidStateExceptionstopRecording()
pubic void stopRecording()CiscoMediaTerminalConnectionCapabilities
Description/Usage
This interface returns information about recording capabilities.
Methods
canStartRecording()
public boolean canStartRecording()Returns true if the provider has the canRecord capability, the address is configured with application-controlled call recording, and the terminal connection is in the TALKING state
canStopRecording()
public boolean canStopRecording()Returns true if the provider has the canRecord capability, the address is configured with application-controlled call recording, the terminal connection is in the TALKING state, and the media state is MediaTerminalConnection.RECORDING.
CiscoMonitorInitiatorInfo
Description/Usage
This interface provides information about the monitor initiator.
Methods
getMonitorInitiatorCallLegHandle()
public int getMonitorInitiatorCallLegHandle()Returns the handle of the call at the monitor initiator. JATAPI can get the call at the monitor target using provider.getCall (int monitorInitiatorCallLegHandle). This method returns null if the call at the monitor initiator is not active in this provider.
getTerminalName()
public string getTerminalName()Returns the name of the monitor initiator device.
getAddress()
public address getAddress()Returns the address of the monitor initiator.
CiscoMonitorTargetInfo
Description/Usage
This interface provides information about the monitor target.
Methods
getmonitorTargetCallLegHandle()
public int getmonitorTargetCallLegHandle()Returns the handle of the call at the monitor target. JTAPI can get the call at the monitor target using provider.getCall(intmonitorTargetCallLegHandle). This method returns null if the monitor target call is not active in this provider.
getTerminalName()
public string getTerminalName()Returns the name of the monitor target device.
getAddress()
public address getAddress()Returns the address of the monitor target.
CiscoObjectContainer
Declaration
public interface CiscoObjectContainerAll Known Subinterfaces
CiscoAddress, CiscoCall, CiscoCallID, CiscoConnection, CiscoConnectionID, CiscoConsultCall, CiscoJtapiPeer, CiscoMediaTerminal, CiscoProvider, CiscoTerminal, CiscoTerminalConnection
Description
The ApplicationObject interface allows applications to associate an application defined object to objects that implement this interface.
Methods
getObject()
public java.lang.Object getObject()Gets the application-defined object.
Returns:
the CallID property of this Call
setObject(Object)
public java.lang.Object setObject(java.lang.Object reference)Sets an application-defined object.
Returns:
the CallManagerID property of this Call
CiscoOutOfServiceEv
Declaration
public interface CiscoOutOfServiceEv extends CiscoEvAll Superinterfaces
CiscoEv, javax.telephony.events.Ev
All Known Subinterfaces
CiscoAddrOutOfServiceEv, CiscoTermOutOfServiceEv
Description
The CiscoAddrOutOfServiceEv event is sent when an address goes out of service.
Fields
CAUSE_CALLMANAGER_FAILURE
public static final int CAUSE_CALLMANAGER_FAILURECAUSE_CTIMANAGER_FAILURE
public static final int CAUSE_CTIMANAGER_FAILURECAUSE_DEVICE_FAILURE
public static final int CAUSE_DEVICE_FAILURECAUSE_DEVICE_RESTRICTED
public static final int CAUSE_DEVICE_RESTRICTEDCAUSE_DEVICE_UNREGISTERED
public static final int CAUSE_DEVICE_UNREGISTEREDCAUSE_LINE_RESTRICTED
public static final int CAUSE_LINE_RESTRICTEDCAUSE_NOCALLMANAGER_AVAILABLE
public static final int CAUSE_NOCALLMANAGER_AVAILABLECAUSE_REHOME_TO_HIGHER_PRIORITY_CM
public static final int CAUSE_REHOME_TO_HIGHER_PRIORITY_CMCAUSE_REHOMING_FAILURE
public static final int CAUSE_REHOMING_FAILUREID
public static final int IDCiscoPartyInfo
Declaration
public interface CiscoPartyInfoAll Superinterfaces
CiscoCall
Description
This interface is defined on CiscoCall to allow applications to get the URL information of external SIP entities.
Methods
getUrlInfo()
public interface getURLInfoReturns the URL of the SIP entity.
getAddress()
public Address getAddress()Returns the IP address associated with the SIP entity.
getDisplayName()
public String getDisplayNameReturns the display name associated with the SIP entity. It returns null if the display name is unknown.getUnicodeDisplayName()
public String getUnicodeDisplayNameReturns the Unicode display name associated with the SIP entity. It returns null if the Unicode display name is unknown.
getAddressPI()
public boolean getAddressPI()Returns Presentation Indicator(PI) associated with the IP Address of the SIP entity. If it returns true, Application can display this Address to end users. If it returns false, Applications should not display this Address to end users.
getDisplayNamePI()
public boolean getDisplayNamePI()Returns Presentation Indicator(PI) associated with the DisplayName that is associated with the SIP entity. If it returns true, Application can display this DisplayName to end users. If it returns false, Applications should not display this DisplayName to end users.
getlocale()
public boolean getlocaleReturns the locale associated with the SIP entity.
getVoiceMailbox()
java.lang.String getVoiceMailbox()Returns the voice mail box of the party.
CiscoProvCallParkEv
Declaration
public interface CiscoProvCallParkEv extends CiscoProvFeatureEvAll Superinterfaces
CiscoEv, CiscoProvEv, CiscoProvFeatureEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
Description
The CiscoProvCallParkEv event is delivered to the provider observer when a call is parked by any device in the cluster. To receive this event the application should register using CiscoProvider.registerFeature() and CiscoProvFeatureID.MONITOR_CALLPARK_DN. The user profile used by the application should have the "Call Park Retrieval Allowed" flag enabled to receive this event.
Fields
ID
public static final int IDPARK_STATE_ACTIVE
public static final int PARK_STATE_ACTIVEIndicates that a call is parked
PARK_STATE_IDLE
public static final int PARK_STATE_IDLEIndicates that a call is unparked
REASON_CALLPARK
public static final int REASON_CALLPARKThis event is due to call park
REASON_CALLPARKREMAINDER
public static final int REASON_CALLPARKREMAINDERThis event is due to call park remainder
REASON_CALLUNPARK
public static final int REASON_CALLUNPARKThis event is due to call being unparked
Methods
getintCallIDValue()
public int getintCallIDValue()Returns an integer representation of this object
getParkDN()
public java.lang.String getParkDN()This returns where the call is parked
getParkPartyPartition()
String getParkPartyPartition()This returns the partition where the call is parked
getParkedParty()
public java.lang.String getParkedParty()This returns the DN of the parked party
getParkedPartyPartition()
String getParkedPartyPartition()This returns the partition of the parked party
getParkingParty()
public java.lang.String getParkingParty()This returns the DN of the parking party
getParkingPartyPartition()
String getParkingPartyPartition()This returns the partition of the parking party
getReason()
public int getReason()This returns the reason of the event. Possible states include the following: CiscoProvCallParkEv.REASON_CALLPARK CiscoProvCallParkEv.REASON_CALLUNPARK CiscoProvCallParkEv.REASON_CALLPARKREMAINDER
getState()
public int getState()This returns the state of the call Possible states include the following: CiscoProvCallParkEv.PARK_STATE_IDLE CiscoProvCallParkEv.PARK_STATE_ACTIVE
CiscoProvEv
Declaration
public interface CiscoProvEv extends CiscoEv,javax.telephony.events.ProvEvAll Superinterfaces
CiscoEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
All Known Subinterfaces
CiscoAddrAddedToTerminalEv, CiscoAddrCreatedEv, CiscoAddrRemovedEv, CiscoProvCallParkEv, CiscoProvFeatureEv, CiscoProvFeatureUnRegisteredEv, CiscoTermCreatedEv, CiscoTermRemovedEv
Description
The CiscoProvEv interface, which extends JTAPI's core javax.telephony.events.ProvEv interface, serves as the base interface for all Cisco-extended JTAPI Provider events. Every Provider-related event in this package extends this interface, directly or indirectly.
See Also:
javax.telephony.events.ProvEv
CiscoProvFeatureEv
Declaration
public interface CiscoProvFeatureEv extends CiscoProvEvAll Superinterfaces
CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
All Known Subinterfaces
Methods
getFeatureID()
public int getFeatureID()Feature ID for which application is interested in receiving events
CiscoProvFeatureID
Declaration
public interface CiscoProvFeatureIDDescription
This interface lists the features supported by the registerFeature interface.
Fields
MONITOR_CALLPARK_DN
public static final int MONITOR_CALLPARK_DNThis feature ID is used with registerFeature interface in CiscoProvider to receive CiscoProvCallParkEv when a call is parked or unparked from any device in the cluster.
CiscoProvFeatureUnRegisteredEv
Declaration
public interface CiscoProvFeatureUnRegisteredEv extends CiscoProvEvAll Superinterfaces
CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv
Description
The CiscoProvFeatureUnRegisteredEv event This event indicates the unregistration of a particular feature by Cisco Unified Communications Manager
Fields
ID
public static final int IDMethods
getFeatureID()
public int getFeatureID()FeatureID for which application will no longer receive events
CiscoProvider
Declaration
public interface CiscoProvider extends javax.telephony.Provider,All Superinterfaces
CiscoObjectContainer, javax.telephony.Provider
Description
Methods
createTerminal(java.lang.String name)
CiscoTerminal createTerminal(java.lang.String name)Returns an instance of the CiscoTerminal class which corresponds to the given name.
deleteCall(Call)
public void deleteCall(javax.telephony.Call callthrows InvalidStateExceptionDeletes an unused call created by createCall(). An exception is generated if the call is not in IDLE state or if provider is not in Provider.IN_SERVICE state. Applications may use this interface to move un used calls to INVALID state and reclaim resources allocated to the call.
Pre-conditions:
1.
2.
Post-conditions:
1.
Throws:
javax.telephony.InvalidStateException
deleteTerminal(com.cisco.jtapi.extensions.CiscoTerminal terminal)
void deleteTerminal(com.cisco.jtapi.extensions.CistoTerminal terminal)Removes the CiscoTerminal Object from providers control.
getAddress(string number)
Address[] getAddress(string number)If you have two addresses, A(1000, P1) and B(1000,P2), where 1000 denotes the DN of the two address objects (which is the same) and P1, P2 indicate the partitions to which the addresses belong, when the application calls provider.getAddress("1000"), it will get two address objects, A and B.
When the application then calls A.getPartition(), it will get P1. A call to B.getPartition() returns P2. Applications can distinguish between the two address objects using this getPartition method.
Returns:
An array of Address objects corresponding to the number and different partitions.
getAddress(string number, string partition)
Address getAddress (string number, string partition)Returns:
Address object which has the same DN as the "number" parameter and belongs to the same partition as specified by the "partition" parameter.
getAppDSCPValue()
private int precedenceValue = 0x00;Returns:
The "DSCP IP for CTI applications" service parameter.This value specifies the DSCP value that JTAPI will set on its link to CTI. Applications can get this value by querying the Provider object using this API when they get a ProviderInServiceEvent.
getCall(CiscoRTPHandle)
public com.cisco.jtapi.extensions.CiscoCall0 getCall(com.cisco.jtapi.extensions.CiscoRTPHandle rtpHandle)throws InvalidStateExceptionReturns:
Call object with the rtpHandle associated with a specific terminal. M<ay return null if this rtpHandle is no longer associated with any call or if there was no callObserver added on the terminal at the time when CiscoCallOpenLogicalChannelEv which contained this handle gets sent to applications.
Throws:
javax.telephony.InvalidStateException
getCallbackGuardEnabled()
public boolean getCallbackGuardEnabled()Returns the current state of the callback guard feature
Returns:
the current state of the callback guard feature
getCall(int callleg)
CiscoCall getCall(int callleg)Returns Cisco call corresponding to the call leg if available in provider domain, otherwise it returns a null. This method can be used to access the call on the monitor initiator and monitor target using the call leg in CiscoTermConnMonitorInititatorInfoEv and CiscoTermConnMonitorTargetInfoEv respectively.
getMediaTerminal(String)
public com.cisco.jtapi.extensions.CiscoMediaTerminalgetMediaTerminal(java.lang.String name throws InvalidArgumentExceptionReturns an instance of the CiscoMediaTerminal class which corresponds to the given name. Each CiscoMediaTerminal has a unique name associated with it, which is assigned to it by the JTAPI implementation. If no CiscoMediaTerminal is available for the given name within the Provider's domain, this method throws the InvalidArgumentException. This CiscoMediaTerminal is contained in the arrays generated by Provider.getTerminals() and CiscoProvider.getMediaTerminals().
Pre-conditions:
1.
2.
3.
Post-conditions:
1.
2.
3.
Parameters:
name - The name of desired CiscoMediaTerminal object.
Returns:
The CiscoMediaTerminal object associated with the given name.
Throws:
javax.telephony.InvalidArgumentException - The name provided does not correspond to a name of any CiscoMediaTerminal known to the Provider or within the Provider's domain.
getMediaTerminals()
public com.cisco.jtapi.extensions.CiscoMediaTerminal[]getMediaTerminals()throws ResourceUnavailableExceptionReturns an array of CiscoMediaTerminals associated with the Provider and within the Provider's domain. Each CiscoMediaTerminal possesses a unique name, which is assigned to it by the JTAPI implementation. If there are no CiscoMediaTerminals associated with this Provider, then this method returns null. This array is a subset of the array returned by Provider.getTerminals().
Post-conditions:
1.
2.
3.
Returns:
An array of Terminals in the Provider's local domain.
Throws:
javax.telephony.ResourceUnavailableException - Indicates the number of media terminals present in the Provider is too great to return as a static array.
getVersion()
public java.lang.String getVersion()Returns the current version of provider running if provider is in service otherwise it will return empty string
hasSuperproviderChanged()
public boolean hasSuperproviderChanged()Indicates whether the Superprovider privilege has changed.
hasModifyCallingPartyChanged()
public boolean hasModifyCallingPartyChanged()Indicates whether the ModifyCgPn privilege has changed
hasMonitorParkDNChanged()
public boolean hasMonitorParkDNChanged()Indicates whether the Park DN monitoring privilege has changed
isAutoAnswerEnabled()
public boolean isAutoAnswerEnabled()Returns AutoAnswer status on the address.
registerFeature(int)
public void registerFeature(int featureID)throws InvalidStateException, PrivilegeViolationException, InvalidArgumentExceptio nused to register for a particular feature for which application will get Provider events. Applications should pass in the featureID of the softkey. Current supported features are listed in CiscoProvFeatureID interface
Throws:
javax.telephony.InvalidArgumentException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidStateException
setCallbackGuardEnabled(boolean)
public void setCallbackGuardEnabled(boolean enabled)Enables or disables try/catch logic for observer callbacks
In order to protect itself from application exceptions in observer callbacks, the Provider normally guards all invocations of application interfaces (e.g. observers) with the following code:
try { observer.callStateChanged ( ... ); } catch ( Throwable t ) { // log the exception here }This isolates application errors from the JTAPI implementation, allowing easier troubleshooting, since the JTAPI implementation can note the unhandled exception and continue operating. Some errors are considered non-recoverable and will be re-thrown by JTAPI, generally resulting in application exit. Such errors include ThreadDeath, OutOfMemoryError, and StackOverflowError. Applications wishing to trap errors within JTAPI threads should create a subclass of ThreadGroup and initialize JTAPI from a thread within that ThreadGroup. By overriding the ThreadGroup.uncaughtException () method, the application can be made aware of all unrecoverable errors thrown on JTAPI threads.
In some cases, JTAPI aggressive error-catching approach may make it more difficult to troubleshoot applications within a java debugger. Microsoft Visual J++ version 6.0, for example, does not handle breakpoints within application observer callbacks properly if JTAPI catches Throwable. In such cases, JTAPI application developers may choose to disable the internal JTAPI try/catch logic.
Caution
Parameters:
enabled - if true, callback guard will be enabled; if false, callback guard will be disabled
unregisterFeature(int)
public void unregisterFeature(int featureID)throws InvalidStateExceptionused to unregister a particular feature. Provider events for the feature will stop after unregistering the feature
Throws:
javax.telephony.InvalidStateException
CiscoProviderCapabilities
Declaration
public interface CiscoProviderCapabilities extendsjavax.telephony.capabilities.ProviderCapabilitiesAll Superinterfaces
javax.telephony.capabilities.ProviderCapabilities
Description
This interface defines the specific capabilities offered by the Cisco Unified JTAPI implementation.
Methods
canMonitor()
public boolean canMonitor()Returns true if the silent monitoring capability is configured for the user.
canRecord()
public boolean canRecord()Returns true if the recording capability is configured for the user.
canObserveAnyTerminal()
public boolean canObserveAnyTerminal()Enables a user to be provisioned in the Directory to be able to observe any Terminal (and its addresses) in the system.
CiscoProviderCapabilityChangedEv
Description/Usage
This event is delivered to the provider observer if the capabilities of the JTAPI user changed.
The following methods on this interface will indicate if the monitoring or recording capability of the user has changed.
Methods
hasMonitorCapabilityChanged()
public boolean hasMonitorCapabilityChanged()This interface will return true if the monitoring capability of the provider has changed.
hasRecordingCapabilityChanged()
public boolean hasRecordingCapabilityChanged()This interface will return true if the recording capability of the provider has changed.
CiscoProviderObserver
Declaration
public interface CiscoProviderObserver extendsjavax.telephony.ProviderObserverAll Superinterfaces
javax.telephony.ProviderObserver
Description
Applications implement this interface in order to receive CiscoProvEv events such as CiscoAddrCreatedEv and CiscoTermCreatedEv when observing a Provider via the Provider.addObserver method.
See Also:
CiscoAddrCreatedEv, CiscoTermCreatedEv
CiscoRecorderInfo
Description/Usage
This interface provides information about the recorder in a recording session. When recording session is active, this interface gives information about the recording device.
Methods
get CiscoRecorderInfo ()
Returns a CiscoRecorderInfo which exposes the terminal name and address of the recording device.
getTerminalName()
String getTerminalName()Returns the name of the recording device.
getAddress()
Address getAddress()Returns the recorder address.
CiscoRegistrationException
Declaration
public class CiscoRegistrationException extends java.lang.Exceptionjava.lang.Object|+--java.lang.Throwable|+--java.lang.Exception|+--com.cisco.jtapi.extensions.CiscoRegistrationExceptionAll Implemented Interfaces
java.io.Serializable
Description
The CiscoMediaTerminal.register method throws this exception when the registration process fails for any reason. For example, registration would fail if the Provider were OUT_OF_SERVICE or if the device were already registered.
See Also:
CiscoMediaTerminal.register(InetAddress, int, CiscoMediaCapability[])
Constructors
CiscoRegistrationException()
public CiscoRegistrationException()CiscoRegistrationException(String)
public CiscoRegistrationException(java.lang.String description)CiscoRestrictedEv
This is the parent class for the CiscoAddrRestrictedEv and CiscoAddrRestrictedOnTerminalEv events.
Declaration
public interface CiscoRestrictedEv extends CiscoProvEv {public static final int ID = com.cisco.jtapi.CiscoEventID.CiscoRestrictedEv;/*** The following define the cause codes for restricted events*/public final static int CAUSE_USER_RESTRICTED = 1;public final static int CAUSE_UNSUPPORTED_PROTOCOL = 2;}All Known Subinterfaces
CiscoAddrRestrictedEv, CiscoAddrRestrictedOnTerminalEv, CiscoTermActivatedEv, CiscoTermRestrictedEv
Description
This is the base class for restricted events and defines the cause codes for all restricted events. CAUSE_USER_RESTRICTED indicates the terminal or address is marked are restricted. CAUSE_UNSUPPORTED_PROTOCOL indicates that the device in the control list is using a protocol that is not supported by Cisco Unified JTAPI. Existing 7960 and 7940 phones running SIP fall in this category.
CiscoRouteAddress
Declaration
public interface CiscoRouteAddress extendsjavax.telephony.callcenter.RouteAddressAll Superinterfaces
javax.telephony.Address, javax.telephony.callcenter.RouteAddress
Methods
registerRouteCallback(RouteCallback, boolean)
public void registerRouteCallback(javax.telephony.callcenter.RouteCallbackrouteCallback, boolean disableAutoRehoming)throws ResourceUnavailableException, MethodNotSupportedExceptionThrows:
javax.telephony.MethodNotSupportedException, javax.telephony.ResourceUnavailableException
CiscoRouteEvent
Declaration
public interface CiscoRouteEventextends javax.telephony.callcenter.events.RouteEventDescription/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. If the IP address is not available, this method returns an InetAddress with the IP address 0.0.0.0 and a null HostName. Printing this object yields a string representation of <Blank>/0.0.0.0.
CiscoRouteSession
Declaration
public interface CiscoRouteSession extendsjavax.telephony.callcenter.RouteSessionAll Superinterfaces
javax.telephony.callcenter.RouteSession
Description
The CiscoRouteSession supports application access to underlying call associated with a RouteSession. Also, various internal ERRORs where endRoute is called internally are exposed to the application, should they wish to handle endRouteEvent() in any special way for these cases.
See Also:
javax.telephony.Call
Fields
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 caller's search space.
DONOT_RESET_ORIGINALCALLED
public static final int DONOT_RESET_ORIGINALCALLEDThis could be parameter value for PreferredOriginalCalled Option, it specifies not to reset OriginalCalled
ERROR_INVALID_STATE
public static final int ERROR_INVALID_STATEIf an internal InvalidStateException occurred or some preconditions/postconditions were not met during routing endRoute is called with this ERROR_INVALID_STATE error.
ERROR_NO_CALLBACK
public static final int ERROR_NO_CALLBACKFor now, since there is no default route mechanism in place, if there is no callback registered for this application, an endRoute with this error is called.
ERROR_NONE
public static final int ERROR_NONEERRORS defined for internal successful endRoute call. Error value set for no error.
ERROR_ROUTESELECT_TIMEOUT
public static final int ERROR_ROUTESELECT_TIMEOUTEach routeEvent()/reRouteEvent() sent starts a timer for the application to respond with a routeSelect()/ endRoute(). The default value of this timer is 5secs. Should the application not respond within this time, an endRoute is called with this error = ERROR_ROUTESELECT_TIMEOUT
RESET_ORIGINALCALLED
public static final int RESET_ORIGINALCALLEDThis could be parameter value for PreferredOriginalCalled Option, it value of preferredOriginalCalledOption is set to this, it will reset OriginalCalled to preferredOriginalCalledNumber
ROUTEADDRESS_SEARCH_SPACE
public static final int ROUTEADDRESS_SEARCH_SPACEThis indicates that the redirect should be done using the search space of the route point address.
Methods
getCall()
public javax.telephony.Call getCall()Returns the call associated with this RouteSession.
Returns:
the call associated with this RouteSession
selectRoute(String[], int)
public void selectRoute(java.lang.String[] routeSelected,int callingSearchSpace) throws MethodNotSupportedExceptionThis method overloads the selectRoute method in the RouteSession interface to allow applications to specify a calling search space to be used when the call is redirected to the route destination.
The callingSearchSpace parameter may be:
1.
2.
3.
Throws:
javax.telephony.MethodNotSupportedException
selectRoute(String[], int, String[])
public void selectRoute(java.lang.String[] routeSelected, int callingSearchSpace, java.lang.String[] modifyingCallingNumber)throws PrivilegeViolationException, MethodNotSupportedExceptionSelects one or more possible destinations for the routing of the Call with modifying calling number. This method takes an array of string destination telephone address names, modifying calling numbers in priority order. The highest priority destination is the first element in the given array, and routing is attempted with this destination first with the corresponding element of modifying calling number. If modifiedCallingNumber is null for an element, the calling number is not modified, if a call is routed to that particular routeSelected element.
Successive given destination addresses are attempted until one is found which does not fail. A RouteUsedEvent event is delivered to the application when a successful routing destination has been selected and the Call has been routed to that destination. Pre-conditions: this.getRouteAddress().getProvider().getState() == Provider.IN_SERVICE this.getState() == RouteSession.ROUTE or RouteSession.RE_ROUTE Post-Conditions this.getRouteAddress().getProvider().getState() == Provider.IN_SERVICE this.getState() == RouteSession.ROUTE_USED if Call was successfully routed. RouteUsedEvent is delivered for this RouteSession if a successful destination was selected.
Parameters:
routeSelected - A list of possible destinations for the call.
Throws:
MethodNotSupportedExceptionImpl - Routing is not supported by the implementation. The callingSearchSpace parameter may be:
CiscoRouteSession.DEFAULT_SEARCH_SPACE
CiscoRouteSession.CALLINGADDRESS_SEARCH_SPACE
CiscoRouteSession.ROUTEADDRESS_SEARCH_SPACE
The modifiedCallingNumber may be an array of elements for which application would like to modify the calling number when call reaches routeselected element.
javax.telephony.MethodNotSupportedException, javax.telephony.PrivilegeViolationException
selectRoute(String[], int, String[], int[])
public void selectRoute(java.lang.String[] routeSelected, int callingSearchSpace, java.lang.String[] preferredOriginalCalledNumber, int[] preferredOriginalCalledOption)throws PrivilegeViolationException, MethodNotSupportedExceptionSelects one or more possible destinations for the routing of the Call. This method takes an array of string destination telephone address names, in prioritized order and array of string for PreferredOriginalCalled number. PreferredOriginalCalled number will be selected corresponding to index of destination telephone name Array. If index corresponding to destination array is not found in PreferredOriginalCalled number array then preferredOriginalCalled preferredOriginalCalled will be set to destination.
The highest priority destination is the first element in the given array, and routing is attempted with this destination first. Successive given destination addresses are attempted until one is found which does not fail. A RouteUsedEvent event is delivered to the application when a successful routing destination has been selected and the Call has been routed to that destination.
Pre-conditions:
this.getRouteAddress().getProvider().getState() == Provider.IN_SERVICE this.getState() == RouteSession.ROUTE or RouteSession.RE_ROUTE Post-Conditions this.getRouteAddress().getProvider().getState() == Provider.IN_SERVICE this.getState() == RouteSession.ROUTE_USED if Call was successfully routed. RouteUsedEvent is delivered for this RouteSession if a successful destination was selected.
Parameters:
routeSelected - A list of possible destinations for the call.
preferredOriginalCalledOption - A list of option each corresponding to RouteList, this option specifies whether to set OriginalCalled to preferredOriginalCalledNumber. This takes value CiscoRouteSession.DONOT_RESET_ORIGINALCALLED, CiscoRouteSession.RESET_ORIGINALCALLED. If value is not specified or it is null then, JTAPI will default it to CiscoRouteSession.DONOT_RESET_ORIGINALCALLED
Throws:
MethodNotSupportedExceptionImpl - Routing is not supported by the implementation.
javax.telephony.MethodNotSupportedException, javax.telephony.PrivilegeViolationException
selectRoute(String[], int, String[], String[], int[], String[], String[], int)
Connection selectRoute(String[] routeSelected, int callingSearchSpace, String[] modifyingCallingNumber, String[] preferredOriginalCalledNumber, int[] preferredOriginalCalledOption, String[] facCode, String[] cmcCode, int featurePriority)This version of the selectRoute() interface is overloaded with the parameter "featurePriority".
Range of Values:
–
–
–
Default Value:
CiscoCall.FEATUREPRIORITY_NORMAL
CiscoRouteTerminal
Declaration
public interface CiscoRouteTerminal extends CiscoTerminalAll Superinterfaces
CiscoObjectContainer, CiscoTerminal, javax.telephony.Terminal
Description
A CiscoRouteTerminal is a special kind of CiscoTerminal that allows applications to terminate RTP media streams. Unlike a CiscoTerminal, a CiscoRouteTerminal does not represent a physical telephony endpoint, which is observable and controllable in a third-party manner. Instead, a CiscoRouteTerminal is a logical telephony endpoint, which may be associated with any application that desires to route calls and also terminate media. Unlike CiscoMediaTerminal, CiscoRouteTerminal can have multiple active calls at the same time. Typically, CiscoRouteTerminals will be used to put callers in queue until an agent is available to service the caller.
Note
Terminating media is a three-step process.
1.
2.
3.
Applications will receive CiscoMediaOpenLogicalChannelEv for each call and will have to supply ipAddress and port number using setRTPParams method on CiscoTerminalConnection.
Note
Multiple applications can register with same RoutePoint as long as they are registered with same media capabilities and registrationType. All applications if registered with CiscoRouteTerminal.DYNAMIC_MEDIA_REGISTRATION and adds callObserver will receive CiscoMediaOpenLogicalChannelEv but only one application will be able to invoke setRTPParams.
CiscoRouteTerminals can also be registered with a delayed close. On an application or CTIManager failure the Cisco Unified Communications Manager persists the CiscoRouteTerminal resource for the duration of the delay. This allows a back-up application to recover the route point and take over the call control for it. Calls that are in an ACCEPTED or CONNECTED state will remain and the back-up application's CallObserver will be delivered existing call notifications.
See Also:
Fields
DYNAMIC_MEDIA_REGISTRATION
public static final int DYNAMIC_MEDIA_REGISTRATIONApplications that are interested in media termination need to register with this type and pass in capabilities that it supports in registration request.
NO_MEDIA_REGISTRATION
public static final int NO_MEDIA_REGISTRATIONApplications that are not interested in media termination need to register with this type and pass in null value for CiscoMediaCapability in the registration request.
Methods
isRegistered()
public boolean isRegistered()This method returns true only if the CiscoRouteTerminal is registered and false otherwise. If RouteTerminal is OutOfService, this returns false and if it is InService, it returns true. For CTIManager failure cases, this is false.
isRegisteredByThisApp()
public boolean isRegisteredByThisApp()This method returns true if this application issued a successful registration request. This if valid even if device is out of service because of CTIManager failure. This will be set to true until this application unregisters the device.
register(CiscoMediaCapability[], int, int)
public void register(com.cisco.jtapi.extensions.CiscoMediaCapability[] capabilities, int registrationType, int failureCloseDelay)throws CiscoRegistrationExceptionThe CiscoRouteTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to register the RouteTerminal. Registers a Terminal with specified CiscoMediaCapabilities and register type.
1.
2.
Method Arguments
Capabilities:
1.
Possible RegistrationTypes:
1.
2.
FailureCloseDelay:
1.
Method Post-conditions
This method returns successfully when the CiscoRouteTerminal is registered.
Parameters:
capabilities - the list of RTP encodings supported by this terminal
registrationType - CiscoRouteTerminal.DYNAMIC_MEDIA_REGISTRATION or CiscoRouteTerminal.NO_MEDIA_REGISTRATION
failureCloseDelay - persistence delay seconds on application or CTIManager failure
register(CiscoMediaCapability[] capabilities, int registrationType, int[] algorithmIDs)
public void register(CiscoMediaCapability[] capabilities, int registrationType, int[] algorithmIDs)The CiscoRouteTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. By default media is terminated in non-secure mode. AlgorithmIDs indicates SRTP algorithms that this CTIPort supports. AlgorithmIDs may only be one of CiscoSupportedAlgorithms.
setRTPParams(CiscoRTPHandle, CiscoRTPParams)
public void setRTPParams(com.cisco.jtapi.extensions.CiscoRTPHandle0 rtpHandle, com.cisco.jtapi.extensions.CiscoRTPParams0 rtpParams)throws InvalidStateException, InvalidArgumentException, PrivilegeViolationExceptionApplications can set ipAddress and RTP Port number to dynamically stream media for a call. In order to do this, applications will have to register MediaTerminal or CiscoRouteTeminal by providing only capabilities. Applications will have to invoke this method upon receiving CiscoCallOpenLogicalChannel on terminalObserver. Applications need to pass in rtpHandle that is received in CiscoCallOpenLogicalChannelEv
Throws:
javax.telephony.PrivilegeViolationException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException
See Also:
CiscoRTPParams, CiscoMediaOpenLogicalChannelEv
unregister()
public void unregister()throws CiscoUnregistrationExceptionThe CiscoRouteTerminal must be registered and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to unregister the RouteTerminal.
Method Post-conditions
This method returns successfully when the MediaTerminal is unregistered.
Throws:
CiscoUnregistrationException
CiscoRouteUsedEvent
Declaration
public interface CiscoRouteUsedEvent extendsjavax.telephony.callcenter.events.RouteUsedEventAll Superinterfaces
javax.telephony.callcenter.events.RouteSessionEvent
javax.telephony.callcenter.events.RouteUsedEvent
Description
The CiscoRouteUsedEvent event interface indicates the RouteSession interface has moved into the RouteSession.ROUTE_USED state and the Call has terminated at a destination as a result of routing by the application. This interface extends the RouteUsedEvent interface and is reported via the RouteCallback interface.
Methods
getRouteSelectedIndex()
public int getRouteSelectedIndex()This method returns an array index of route where the call has been routed.
CiscoRTPBitRate
Declaration
public interface CiscoRTPBitRateDescription
The RTPBitRate interface contains constants describing G.723 RTP bit rates. These constants are returned by the CiscoRTPInputProperties.getBitRate method and the CiscoRTPOutputProperties.getBitRate method.
See Also:
CiscoRTPInputProperties.getBitRate(), CiscoRTPOutputProperties.getBitRate()
Fields
R5_3
public static final int R5_35.3k G.723 bit rate
R6_4
public static final int R6_46.4k G.723 bit rate
CiscoRTPHandle
Declaration
public interface CiscoRTPHandleDescription
The CiscoRTPHandle is returned in CiscoMediaCallOpenLogicalChannelEv and applications should pass this handle in setRTPParams of CiscoMediaTerminal or CiscoRouteTerminal depending on where CiscoMediaCallOpenLogicalChannelEv is received. Applications can use this object to get call reference using CiscoProvider.getCall(CiscoRTPHandle). However, if there is no callobserver added or there was no callobserver added at the time when CiscoMediaCallOpen LogicalChannelEv is sent, CiscoProvider.getCall(CiscoRTPHandle) may return null method.
Methods
getHandle()
public int getHandle()Returns an integer representation of this object, currently the Cisco Unified Communications Manager CallLeg ID of the call.
Returns:
an integer representation of this object
CiscoRTPInputKeyEv
Declaration
public interface CiscoRTPInputKeyEvDescription
Methods
getCiscoMediaEncryptionKeyInfo()
public interface getCiscoMediaEncryptionKeyInfo()Returns CiscoMediaEncryptionKeyInfo only if Provider is opened with TLS link and SRTP enabled option is set for the application in the Cisco Unified Communications Manager User Admin pages. Otherwise, it will return null.
getCiscoMediaSecurityIndicator()
public int getCiscoMediaSecurityIndicator()Returns one of the following constants from CiscoMediaSecurityIndicator:
MEDIA_ENCRYPTED_KEYS_AVAILABLE
MEDIA_ENCRYPT_USER_NOT_AUTHORIZED
MEDIA_ENCRYPTED_KEYS_UNAVAILABLE
MEDIA_NOT_ENCRYPTED
getCallID()
CiscoCallID getCallID()Returns CiscoCallID object if there is already CiscoCall present when this event is sent. If there is no CiscoCall present, then this method will return null.
getCiscoRTPHandle()
CiscoRTPHandle getCiscoRTPHandle()Returns CiscoRTPHandle object. Applications can get call reference using CiscoProvider.getCall( CiscoRTPHandle ).If there is no callobserver or if there was no callobserver when this event is delivered, then CiscoProvider.getCall( CiscoRTPHandle ) may return null.
CiscoRTPInputProperties
Declaration
public interface CiscoRTPInputPropertiesDescription
Methods
getBitRate()
public int getBitRate()Returns the media bit rate, one of the following constants:
· CiscoRTPBitRate.R5_3· CiscoRTPBitRate.R6_4Returns:
payload type
getEchoCancellation()
public boolean getEchoCancellation()Returns:
echo cancellation
getLocalAddress()
public java.net.InetAddress getLocalAddress()Returns:
address to which media will be directed
getLocalPort()
public int getLocalPort()Returns:
port to which media will be directed
getPacketSize()
public int getPacketSize()Returns:
packet size, in milliseconds
getPayloadType()
public int getPayloadType()Returns the payload format, one of the following constants:
· CiscoRTPPayload.NONSTANDARD· CiscoRTPPayload.G711ALAW64K· CiscoRTPPayload.G711ALAW56K· CiscoRTPPayload.G711ULAW64K· CiscoRTPPayload.G711ULAW56K· CiscoRTPPayload.G722_64K· CiscoRTPPayload.G722_56K· CiscoRTPPayload.G722_48K· CiscoRTPPayload.G7231· CiscoRTPPayload.G728· CiscoRTPPayload.G729· CiscoRTPPayload.G729ANNEXA· CiscoRTPPayload.IS11172AUDIOCAP· CiscoRTPPayload.IS13818AUDIOCAP· CiscoRTPPayload.ACY_G729AASSN· CiscoRTPPayload.DATA64· CiscoRTPPayload.DATA56· CiscoRTPPayload.GSM· CiscoRTPPayload.ACTIVEVOICECiscoRTPInputStartedEv
Declaration
public interface CiscoRTPInputStartedEv extends CiscoEvAll Superinterfaces
CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEv
Description
Fields
ID
public static final int IDMethods
getCallID()
public com.cisco.jtapi.extensions.CiscoCallID getCallID()Returns CiscoCallID.
getRTPInputProperties()
public com.cisco.jtapi.extensions.CiscoRTPInputProperties getRTPInputProperties()Returns RTP input properties.
getCiscoRTPHandle()
CiscoRTPHandle getCiscoRTHandle()Returns CiscoRTPHandle object. Applications can get call reference using CiscoProvider.getCall(CiscoRTPHandle). If there is no callobserver or if there was no callobserver when this event was delivered, then CiscoProvider.getCall(CiscoRTPHandle) may return null.
getMediaConnectionMode()
public int getMediaConnectionMode()Returns CiscoMediaConnectionMode. Application could get following values for mediaMode:
•
•
In general, you should never get an event with mode NONE; however, if that happens Applications should ignore the event and log an error.
CiscoRTPInputStoppedEv
Declaration
public interface CiscoRTPInputStoppedEv extends CiscoTermEvAll Superinterfaces
CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEv
Description
Fields
ID
public static final int IDMethods
getCallID()
public com.cisco.jtapi.extensions.CiscoCallID getCallID()returns CiscoCallID
getCiscoRTPHandle()
CiscoRTPHandle getCiscoRTHandle()Returns CiscoRTPHandle object. Applications can get call reference using CiscoProvider.getCall(CiscoRTPHandle). If there is no callobserver or if there was no callobserver when this event was delivered, then CiscoProvider.getCall(CiscoRTPHandle) may return null.
getMediaConnectionMode()
public int getMediaConnectionMode()Returns CiscoMediaConnectionMode. Applications could get following values for mediaMode:
•
•
In general, you should never get an event with mode NONE; however, if that happens Applications should ignore the event and log an error.
CiscoRTPOutputKeyEv
Declaration
public interface CiscoRTPOutputKeyEvDescription
Methods
getCiscoMediaEncryptionKeyInfo()
public interface getCiscoMediaEncryptionKeyInfo()Returns CiscoMediaEncryptionKeyInfo only if Provider is opened with TLS link and SRTP enabled option is set for the application in the Cisco Unified Communications Manager User Admin pages. Otherwise, it will return null.
getCiscoMediaSecurityIndicator()
public int getCiscoMediaSecurityIndicator()Returns one of the following constants from CiscoMediaSecurityIndicator:
MEDIA_ENCRYPTED_KEYS_AVAILABLE
MEDIA_ENCRYPT_USER_NOT_AUTHORIZED
MEDIA_ENCRYPTED_KEYS_UNAVAILABLE
MEDIA_NOT_ENCRYPTED
getCallID()
CiscoCallID getCallID()Returns CiscoCallID object if there is already CiscoCall present when this event is sent. If there is no CiscoCall present, then this method will return null.
getCiscoRTPHandle()
CiscoRTPHandle getCiscoRTPHandle()Returns CiscoRTPHandle object. Applications can get call reference using CiscoProvider.getCall( CiscoRTPHandle ).If there is no callobserver or if there was no callobserver when this event is delivered, then CiscoProvider.getCall( CiscoRTPHandle ) may return null.
CiscoRTPOutputProperties
Declaration
public interface CiscoRTPOutputPropertiesDescription
Methods
getBitRate()
public int getBitRate()Returns the media bit rate, one of the following constants:
· CiscoRTPBitRate.R5_3· CiscoRTPBitRate.R6_4Returns payload type
getMaxFramesPerPacket()
public int getMaxFramesPerPacket()Returns the maximum number of frames to send per packet
getPacketSize()
public int getPacketSize()Returns packet size, in milliseconds
getPayloadType()
public int getPayloadType()Returns the payload format, one of the following constants:
· CiscoRTPPayload.NONSTANDARD· CiscoRTPPayload.G711ALAW64K· CiscoRTPPayload.G711ALAW56K· CiscoRTPPayload.G711ULAW64K· CiscoRTPPayload.G711ULAW56K· CiscoRTPPayload.G722_64K· CiscoRTPPayload.G722_56K· CiscoRTPPayload.G722_48K· CiscoRTPPayload.G7231· CiscoRTPPayload.G728· CiscoRTPPayload.G729· CiscoRTPPayload.G729ANNEXA· CiscoRTPPayload.IS11172AUDIOCAP· CiscoRTPPayload.IS13818AUDIOCAP· CiscoRTPPayload.ACY_G729AASSN· CiscoRTPPayload.DATA64· CiscoRTPPayload.DATA56· CiscoRTPPayload.GSM· CiscoRTPPayload.ACTIVEVOICEReturns payload type
getPrecedenceValue()
public int getPrecedenceValue()Returns precedence value
getRemoteAddress()
public java.net.InetAddress getRemoteAddress()Returns address to which media is to be transmitted
getRemotePort()
public int getRemotePort()Returns port to which media is to be transmitted.
getSilenceSuppression()
public boolean getSilenceSuppression()Returns silence suppression
CiscoRTPOutputStartedEv
Declaration
public interface CiscoRTPOutputStartedEv extends CiscoTermEvAll Superinterfaces
CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEv
Description
