cisco.uc.cuae.legacy
Interface CallControlClient

All Superinterfaces:

CallControl, CuaeCommon, CuaeCommonClient

All Known Implementing Classes:

BaseCallControlClient, RemoteCallControlClient

public interface CallControlClient
extends CallControl, CuaeCommonClient

The Call Control API defines an easy-to-use interface for 1st-party Call Control. With this interface, an application can make, receive, transfer, hangup, and perform other operations on calls using 4 telephony protocols: SIP, H.323, CTI, or SCCP. However, from the perspective of the developer using the API, the protocol used is irrelevant and hidden from the developer. The protocol actually used is decided how the Application Server is deployed; not how the application is written. Generated from CUAE provider package Metreos.CallControl

Nested Class Summary

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

CallControl.AcceptCallEarlyMediaOptions, CallControl.AcceptCallEarlyMediaResult, CallControl.AcceptCallOptions, CallControl.AcceptCallResult, CallControl.AnswerCallOptions, CallControl.AnswerCallResult, CallControl.BargeOptions, CallControl.BargeResult, CallControl.BlindTransferOptions, CallControl.BlindTransferResult, CallControl.BridgeCallsOptions, CallControl.BridgeCallsResult, CallControl.CallChangedOptions, CallControl.GetRemoteMediaOptions, CallControl.GetRemoteMediaResult, CallControl.GotDigitsOptions, CallControl.HangupOptions, CallControl.HangupResult, CallControl.IncomingCallOptions, CallControl.MakeCallOptions, CallControl.MakeCallResult, CallControl.RedirectOptions, CallControl.RedirectResult, CallControl.RejectCallOptions, CallControl.RejectCallResult, CallControl.RemoteHangupOptions, CallControl.SendUserInputOptions, CallControl.SendUserInputResult, CallControl.StartRxOptions, CallControl.StartTxOptions, CallControl.StopTxOptions, CallControl.UnbridgeCallsOptions, CallControl.UnbridgeCallsResult, CallControl.WaitForMedia

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

CuaeCommon.CuaeResult

Method Summary

void	callChanged(java.lang.String sessionId, CallControl.CallChangedOptions options) Indicates that the entity of the remote party of a call has changed due to a transfer or conference operation on remote endpoint's end.
void	gotDigits(java.lang.String sessionId, CallControl.GotDigitsOptions options) GotDigits indicates that digit(s) have been received on the call control protocol signaling path, for a a particular CallId The Call Control API makes every effort to abstract the complexities of the underlying telephony protocol; however, one should consult the Call Control Feature Matrix to understand what Call Control actions and action parameters are valid for each of the four supported protocols.
void	incomingCall(java.lang.String sessionId, CallControl.IncomingCallOptions options) IncomingCall indicates that a call has been received by the application server.
void	onMakeCallComplete(java.lang.String sessionId, CallControl.MakeCallResult results, java.lang.Object state)
void	remoteHangup(java.lang.String sessionId, CallControl.RemoteHangupOptions options) RemoteHangup indicates that call has been terminated by the remote endpoint.
void	startRx(java.lang.String sessionId, CallControl.StartRxOptions options) Indicates that the application server has established the receive audio channel and communicated the Rx info to the remote endpoint on the underlying call control protocol.
void	startTx(java.lang.String sessionId, CallControl.StartTxOptions options) Indicates that the transmit audio channel has been established.
void	stopTx(java.lang.String sessionId, CallControl.StopTxOptions options) Indicates that the transmit audio channel has been closed.

Method Detail

onMakeCallComplete

void onMakeCallComplete(java.lang.String sessionId,
                        CallControl.MakeCallResult results,
                        java.lang.Object state)

incomingCall

void incomingCall(java.lang.String sessionId,
                  CallControl.IncomingCallOptions options)

IncomingCall indicates that a call has been received by the application server. The Call Control API makes every effort to abstract the complexities of the underlying telephony protocol; however, one should consult the Call Control Feature Matrix to understand what Call Control actions and action parameters are valid for each of the four supported protocols. One can set installation and deployment guidelines based on the Call Control actions and action parameters that an application uses; the Call Control Feature Matrix makes developing such guidelines feasible. When a call is inbound to an script via IncomingCall, the call is in a ringing state and a script can choose to do one of 5 things: RejectCall, AnswerCall, Redirect, AcceptCall, or simply do nothing with the call. The RemoteHangup event can occur after IncomingCall, 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

remoteHangup

void remoteHangup(java.lang.String sessionId,
                  CallControl.RemoteHangupOptions options)

