cisco.uc.cuae.legacy
Interface JTapiClient

All Superinterfaces:

CuaeCommon, CuaeCommonClient, JTapi

All Known Implementing Classes:

BaseJTapiClient, RemoteJTapiClient

public interface JTapiClient
extends JTapi, CuaeCommonClient

The JTAPI Provider provides 3rd-party monitoring of changes in device state, as well as control over devices. Common uses are real-time notification of a phone making or receiving a call, causing a phone to automatically answer or make a call, and transferring calls automatically on behalf of the user. Generated from CUAE provider package Metreos.Providers.JTapi

Nested Class Summary

Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.JTapi

JTapi.DeviceType, JTapi.JTapiAddressAddedToTerminalOptions, JTapi.JTapiAddressInServiceOptions, JTapi.JTapiAddressOutServiceOptions, JTapi.JTapiAddressRemovedFromTerminalOptions, JTapi.JTapiAnswerCallOptions, JTapi.JTapiAnswerCallResult, JTapi.JTapiBlindTransferOptions, JTapi.JTapiBlindTransferResult, JTapi.JTapiCallActiveOptions, JTapi.JTapiCallEstablishedOptions, JTapi.JTapiCallInactiveOptions, JTapi.JTapiCallInitiatedOptions, JTapi.JTapiCallParkedOptions, JTapi.JTapiCallUnParkedOptions, JTapi.JTapiConferenceOptions, JTapi.JTapiConferenceResult, JTapi.JTapiDirectTransferOptions, JTapi.JTapiDirectTransferResult, JTapi.JTapiGetActiveCallsOptions, JTapi.JTapiGetActiveCallsResult, JTapi.JTapiGetAddressesOnTerminalOptions, JTapi.JTapiGetAddressesOnTerminalResult, JTapi.JTapiGetCallForwardStatusOptions, JTapi.JTapiGetCallForwardStatusResult, JTapi.JTapiGetDeviceStatusOptions, JTapi.JTapiGetDeviceStatusResult, JTapi.JTapiGotDigitsOptions, JTapi.JTapiHangupCallOptions, JTapi.JTapiHangupOptions, JTapi.JTapiHangupResult, JTapi.JTapiHoldOptions, JTapi.JTapiHoldResult, JTapi.JTapiIncomingCallOptions, JTapi.JTapiMakeCallOptions, JTapi.JTapiMakeCallResult, JTapi.JTapiNonTriggeringCallEstablishedOptions, JTapi.JTapiNonTriggeringSubscribeOptions, JTapi.JTapiNonTriggeringSubscribeResult, JTapi.JTapiParkCallOptions, JTapi.JTapiParkCallResult, JTapi.JTapiRedirectOptions, JTapi.JTapiRedirectResult, JTapi.JTapiRejectCallOptions, JTapi.JTapiRejectCallResult, JTapi.JTapiResumeOptions, JTapi.JTapiResumeResult, JTapi.JTapiSendXSIDataOptions, JTapi.JTapiSendXSIDataResult, JTapi.JTapiStartMonitoringOptions, JTapi.JTapiStartMonitoringResult, JTapi.JTapiTerminalInServiceOptions, JTapi.JTapiTerminalOutServiceOptions, JTapi.JTapiUnsubscribeOptions, JTapi.JTapiUnsubscribeResult, JTapi.PlayToneDirection

Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.CuaeCommon

CuaeCommon.CuaeResult

Method Summary

