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.JTapiAnswerCallOptions, JTapi.JTapiAnswerCallResult, JTapi.JTapiBlindTransferOptions, JTapi.JTapiBlindTransferResult, JTapi.JTapiCallActiveOptions, JTapi.JTapiCallEstablishedOptions, JTapi.JTapiCallInactiveOptions, JTapi.JTapiCallInitiatedOptions, JTapi.JTapiConferenceOptions, JTapi.JTapiConferenceResult, 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.JTapiNonTriggeringSubscribeOptions, JTapi.JTapiNonTriggeringSubscribeResult, JTapi.JTapiRedirectOptions, JTapi.JTapiRedirectResult, JTapi.JTapiRejectCallOptions, JTapi.JTapiRejectCallResult, JTapi.JTapiResumeOptions, JTapi.JTapiResumeResult, JTapi.JTapiSendXSIDataOptions, JTapi.JTapiSendXSIDataResult, JTapi.JTapiStartMonitoringOptions, JTapi.JTapiStartMonitoringResult, JTapi.JTapiUnsubscribeOptions, JTapi.JTapiUnsubscribeResult, JTapi.PlayToneDirection

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

CuaeCommon.CuaeResult

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

CuaeCommon.CuaeResult

Method Summary

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	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.

Method Detail

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

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