com.avaya.jtapi.tsapi
Interface LucentCall

All Superinterfaces:
Call, CallCenterCall, CallControlCall, ITsapiCall, ITsapiCallInfo, LucentCallInfo
All Known Subinterfaces:
LucentCallEx, LucentV5Call, LucentV7Call

public interface LucentCall
extends ITsapiCall, LucentCallInfo

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

Direct-agent calling may be used by an application to place a call to a specific logged-in ACD agent. Supervisor-assist calling may be used by an application to place a call from a logged-in ACD agent to a supervisor. These features are also available on consultation calls. These types of calls may be tracked separately by ACD measurement software in the PBX.

User-to-user information is an ISDN feature which allows end-to-end transmission of application data during call setup/teardown. This information may be a customer number, credit card number, alphanumeric digits, or a binary string. It is propagated with the call whether the call is made to a destination on the local switch or to a destination on a remote switch over PRI trunks. The switch sends the UUI in the ISDN SETUP message over the PRI trunk to establish the call. The local and the remote switch include the UUI in the alerting, connected, disconnected and route request events.

See Also:
UserToUserInfo

Field Summary
 
Fields inherited from interface javax.telephony.Call
ACTIVE, IDLE, INVALID
 
Fields inherited from interface javax.telephony.callcenter.CallCenterCall
ANSWERING_TREATMENT_CONNECT, ANSWERING_TREATMENT_DROP, ANSWERING_TREATMENT_NONE, ANSWERING_TREATMENT_PROVIDER_DEFAULT, ENDPOINT_ANSWERING_MACHINE, ENDPOINT_ANY, ENDPOINT_FAX_MACHINE, ENDPOINT_HUMAN_INTERVENTION, MAX_RINGS, MIN_RINGS
 
Fields inherited from interface com.avaya.jtapi.tsapi.LucentCallInfo
AR_ANSWER_MACHINE_DETECTED, AR_ANSWER_NORMAL, AR_ANSWER_TIMED, AR_ANSWER_VOICE_ENERGY, AR_IN_QUEUE, AR_NONE, AR_SIT_INEFFECTIVE_OTHER, AR_SIT_INTERCEPT, AR_SIT_NO_CIRCUIT, AR_SIT_REORDER, AR_SIT_UNKNOWN, AR_SIT_VACANT_CODE
 
Method Summary
 Connection[] connect(LucentTerminal origterm, LucentAddress origaddr, java.lang.String dialedDigits, boolean priorityCall, UserToUserInfo userInfo)
          Similar to the standard connect(), with the addition of Avaya-specific call parameters.
 Connection[] connectDirectAgent(LucentTerminal origterm, LucentAddress origaddr, LucentAgent calledAgent, boolean priorityCall, UserToUserInfo userInfo)
          Places a direct call to a specific logged-in ACD agent.
 Connection[] connectPredictive(LucentTerminal originatorTerminal, LucentAddress origAddress, java.lang.String dialedDigits, int connectionState, int maxRings, int answeringTreatment, int answeringEndpointType, boolean priorityCall, UserToUserInfo userInfo)
          Similar to the standard connectPredictive(), with the addition of Avaya-specific call parameters.
 Connection[] connectSupervisorAssist(LucentAgent callingAgent, java.lang.String dialedDigits, UserToUserInfo userInfo)
          Places a call from a logged-in ACD agent to a supervisor's extension.
 Connection[] consult(LucentTerminalConnection termconn, java.lang.String address, boolean priorityCall, UserToUserInfo userInfo)
          Similar to the standard consult(), with the addition of Avaya-specific call parameters.
 Connection[] consultDirectAgent(LucentTerminalConnection termconn, LucentAgent calledAgent, boolean priorityCall, UserToUserInfo userInfo)
          Places a consultation call with a specific logged-in ACD agent.
 Connection[] consultSupervisorAssist(LucentTerminalConnection termconn, ACDAddress split, java.lang.String address, UserToUserInfo userInfo)
          Places a consultation call from a logged-in ACD agent to a supervisor's extension.
 
Methods inherited from interface javax.telephony.Call
addCallListener, addObserver, connect, getCallCapabilities, getCallListeners, getCapabilities, getConnections, getObservers, getProvider, getState, removeCallListener, removeObserver
 