void	jTapiAddressAddedToTerminal(java.lang.String sessionId, JTapi.JTapiAddressAddedToTerminalOptions options) JTapiAddressAddedToTerminal indicates that an address was successfully added to a terminal.
void	jTapiAddressInService(java.lang.String sessionId, JTapi.JTapiAddressInServiceOptions options) JTapiAddressInService indicates that the state of the address on the device became In Service.
void	jTapiAddressOutService(java.lang.String sessionId, JTapi.JTapiAddressOutServiceOptions options) JTapiAddressOutService indicates that the state of the address on the device became Out of Service.
void	jTapiAddressRemovedFromTerminal(java.lang.String sessionId, JTapi.JTapiAddressRemovedFromTerminalOptions options) JTapiAddressRemovedFromTerminal indicates that an address was successfully removed from a terminal.
void	jTapiCallActive(java.lang.String sessionId, JTapi.JTapiCallActiveOptions options) JTapiCallActive indicates that the media of a call has become active.
void	jTapiCallEstablished(java.lang.String sessionId, JTapi.JTapiCallEstablishedOptions options) JTapiCallEstablished indicates that a line on a monitored device has placed a call.
void	jTapiCallInactive(java.lang.String sessionId, JTapi.JTapiCallInactiveOptions options) JTapiCallInactive indicates that the media of a call has gone inactive.
void	jTapiCallInitiated(java.lang.String sessionId, JTapi.JTapiCallInitiatedOptions options) JTapiCallInitiated indicates that a line on a monitored device has gone off-hook.
void	jTapiCallParked(java.lang.String sessionId, JTapi.JTapiCallParkedOptions options) JTapiCallParked indicates that a call on a monitored phone has been parked.
void	jTapiCallUnParked(java.lang.String sessionId, JTapi.JTapiCallUnParkedOptions options) JTapiCallUnParked indicates that a call on a monitored phone has been Unparked.
void	jTapiGotDigits(java.lang.String sessionId, JTapi.JTapiGotDigitsOptions options) JTapiGotDigits indicates that a digit has been pressed on a monitored device during a call.
void	jTapiHangupCall(java.lang.String sessionId, JTapi.JTapiHangupCallOptions options) JTapiHangupCall indicates that a call on a monitored device has ended.
void	jTapiIncomingCall(java.lang.String sessionId, JTapi.JTapiIncomingCallOptions options) JTapiIncomingCall indicates that a call has been routed to a line on a monitored device and is currently ringing and unanswered.
void	jTapiNonTriggeringCallEstablished(java.lang.String sessionId, JTapi.JTapiNonTriggeringCallEstablishedOptions options) JTapiNonTriggeringCallEstablished indicates that a line on a monitored device has placed a call.
void	jTapiTerminalInService(java.lang.String sessionId, JTapi.JTapiTerminalInServiceOptions options) JTapiTerminalInService indicates that the terminal was successfully registered and is IN-SERVICE.
void	jTapiTerminalOutService(java.lang.String sessionId, JTapi.JTapiTerminalOutServiceOptions options) JTapiTerminalOutService indicates that the terminal was successfully unregistered and is OUT-SERVICE.

Method Detail

jTapiTerminalInService

void jTapiTerminalInService(java.lang.String sessionId,
                            JTapi.JTapiTerminalInServiceOptions options)

JTapiTerminalInService indicates that the terminal was successfully registered and is IN-SERVICE. None. When a JTapiTerminalInService event occurs, the apps can start call control and other non control actions that require the device to be in registered State. For example, to send data to the device, the device has to be in registered state. So when a JTapiTerminalInService event occurs, the app can initiate a JTapiSendXSIData. The JTapiNonTriggeringSubscribe is a app initiated action to register a device and the success of the action only indicates that a request has been send successfully. It is not a confirmation that a device has finished the registration process which is a asynchronous action. Hence it is not advisable to call other actions back to back following JTapiNonTriggeringSubscribe that require the device to in registered state. Instead the use has to wait for the JTapiTerminalInService event before invoking any new actions that require the device to be registered.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiTerminalOutService

void jTapiTerminalOutService(java.lang.String sessionId,
                             JTapi.JTapiTerminalOutServiceOptions options)

JTapiTerminalOutService indicates that the terminal was successfully unregistered and is OUT-SERVICE. None. When a JTapiTerminalOutService event occurs, the apps must not send any call control and other non control actions that require the device to be in registered State. None

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiIncomingCall

void jTapiIncomingCall(java.lang.String sessionId,
                       JTapi.JTapiIncomingCallOptions options)