RemoteHangup indicates that call has been terminated by the remote endpoint. The Call Control API makes every effort to abstract the complexities of the underlying telephony protocol; however, one should consult the Call Control Feature Matrix to understand what Call Control actions and action parameters are valid for each of the four supported protocols. One can set installation and deployment guidelines based on the Call Control actions and action parameters that an application uses; the Call Control Feature Matrix makes developing such guidelines feasible. RemoteHangup is fired when a call is terminated by the remote party for any reason. If the call has been successfully answered with AnswerCall, then the associated ConnectionId is automatically destroyed and is defunct. If however the call is in a peer-to-peer relationship, then the other call leg in this peer-to-peer call is automatically hung up as well. The CallId is defunct if RemoteHangup occurs.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

gotDigits

void gotDigits(java.lang.String sessionId,
               CallControl.GotDigitsOptions options)

GotDigits indicates that digit(s) have been received on the call control protocol signaling path, for a a particular CallId The Call Control API makes every effort to abstract the complexities of the underlying telephony protocol; however, one should consult the Call Control Feature Matrix to understand what Call Control actions and action parameters are valid for each of the four supported protocols. One can set installation and deployment guidelines based on the Call Control actions and action parameters that an application uses; the Call Control Feature Matrix makes developing such guidelines feasible. GotDigits provides no means of pattern matching. The GatherDigits action in the Media Control API provides more powerful operations for developers to determine if a certain pattern or other condition is met by the digits being inputted on the call.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

startTx

void startTx(java.lang.String sessionId,
             CallControl.StartTxOptions options)

Indicates that the transmit audio channel has been established. If this event occurs for a call not currently in a peer-to-peer relationship, then the transmit properties of the call (MediaTxIP, MediaTxPort, MediaTxCodec, MediaTxFramesize) will be automatically associated with the connection. StartTx will still occur for calls currently in a peer-to-peer relationship. However, because there is no media engine connection associated with such calls, the MmsId and ConnectionId event parameters would be empty in that case. The Call Control API makes every effort to abstract the complexities of the underlying telephony protocol; however, one should consult the Call Control Feature Matrix to understand what Call Control actions and action parameters are valid for each of the four supported protocols. One can set installation and deployment guidelines based on the Call Control actions and action parameters that an application uses; the Call Control Feature Matrix makes developing such guidelines feasible. The occurrence of StartTx indicates that the remote endpoint has specified the necessary information for sending an RTP stream to it. StartTx does not occur until either AnswerCall or MakeCall has been used in a script. At least one StartTx event should occur as a result of the successful use of AnswerCall or MakeCall. This event can occur if the call is resumed after being placed on hold by the remote endpoint.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

stopTx

void stopTx(java.lang.String sessionId,
            CallControl.StopTxOptions options)

Indicates that the transmit audio channel has been closed. If this event occurs for a call not currently in a peer-to-peer relationship, then the media engine will stop transmitting audio to the destination with the connection accordingly. StopTx will still occur for calls currently in a peer-to-peer relationship. However, because there is no media engine connection associated with such calls, the MmsId and ConnectionId event parameters would be empty in that case. The Call Control API makes every effort to abstract the complexities of the underlying telephony protocol; however, one should consult the Call Control Feature Matrix to understand what Call Control actions and action parameters are valid for each of the four supported protocols. One can set installation and deployment guidelines based on the Call Control actions and action parameters that an application uses; the Call Control Feature Matrix makes developing such guidelines feasible. The occurrence of StopTx indicates that the remote endpoint has specified to the application server that the transmit RTP audio stream should no longer be sent. StopTx does not occur until either AnswerCall or MakeCall has been used in a script. This event can occur if the call is placed on hold by the remote endpoint, if it is transferring the call elsewhere.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

startRx

void startRx(java.lang.String sessionId,
             CallControl.StartRxOptions options)

Indicates that the application server has established the receive audio channel and communicated the Rx info to the remote endpoint on the underlying call control protocol. StartRx will not occur for calls currently in a peer-to-peer relationship. The Call Control API makes every effort to abstract the complexities of the underlying telephony protocol; however, one should consult the Call Control Feature Matrix to understand what Call Control actions and action parameters are valid for each of the four supported protocols. One can set installation and deployment guidelines based on the Call Control actions and action parameters that an application uses; the Call Control Feature Matrix makes developing such guidelines feasible. The occurrence of StartRx indicates that the application server has specified to the remote endpoint the media negotiation information necessary such that the remote endpoint can send an RTP stream to the application server. StartRx does not occur until either AnswerCall or MakeCall has been used in a script. At least one StartRx event may occur as a result of the successful use of AnswerCall or MakeCall.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

callChanged

void callChanged(java.lang.String sessionId,
                 CallControl.CallChangedOptions options)

Indicates that the entity of the remote party of a call has changed due to a transfer or conference operation on remote endpoint's end. The Call Control API makes every effort to abstract the complexities of the underlying telephony protocol; however, one should consult the Call Control Feature Matrix to understand what Call Control actions and action parameters are valid for each of the four supported protocols. One can set installation and deployment guidelines based on the Call Control actions and action parameters that an application uses; the Call Control Feature Matrix makes developing such guidelines feasible. There is no way to know the whether a transfer or conference causes the CallChanged event.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters