com.avaya.jtapi.tsapi
Interface LucentRouteSession

All Superinterfaces:

ITsapiCallInfo, ITsapiRouteSession, RouteSession

All Known Subinterfaces:

LucentV7RouteSession

public interface LucentRouteSession

extends ITsapiRouteSession

The LucentRouteSession interface extends ITsapiRouteSession with Avaya-specific features. When a Provider is bound to a Avaya switch, this interface may be used to access additional capabilities.

The route session object which implements this interface also implements the LucentCallInfo interface.

Field Summary

Fields inherited from interface javax.telephony.callcenter.RouteSession

CAUSE_INVALID_DESTINATION, CAUSE_NO_ERROR, CAUSE_PARAMETER_NOT_SUPPORTED, CAUSE_ROUTING_TIMER_EXPIRED, CAUSE_STATE_INCOMPATIBLE, CAUSE_UNSPECIFIED_ERROR, ERROR_RESOURCE_BUSY, ERROR_RESOURCE_OUT_OF_SERVICE, ERROR_UNKNOWN, RE_ROUTE, ROUTE, ROUTE_CALLBACK_ENDED, ROUTE_END, ROUTE_USED

Method Summary

void	selectRoute(java.lang.String routeSelected, boolean priorityCall, UserToUserInfo userInfo) Similar to the standard selectRoute(), with the addition of Avaya-specific call parameters.
void	selectRouteAndCollect(java.lang.String routeSelected, int digitsToBeCollected, int timeout, boolean priorityCall, UserToUserInfo userInfo) Routes a call and requests DTMF digit collection.
void	selectRouteDirectAgent(LucentAgent calledAgent, boolean priorityCall, UserToUserInfo userInfo) Routes a direct agent call to a specific logged-in ACD agent.
void	selectRouteWithDigits(java.lang.String routeSelected, java.lang.String digits, boolean priorityCall, UserToUserInfo userInfo) Routes a call and places digits in a dial-ahead digit buffer.

Methods inherited from interface com.avaya.jtapi.tsapi.ITsapiRouteSession

getCall

Methods inherited from interface javax.telephony.callcenter.RouteSession

endRoute, getCause, getRouteAddress, getState, selectRoute

Method Detail

selectRoute

public void selectRoute(java.lang.String routeSelected,
                        boolean priorityCall,
                        UserToUserInfo userInfo)
                 throws TsapiMethodNotSupportedException

Similar to the standard selectRoute(), with the addition of Avaya-specific call parameters.

Parameters:

routeSelected - The selected route for this call. (Note that this is NOT an array.)

priorityCall - If true, attempt to place a priority call

userInfo - Associate caller information, up to 96 bytes (with Avaya CT 1.2 or higher, or the formally named CVCT 3.3 or higher that is connected to a DEFINITY G3V8 or higher; otherwise the limit is 32 bytes), with the call.

Throws:

TsapiMethodNotSupportedException

See Also:

UserToUserInfo

selectRouteDirectAgent

public void selectRouteDirectAgent(LucentAgent calledAgent,
                                   boolean priorityCall,
                                   UserToUserInfo userInfo)
                            throws TsapiMethodNotSupportedException,
                                   TsapiInvalidArgumentException

Routes a direct agent call to a specific logged-in ACD agent.

Parameters:

calledAgent - The ACD agent extension to route to.

priorityCall - If true, attempt to place a priority call

userInfo - Associate caller information, up to 96 bytes (with Avaya CT 1.2 or higher, or the formally named CVCT 3.3 or higher that is connected to a DEFINITY G3V8 or higher; otherwise the limit is 32 bytes), with the call.

Throws:

TsapiMethodNotSupportedException

TsapiInvalidArgumentException

See Also:

UserToUserInfo

selectRouteAndCollect

public void selectRouteAndCollect(java.lang.String routeSelected,
                                  int digitsToBeCollected,
                                  int timeout,
                                  boolean priorityCall,
                                  UserToUserInfo userInfo)
                           throws TsapiMethodNotSupportedException

Routes a call and requests DTMF digit collection.

Parameters:

routeSelected - The selected route for this call. (Note that this is NOT an array.)

digitsToBeCollected - The number of digits to be collected (up to 24).

timeout - The number of seconds to wait (up to 63) before digit collection times out.

priorityCall - If true, attempt to place a priority call

userInfo - Associate caller information, up to 96 bytes (with Avaya CT 1.2 or higher, or the formally named CVCT 3.3 or higher that is connected to a DEFINITY G3V8 or higher; otherwise the limit is 32 bytes), with the call.

Throws:

TsapiMethodNotSupportedException

See Also:

UserToUserInfo

selectRouteWithDigits

public void selectRouteWithDigits(java.lang.String routeSelected,
                                  java.lang.String digits,
                                  boolean priorityCall,
                                  UserToUserInfo userInfo)
                           throws TsapiMethodNotSupportedException

Routes a call and places digits in a dial-ahead digit buffer.

Parameters:

routeSelected - The selected route for this call. (Note that this is NOT an array.)

digits - A string of up to 24 characters (0-9, *, and # only) to place in the dial-ahead digit buffer.

priorityCall - If true, attempt to place a priority call

userInfo - Associate caller information, up to 96 bytes (with Avaya CT 1.2 or higher, or the formally named CVCT 3.3 or higher that is connected to a DEFINITY G3V8 or higher; otherwise the limit is 32 bytes), with the call.

Throws:

TsapiMethodNotSupportedException

See Also:

UserToUserInfo