JTapiIncomingCall indicates that a call has been routed to a line on a monitored device and is currently ringing and unanswered. None. When a call is inbound to an script via JTapiIncomingCall, the call is in a ringing state and a script can choose to do one of 4 things: JTapiRejectCall, JTapiAnswerCall, JTapiRedirect, or simply do nothing with the call. The JTapiHangup event can occur after JTapiIncomingCall, even if the call has not been answered. In this case, just as when the call has been answered and is established, it indicates that the remote endpoint has terminated the call, and the call is over.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiCallInitiated

void jTapiCallInitiated(java.lang.String sessionId,
                        JTapi.JTapiCallInitiatedOptions options)

JTapiCallInitiated indicates that a line on a monitored device has gone off-hook. The term 'CallInitiated' is a very strict interpretation of a JTAPI call; when a phone is taken off-hook, a new call is created within Cisco Unified Communications Manager, although there is not yet a remote number dialed by the phone device. Therefore, there is no To parameter associated with this event. A phone going off-hook does not correlate to a phone call. If building an application that is concerned foremost with knowing a phone has made a call, then consider using the JTapiCallEstablished event instead for the basis of your script trigger. Subsequent events indicate important state changes of the call. JTapiCallActive indicates that the call has been answered by the remote party. JTapiHangup indicates that call has been gone on-hook if JTapiCallActive has not yet occurred.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiCallEstablished

void jTapiCallEstablished(java.lang.String sessionId,
                          JTapi.JTapiCallEstablishedOptions options)

JTapiCallEstablished indicates that a line on a monitored device has placed a call. None. JTapiCallEstablished indicates that a phone has made a call. At this state, the phone is currently ringing and the remote party has not answered the call. Subsequent events indicate important state changes of the call. JTapiCallActive indicates that the call has been answered by the remote party. JTapiHangup indicates that call has been aborted if JTapiCallActive has not yet occurred.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiNonTriggeringCallEstablished

void jTapiNonTriggeringCallEstablished(java.lang.String sessionId,
                                       JTapi.JTapiNonTriggeringCallEstablishedOptions options)

JTapiNonTriggeringCallEstablished indicates that a line on a monitored device has placed a call. None. JTapiNonTriggeringCallEstablished indicates that a phone has made a call. At this state, the phone is currently ringing and the remote party has not answered the call. Subsequent events indicate important state changes of the call. JTapiCallActive indicates that the call has been answered by the remote party. JTapiHangup indicates that call has been aborted if JTapiCallActive has not yet occurred.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiCallActive

void jTapiCallActive(java.lang.String sessionId,
                     JTapi.JTapiCallActiveOptions options)

JTapiCallActive indicates that the media of a call has become active. None. JTapiCallActive indicates that a call has become active. In practice this can mean, among other scenarios, that a ringing call has been answered by the called party, or that a call has come out of hold. Knowing that a call is active is important for applications that need to know that the phone is streaming audio. However, if building an application in which this is important, you should be sure to also incorporate the JTapiCallInactive into your script so that you can take the correct action to coincide with the audio streams stopping.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiCallInactive

void jTapiCallInactive(java.lang.String sessionId,
                       JTapi.JTapiCallInactiveOptions options)

JTapiCallInactive indicates that the media of a call has gone inactive. None. JTapiCallInactive indicates that a call has gone inactive. In practice this can mean that a previously active call has gone on hold, and that audio is no longer flowing.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiHangupCall

void jTapiHangupCall(java.lang.String sessionId,
                     JTapi.JTapiHangupCallOptions options)

JTapiHangupCall indicates that a call on a monitored device has ended. This is used by the Etch applications and will not appear in the list of events in the designer. The legacy applications will continue to get the JTapiHangup event. None. JTapiHangupCall can be caused at various stages of a call. For instance, if the only event to have occured is JTapiCallInitiated in your script, then the line has gone on-hook. If the only event to have occurred is JTapiCallEstablished in your script, then the ringing call has been aborted. Finally, if the call has previously become active (indicated by JTapiCallActive), then one of the two parties in the call has hung up and the call is over.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiGotDigits

void jTapiGotDigits(java.lang.String sessionId,
                    JTapi.JTapiGotDigitsOptions options)