Methods inherited from interface javax.telephony.callcontrol.CallControlCall
addParty, conference, consult, consult, drop, getCalledAddress, getCallingAddress, getCallingTerminal, getConferenceController, getConferenceEnable, getLastRedirectedAddress, getTransferController, getTransferEnable, offHook, setConferenceController, setConferenceEnable, setTransferController, setTransferEnable, transfer, transfer
 
Methods inherited from interface javax.telephony.callcenter.CallCenterCall
connectPredictive, getApplicationData, getTrunks, setApplicationData
 
Methods inherited from interface com.avaya.jtapi.tsapi.LucentCallInfo
getDeliveringACDAddress, getDistributingAddress, getLookaheadInfo, getOriginalCallInfo, getReason, getTrunk, getUserEnteredCode, getUserToUserInfo
 

Method Detail

connect

public Connection[] connect(LucentTerminal origterm,
                            LucentAddress origaddr,
                            java.lang.String dialedDigits,
                            boolean priorityCall,
                            UserToUserInfo userInfo)
                     throws TsapiResourceUnavailableException,
                            TsapiPrivilegeViolationException,
                            TsapiInvalidPartyException,
                            TsapiInvalidArgumentException,
                            TsapiInvalidStateException,
                            TsapiMethodNotSupportedException
Similar to the standard connect(), with the addition of Avaya-specific call parameters.

Parameters:
origterm - The originating Terminal for this telephone call.
origaddr - The originating Address for this telephone call.
dialedDigits - The dialable destination string for this telephone call.
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:
TsapiResourceUnavailableException
TsapiPrivilegeViolationException
TsapiInvalidPartyException
TsapiInvalidArgumentException
TsapiInvalidStateException
TsapiMethodNotSupportedException
See Also:
UserToUserInfo

connectDirectAgent

public Connection[] connectDirectAgent(LucentTerminal origterm,
                                       LucentAddress origaddr,
                                       LucentAgent calledAgent,
                                       boolean priorityCall,
                                       UserToUserInfo userInfo)
                                throws TsapiResourceUnavailableException,
                                       TsapiPrivilegeViolationException,
                                       TsapiInvalidPartyException,
                                       TsapiInvalidArgumentException,
                                       TsapiInvalidStateException,
                                       TsapiMethodNotSupportedException
Places a direct call to a specific logged-in ACD agent.

Parameters:
origterm - The originating Terminal for this telephone call.
origaddr - The originating Address for this telephone call.
calledAgent - The ACD agent extension to be called.
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:
TsapiResourceUnavailableException
TsapiPrivilegeViolationException
TsapiInvalidPartyException
TsapiInvalidArgumentException
TsapiInvalidStateException
TsapiMethodNotSupportedException
See Also:
UserToUserInfo

connectSupervisorAssist

public Connection[] connectSupervisorAssist(LucentAgent callingAgent,
                                            java.lang.String dialedDigits,
                                            UserToUserInfo userInfo)
                                     throws TsapiResourceUnavailableException,
                                            TsapiPrivilegeViolationException,
                                            TsapiInvalidPartyException,
                                            TsapiInvalidArgumentException,
                                            TsapiInvalidStateException,
                                            TsapiMethodNotSupportedException
Places a call from a logged-in ACD agent to a supervisor's extension.

Parameters:
callingAgent - The ACD agent extension from which to originate the call.
dialedDigits - The supervisor's extension.
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:
TsapiResourceUnavailableException
TsapiPrivilegeViolationException
TsapiInvalidPartyException
TsapiInvalidArgumentException
TsapiInvalidStateException
TsapiMethodNotSupportedException
See Also:
UserToUserInfo

connectPredictive

public Connection[] connectPredictive(LucentTerminal originatorTerminal,
                                      LucentAddress origAddress,
                                      java.lang.String dialedDigits,
                                      int connectionState,
                                      int maxRings,
                                      int answeringTreatment,
                                      int answeringEndpointType,
                                      boolean priorityCall,
                                      UserToUserInfo userInfo)
                               throws TsapiResourceUnavailableException,
                                      TsapiPrivilegeViolationException,
                                      TsapiInvalidPartyException,
                                      TsapiInvalidArgumentException,
                                      TsapiInvalidStateException,
                                      TsapiMethodNotSupportedException
Similar to the standard connectPredictive(), with the addition of Avaya-specific call parameters.

Parameters:
originatorTerminal - The originating Terminal of the telephone call. This is optional when the originator is for example an ACDAddress.
origAddress - The originating Address of the telephone call.
dialedDigits - This must be a complete and valid telephone number.
connectionState - The application may set this to CONNECTED ALERTING, NETWORK_REACHED or NETWORK_ALERTING.
maxRings - This specifies the the number of rings that are allowed before classifying the call as no answer. The allowed range is from MIN_RINGS of 2 to MAX_RINGS of 15.
answeringTreatment - This specifies the call treatment when an answering endpoint is detected. The set includes ANSWERING_TREATMENT_PROVIDER_DEFAULT, ANSWERING_TREATMENT_DROP, ANSWERING_TREATMENT_CONNECT and ANSWERING_TREATMENT_NONE.
answeringEndpointType - This specifies the type of answering endpoint. The set includes ENDPOINT_ANSWERING_MACHINE, ENDPOINT_FAX_MACHINE, ENDPOINT_HUMAN_INTERVENTION, ENDPOINT_ANY.
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:
TsapiResourceUnavailableException
TsapiPrivilegeViolationException
TsapiInvalidPartyException
TsapiInvalidArgumentException
TsapiInvalidStateException
TsapiMethodNotSupportedException
See Also:
UserToUserInfo

consult

public Connection[] consult(LucentTerminalConnection termconn,
                            java.lang.String address,
                            boolean priorityCall,
                            UserToUserInfo userInfo)
                     throws TsapiInvalidStateException,
                            TsapiInvalidArgumentException,
                            TsapiMethodNotSupportedException,
                            TsapiResourceUnavailableException,
                            TsapiPrivilegeViolationException
Similar to the standard consult(), with the addition of Avaya-specific call parameters.

Parameters:
termconn - The controlling TerminalConnection for the consultation call.
address - The dialable destination string for this telephone call.
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:
TsapiInvalidStateException
TsapiInvalidArgumentException
TsapiMethodNotSupportedException
TsapiResourceUnavailableException
TsapiPrivilegeViolationException
See Also:
UserToUserInfo

consultDirectAgent

public Connection[] consultDirectAgent(LucentTerminalConnection termconn,
                                       LucentAgent calledAgent,
                                       boolean priorityCall,
                                       UserToUserInfo userInfo)
                                throws TsapiInvalidStateException,
                                       TsapiInvalidArgumentException,
                                       TsapiMethodNotSupportedException,
                                       TsapiResourceUnavailableException,
                                       TsapiPrivilegeViolationException
Places a consultation call with a specific logged-in ACD agent.

Parameters:
termconn - The controlling TerminalConnection for the consultation call.
calledAgent - The ACD agent extension to be called.
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:
TsapiInvalidStateException
TsapiInvalidArgumentException
TsapiMethodNotSupportedException
TsapiResourceUnavailableException
TsapiPrivilegeViolationException
See Also:
UserToUserInfo

consultSupervisorAssist

public Connection[] consultSupervisorAssist(LucentTerminalConnection termconn,
                                            ACDAddress split,
                                            java.lang.String address,
                                            UserToUserInfo userInfo)
                                     throws TsapiInvalidStateException,
                                            TsapiInvalidArgumentException,
                                            TsapiMethodNotSupportedException,
                                            TsapiResourceUnavailableException,
                                            TsapiPrivilegeViolationException
Places a consultation call from a logged-in ACD agent to a supervisor's extension.

Parameters:
termconn - The controlling TerminalConnection for the consultation call.
split - The split which the originating ACD agent is logged into.
address - The supervisor's extension.
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:
TsapiInvalidStateException
TsapiInvalidArgumentException
TsapiMethodNotSupportedException
TsapiResourceUnavailableException
TsapiPrivilegeViolationException
See Also:
UserToUserInfo


Copyright © 2005 Avaya All Rights Reserved.