JTapiGotDigits indicates that a digit has been pressed on a monitored device during a call. None. None.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiCallParked

void jTapiCallParked(java.lang.String sessionId,
                     JTapi.JTapiCallParkedOptions options)

JTapiCallParked indicates that a call on a monitored phone has been parked. JTapiCallParked can be used to trigger applications. JTapiCallParked indicates that a call on monitored phone has been parked.The call which was parked is indicated by the CallID parameter.The call could have been parked either programmatically by the invokation of api or manually on the phone. The number on which the call got parked is indicated by the ParkDN parameter. Other parameters like who parked the call ,the ParkingParty and which party got parked ,the ParkedParty are also passed as parameters in the event. JTapiCallParkedevent is always followed by a JTapiHangup event. This is because as soon, as soon as a 'PARKING' operation is done on a device, the device gets dropped from the call. Any parked call can be unparked using and passing the parkDN as the To parameter.A call when unparked results in a event. In case a call in not unparked till the 'Call Park Reversion Timer ' on Cisco Communications Manager expires, a event is sent to the ParkingDN.This indicates , that the call can no longer be unparked on the parkDN.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiCallUnParked

void jTapiCallUnParked(java.lang.String sessionId,
                       JTapi.JTapiCallUnParkedOptions options)

JTapiCallUnParked indicates that a call on a monitored phone has been Unparked. JTapiCallUnParked can be used to trigger applications. JTapiCallUnParked indicates that a call which was parked on parkDN has been unparked by the line UnparkingDN on the monitored phoneUnparkingDevice. In case the call is unparked on a non-monitored phone, the event is still sent , but with UnKnOwN values for UnparkingDN , UnparkingDevice and a null CallID. The event is still significant as it informs the application that the call has been unparked and the application should no longer try to unpark it.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiAddressAddedToTerminal

void jTapiAddressAddedToTerminal(java.lang.String sessionId,
                                 JTapi.JTapiAddressAddedToTerminalOptions options)

JTapiAddressAddedToTerminal indicates that an address was successfully added to a terminal. None. When a JTapiAddressAddedToTerminal event occurs, the applications can use this information to learn about the addresses that are mapped on this device. The application will get one such event for each address that is added. This event can happen at any time and hence this is a triggering event. This applications that use this event must also make use of JTapiAddressRemovedFromTerminal event to ensure the correct mapping of the addresses on a device.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiAddressRemovedFromTerminal

void jTapiAddressRemovedFromTerminal(java.lang.String sessionId,
                                     JTapi.JTapiAddressRemovedFromTerminalOptions options)

JTapiAddressRemovedFromTerminal indicates that an address was successfully removed from a terminal. None. When a JTapiAddressRemovedFromTerminal event occurs, the applications can use this information to learn about the addresses that are unmapped from this device. The application will get one such event for each address that is removed. This event can happen at any time and hence this is a triggering event. This applications that use this event must also make use of JTapiAddressAddedToTerminal event to ensure the correct mapping of the addresses on a device.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiAddressInService

void jTapiAddressInService(java.lang.String sessionId,
                           JTapi.JTapiAddressInServiceOptions options)

JTapiAddressInService indicates that the state of the address on the device became In Service. None. When a JTapiAddressInService event occurs, the applications can use this information to learn about the state of the address that is mapped on this device. The application will get one such event for each address that changes state. This event can happen at any time and hence this is a triggering event. This applications that use this event must also make use of JTapiAddressOutService event to ensure the correct state of the address on a device.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

jTapiAddressOutService

void jTapiAddressOutService(java.lang.String sessionId,
                            JTapi.JTapiAddressOutServiceOptions options)

JTapiAddressOutService indicates that the state of the address on the device became Out of Service. None. When a JTapiAddressOutService event occurs, the applications can use this information to learn about the state of the address that is unmapped on this device. The application will get one such event for each address that is removed. This event can happen at any time and hence this is a triggering event. This applications that use this event must also make use of JTapiAddressOutService event to ensure the correct state of the address on a device.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters