public final class SessionServiceImpl
extends java.lang.Object
implements com.nortel.soa.oi.cct.sessionservice.SessionService
This is a summary service and represents a subset of all the other services exposed and as such can be used in place of them in many cases.
SessionService exposes a higher level API thus making it easier to use. This service also exposes the LoginToCCTServer API,
making it a prerequisite to usage of any of the others
The Open Interfaces API allows one Session object per currently connected client. The Session object represents the client view of the resources managed by the
Communication Control Toolkit server, based on the client’s credentials and the configuration information for the client stored in the
Communication Control Toolkit database. A client uses the Session object/token to get access to the terminals and addresses for which the user has been granted access.
Prerequisites to usage: This represents the minimal data artifacts required to successfully invoke this web service.
Contact
)
Operations: View WSDL
The SessionService, in addition to providing methods for getting the terminals and addresses assigned to the user can be used to initialize the state of the client
application following connection to the server by obtaining a list of currently active contacts associated with all addresses to which the session has access
Constructor and Description |
---|
SessionServiceImpl() |
Modifier and Type | Method and Description |
---|---|
void |
answerContact(SsoToken ssoToken,
Terminal terminal,
Contact contact) |
void |
answerContact(TerminalContactRequest request)
Answer a
Contact
|
void |
callSupervisor(SsoToken ssoToken,
Terminal terminal,
Address address) |
void |
callSupervisor(TerminalAddressRequest parameters)
Call Supervisor
|
void |
completeConference(SsoToken ssoToken,
Terminal terminal,
Contact contact,
Contact consultedContact) |
void |
completeConference(TerminalContactContactRequest request)
Complete a Conference
|
void |
completeSupervisedTransfer(SsoToken ssoToken,
Terminal terminal,
Contact contact,
Contact consultedContact) |
void |
completeSupervisedTransfer(TerminalContactContactRequest request)
Complete a Supervised Transfer
|
ContactResponse |
createContact(CreateContactRequest request)
Create a contact
|
Contact |
createContact(SsoToken ssoToken,
Terminal terminal,
Address origAddress,
Address destAddress) |
void |
dispose(SsoRequest parameters) |
void |
dropContact(SsoToken ssoToken,
Terminal terminal,
Contact contact) |
void |
dropContact(TerminalContactRequest request)
Drop a contact
|
void |
emergencyKey(SsoToken ssoToken,
Terminal terminal,
Contact contact) |
void |
emergencyKey(TerminalContactRequest request)
Emergency Key
|
void |
generateDTMF(GenerateDTMFRequest parameters)
Generate DTMF
|
void |
generateDTMF(SsoToken ssoToken,
Terminal terminal,
Contact contact,
java.lang.String digits) |
AddressResponse |
getAddress(GetAddressRequest parameters)
Get Address
|
AddressResponse |
getAddress(SsoToken ssoToken,
java.lang.String addressName) |
AddressList |
getAddresses(GetAddressesRequest parameters)
Get Addresses
|
AddressList |
getAddresses(SsoToken ssoToken) |
AddressList |
getAgentAddresses(GetAgentAddressesRequest parameters)
Get AgentAddresses
|
AddressList |
getAgentAddresses(SsoToken ssoToken,
Agent agent) |
GetAgentsResponse |
getAgents(SsoRequest parameters) |
GetAgentsResponse |
getAgents(SsoToken ssoToken)
Get Agents
|
TerminalList |
getAgentTerminals(GetAgentTerminalsRequest parameters)
Get AgentTerminals
|
TerminalList |
getAgentTerminals(SsoToken ssoToken,
Agent agent) |
ContactResponse |
getContact(ContactRequest parameters)
Get Contact
|
ContactResponse |
getContact(SsoToken ssoToken,
Contact contact) |
GetContactDataResponse |
getContactData(ContactRequest parameters)
Get the data attached to a given Contact
|
GetContactDataResponse |
getContactData(SsoToken ssoToken,
Contact contact) |
int |
getCurrentAddressCount(SsoRequest parameters)
Get Current Address Count
|
int |
getCurrentAddressCount(SsoToken ssoToken) |
int |
getCurrentTerminalCount(SsoRequest parameters)
Get Current Terminal Count
|
int |
getCurrentTerminalCount(SsoToken ssoToken) |
GetIntrinsicsResponse |
getIntrinsics(ContactRequest parameters) |
boolean |
getReadyState(SsoToken ssoToken,
Terminal terminal) |
GetReadyStateResponse |
getReadyState(TerminalRequest request)
Get the state of the specified Terminal
|
com.nortel.soa.oi.cct.security.SessionManager |
getSessionManager() |
TerminalResponse |
getTerminal(GetTerminalRequest parameters)
Get Terminal
|
TerminalResponse |
getTerminal(SsoToken ssoToken,
java.lang.String termName) |
AddressList |
getTerminalAddresses(GetTerminalAddressesRequest parameters)
Get TerminalAddresses
|
AddressList |
getTerminalAddresses(SsoToken ssoToken,
Terminal terminal) |
TerminalList |
getTerminals(GetTerminalsRequest parameters)
Get Terminals
|
TerminalList |
getTerminals(SsoToken ssoToken) |
GetVersionResponse |
getVersion(GetVersionRequest parameters)
Get Service Version
|
void |
holdContact(SsoToken ssoToken,
Terminal terminal,
Contact contact) |
void |
holdContact(TerminalContactRequest request)
Hold the specified contact located on the specified terminal.
|
Contact |
initiateConference(SsoToken ssoToken,
Terminal terminal,
Contact contact,
Address destAddress) |
ContactResponse |
initiateConference(TerminalContactAddressRequest request)
Initiate a Conference
|
Contact |
initiateSupervisedTransfer(SsoToken ssoToken,
Terminal terminal,
Contact contact,
Address destAddress) |
ContactResponse |
initiateSupervisedTransfer(TerminalContactAddressRequest request)
Initiate a Supervised Transfer
|
void |
loginAgent(LoginAgentRequest request)
Logon an Agent on a specified Agent terminal
|
void |
loginAgent(SsoToken ssoToken,
Terminal terminal,
java.lang.String agentId,
java.lang.String agentPassword) |
void |
loginAgentToState(LoginAgentToStateRequest request)
Logon an Agent on a specified Agent terminal to a specified state
|
void |
loginAgentToState(SsoToken ssoToken,
Terminal terminal,
java.lang.String agentId,
java.lang.String agentPassword,
int initialState) |
void |
loginAgentToTerminal(LoginAgentToTerminalRequest parameters)
Logon an Agent to a specified Agent terminal
|
void |
loginAgentToTerminal(SsoToken ssoToken,
Terminal terminal,
java.lang.String agentId,
java.lang.String password,
java.lang.Integer initialState) |
LogInToCCTServerResponse |
logInToCCTServer(AuthenticationLevel authenticationLevel) |
LogInToCCTServerResponse |
logInToCCTServer(LogInToCCTServerRequest parameters)
Login a Contact Center User
|
void |
logOffFromCCTServer(LogOffFromCCTServerRequest parameters)
Log Off From CCT Server
|
void |
logOffFromCCTServer(SsoToken ssoToken) |
void |
logoutAgent(LogoutAgentRequest request)
Logout an Agent from a specified Agent terminal
|
void |
logoutAgent(SsoToken ssoToken,
Terminal terminal) |
void |
logoutAgentFromTerminal(LogoutAgentFromTerminalRequest parameters)
Logout an Agent from a specified Agent terminal
|
void |
logoutAgentFromTerminal(SsoToken ssoToken,
Terminal terminal) |
void |
makeSetBusy(SsoToken ssoToken,
Terminal terminal) |
void |
makeSetBusy(TerminalRequest request)
Make a terminal Busy.
|
void |
setActivityCode(SetActivityCodeRequest request)
Set an Activity Code on a specified terminal.
|
void |
setActivityCode(SsoToken ssoToken,
Terminal terminal,
java.lang.String activityCode) |
void |
setContactData(SetContactDataRequest request)
Attach data to a given Contact
|
void |
setContactData(SsoToken ssoToken,
Contact contact,
AttachedData contactData) |
void |
setIntrinsics(SetIntrinsicsRequest parameters) |
void |
setToNotReadyState(SsoToken ssoToken,
Terminal terminal) |
void |
setToNotReadyState(TerminalRequest request)
Sets an Agent on a specified terminal to the NotReady state
|
void |
setToNotReadyStateWithReasonCode(SetToNotReadyStateWithReasonCodeRequest request)
Sets an Agent on a specified terminal to the NotReady state
|
void |
setToNotReadyStateWithReasonCode(SsoToken ssoToken,
Terminal terminal,
java.lang.String reasonCode) |
void |
setToReadyState(SsoToken ssoToken,
Terminal terminal) |
void |
setToReadyState(TerminalRequest request)
Sets an Agent on a specified terminal to the Ready state
|
void |
transferContact(SsoToken ssoToken,
Terminal terminal,
Contact contact,
Address destAddress) |
void |
transferContact(TerminalContactAddressRequest request)
Transfer the specified contact located on the specified terminal to the destination address using singleStepTransfer.
|
void |
unHoldContact(SsoToken ssoToken,
Terminal terminal,
Contact contact) |
void |
unHoldContact(TerminalContactRequest request)
UnHold the specified contact located on the specified terminal.
|
public com.nortel.soa.oi.cct.security.SessionManager getSessionManager()
public void answerContact(TerminalContactRequest request) throws SessionNotCreatedException, AnswerContactException
Contact
Operation Summary:
Used to answer a given contact in a Ringing state supporting this capability.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
answerContact
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the TerminalContactRequest
containing the contact informationSessionNotCreatedException
AnswerContactException
public void answerContact(SsoToken ssoToken, Terminal terminal, Contact contact) throws SessionNotCreatedException, AnswerContactException
public ContactResponse createContact(CreateContactRequest request) throws CreateContactException, SessionNotCreatedException
Operation Summary:
Used to initiate a new contact to another address.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
createContact
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the ContactRequest
containing the source Terminal
and Address
as well as the destination Address
informationContactResponse
the newly created Contact
CreateContactException
SessionNotCreatedException
public Contact createContact(SsoToken ssoToken, Terminal terminal, Address origAddress, Address destAddress) throws CreateContactException, SessionNotCreatedException
public void dropContact(TerminalContactRequest request) throws SessionNotCreatedException, DropContactException
Operation Summary:
Used to drop a given active contact.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
dropContact
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the ContactRequest
containing the contact informationSessionNotCreatedException
DropContactException
public void dropContact(SsoToken ssoToken, Terminal terminal, Contact contact) throws SessionNotCreatedException, DropContactException
public GetReadyStateResponse getReadyState(TerminalRequest request) throws SessionNotCreatedException, GetReadyStateException
Operation Summary:
Returns the state on a specified terminal..
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getReadyState
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the TerminalRequest
containing information of the Terminal
being queriedGetReadyStateResponse
the TerminalState
of the given Terminal
}SessionNotCreatedException
GetReadyStateException
public boolean getReadyState(SsoToken ssoToken, Terminal terminal) throws SessionNotCreatedException, GetReadyStateException
public void holdContact(TerminalContactRequest request) throws SessionNotCreatedException, HoldContactException
Operation Summary:
Hold the specified contact located on the specified terminal.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
holdContact
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the TerminalContactRequest
containing information of the Contact
and the Terminal
it is to be held onSessionNotCreatedException
HoldContactException
public void holdContact(SsoToken ssoToken, Terminal terminal, Contact contact) throws SessionNotCreatedException, HoldContactException
public void makeSetBusy(TerminalRequest request) throws SessionNotCreatedException, MakeSetBusyException
Operation Summary:
Make a terminal Busy.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
makeSetBusy
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the TerminalRequest
containing information on the Terminal
to be made busySessionNotCreatedException
MakeSetBusyException
public void makeSetBusy(SsoToken ssoToken, Terminal terminal) throws SessionNotCreatedException, MakeSetBusyException
public void setActivityCode(SetActivityCodeRequest request) throws SessionNotCreatedException, SetActivityCodeException
Operation Summary:
Set an Activity Code on a specified terminal.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
setActivityCode
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the SetActivityCodeRequest
containing the Terminal
and the activity code to setSessionNotCreatedException
SetActivityCodeException
public void setActivityCode(SsoToken ssoToken, Terminal terminal, java.lang.String activityCode) throws SessionNotCreatedException, SetActivityCodeException
public GetIntrinsicsResponse getIntrinsics(ContactRequest parameters) throws GetIntrinsicsException, SessionNotCreatedException
getIntrinsics
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
GetIntrinsicsException
SessionNotCreatedException
public void setIntrinsics(SetIntrinsicsRequest parameters) throws SetIntrinsicsException, SessionNotCreatedException
setIntrinsics
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
SetIntrinsicsException
SessionNotCreatedException
public GetContactDataResponse getContactData(ContactRequest parameters) throws GetContactDataException, SessionNotCreatedException
Operation Summary:
Returns Contact's attached data.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getContactData
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the ContactRequest
containing Contact
to retrieve data onGetContactDataResponse
the AttachedData
on the given Contact
}GetContactDataException
SessionNotCreatedException
public GetContactDataResponse getContactData(SsoToken ssoToken, Contact contact) throws GetContactDataException, SessionNotCreatedException
public void setContactData(SetContactDataRequest request) throws SessionNotCreatedException, SetContactDataException
Operation Summary:
Attach data to a given Contact
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
setContactData
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the SetContactDataRequest
containing Contact
information and the AttachedData
to associate with itSessionNotCreatedException
SetContactDataException
public void setContactData(SsoToken ssoToken, Contact contact, AttachedData contactData) throws SessionNotCreatedException, SetContactDataException
public void setToNotReadyStateWithReasonCode(SetToNotReadyStateWithReasonCodeRequest request) throws SessionNotCreatedException, SetToNotReadyStateWithReasonCodeException
Operation Summary:
Sets an Agent on a specified terminal to the NotReady state with a Reason code for doing so
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
setToNotReadyStateWithReasonCode
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the SetToNotReadyStateWithReasonCodeRequest
containing Terminal
information and the Reason
explaining the change in stateSessionNotCreatedException
SetToNotReadyStateWithReasonCodeException
public void setToNotReadyStateWithReasonCode(SsoToken ssoToken, Terminal terminal, java.lang.String reasonCode) throws SessionNotCreatedException, SetToNotReadyStateWithReasonCodeException
public void setToReadyState(TerminalRequest request) throws SessionNotCreatedException, SetToReadyStateException
Operation Summary:
Sets an Agent on a specified terminal to the Ready state
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
setToReadyState
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the TerminalRequest
containing the Terminal
to be set to the Ready stateSessionNotCreatedException
SetToReadyStateException
public void setToReadyState(SsoToken ssoToken, Terminal terminal) throws SessionNotCreatedException, SetToReadyStateException
public void setToNotReadyState(TerminalRequest request) throws SessionNotCreatedException, SetToNotReadyStateException
Operation Summary:
Sets an Agent on a specified terminal to the NotReady state
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
setToNotReadyState
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the TerminalRequest
containing the Terminal
to be set to the NotReady stateSessionNotCreatedException
SetToNotReadyStateException
public void setToNotReadyState(SsoToken ssoToken, Terminal terminal) throws SessionNotCreatedException, SetToNotReadyStateException
public void transferContact(TerminalContactAddressRequest request) throws SessionNotCreatedException, TransferContactException
Operation Summary:
Transfer the specified contact located on the specified terminal to the destination address.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
initiateSupervisedTransfer
and completeSupervisedTransfer
in case of SIP system
transferContact
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the TerminalContactAddressRequest
containing the Terminal
to transfer the Contact
from and the destination Address
SessionNotCreatedException
TransferContactException
public void transferContact(SsoToken ssoToken, Terminal terminal, Contact contact, Address destAddress) throws SessionNotCreatedException, TransferContactException
public void unHoldContact(TerminalContactRequest request) throws SessionNotCreatedException, UnHoldContactException
Operation Summary:
UnHold the specified contact located on the specified terminal.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
unHoldContact
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the TerminalContactRequest
containing information of the Contact
and the Terminal
it is to be made active againSessionNotCreatedException
UnHoldContactException
public void unHoldContact(SsoToken ssoToken, Terminal terminal, Contact contact) throws SessionNotCreatedException, UnHoldContactException
public ContactResponse initiateConference(TerminalContactAddressRequest request) throws SessionNotCreatedException, InitiateConferenceException
Operation Summary:
Initiate a Conference of the specified contact located on the specified terminal to the destination address.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
initiateConference
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the TerminalContactAddressRequest
containing the source Terminal
, the active Contact
as well as the destination Address
to add to the conferenceContactResponse
the Contact
Id of the newly created consult legSessionNotCreatedException
InitiateConferenceException
public Contact initiateConference(SsoToken ssoToken, Terminal terminal, Contact contact, Address destAddress) throws SessionNotCreatedException, InitiateConferenceException
public void completeConference(TerminalContactContactRequest request) throws SessionNotCreatedException, CompleteConferenceException
Operation Summary:
Complete a Conference of the specified contact located on the specified terminal.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
completeConference
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the TerminalContactContactRequest
containing the source Terminal
, the original Contact
and the consult Contact
resulting from the initiation of the conferenceSessionNotCreatedException
CompleteConferenceException
public void completeConference(SsoToken ssoToken, Terminal terminal, Contact contact, Contact consultedContact) throws SessionNotCreatedException, CompleteConferenceException
public void loginAgent(LoginAgentRequest request) throws SessionNotCreatedException, LoginAgentException
Operation Summary:
Logon an Agent on a specified Agent terminal.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
loginAgent
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the LoginAgentRequest
containing the Terminal
and the Agent
credentialsSessionNotCreatedException
LoginAgentException
public void loginAgent(SsoToken ssoToken, Terminal terminal, java.lang.String agentId, java.lang.String agentPassword) throws SessionNotCreatedException, LoginAgentException
public void loginAgentToState(LoginAgentToStateRequest request) throws SessionNotCreatedException, LoginAgentToStateException
Operation Summary:
Logon an Agent on a specified Agent terminal to a specified state.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
loginAgentToState
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the LoginAgentToStateRequest
containing the Terminal
and the Agent
credentials as well as the intended Agent stateSessionNotCreatedException
LoginAgentToStateException
public void loginAgentToState(SsoToken ssoToken, Terminal terminal, java.lang.String agentId, java.lang.String agentPassword, int initialState) throws SessionNotCreatedException, LoginAgentToStateException
public void logoutAgent(LogoutAgentRequest request) throws SessionNotCreatedException, LogoutAgentException
Operation Summary:
Logout an Agent from a specified Agent terminal.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
logoutAgent
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the LogoutAgentRequest
containing the Terminal
to log the Agent
out ofSessionNotCreatedException
LogoutAgentException
public void logoutAgent(SsoToken ssoToken, Terminal terminal) throws SessionNotCreatedException, LogoutAgentException
public void completeSupervisedTransfer(TerminalContactContactRequest request) throws SessionNotCreatedException, CompleteSupervisedTransferException
Operation Summary:
Complete a supervised transfer fom the specified contact located on the specified terminal to the destination address.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
completeSupervisedTransfer
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the TerminalContactContactRequest
containing the source Terminal
, the original Contact
and the consult Contact
resulting from the initiation of the supervised transferSessionNotCreatedException
CompleteSupervisedTransferException
public void completeSupervisedTransfer(SsoToken ssoToken, Terminal terminal, Contact contact, Contact consultedContact) throws SessionNotCreatedException, CompleteSupervisedTransferException
public ContactResponse initiateSupervisedTransfer(TerminalContactAddressRequest request) throws SessionNotCreatedException, InitiateSupervisedTransferException
Operation Summary:
Initiate a super of the specified contact located on the specified terminal to the destination address.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
initiateSupervisedTransfer
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the TerminalContactAddressRequest
containing the source Terminal
, the active Contact
as well as the destination Address
to add to the conferenceContactResponse
the Contact
Id of the newly created consult legSessionNotCreatedException
InitiateSupervisedTransferException
public Contact initiateSupervisedTransfer(SsoToken ssoToken, Terminal terminal, Contact contact, Address destAddress) throws SessionNotCreatedException, InitiateSupervisedTransferException
public void emergencyKey(TerminalContactRequest request) throws SessionNotCreatedException, EmergencyKeyException
Operation Summary:
Conference a supervisor on a selected contact.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
emergencyKey
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the TerminalContactRequest
containing the Terminal
and Contact
to conference the supervisor intoSessionNotCreatedException
EmergencyKeyException
public void emergencyKey(SsoToken ssoToken, Terminal terminal, Contact contact) throws SessionNotCreatedException, EmergencyKeyException
public void callSupervisor(TerminalAddressRequest parameters) throws SessionNotCreatedException, CallSupervisorException
Operation Summary:
Used to initiate a call to a user’s supervisor.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
callSupervisor
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the TerminalAddressRequest
containing the Terminal
to call the supervisor fromSessionNotCreatedException
CallSupervisorException
public void callSupervisor(SsoToken ssoToken, Terminal terminal, Address address) throws SessionNotCreatedException, CallSupervisorException
public void logOffFromCCTServer(LogOffFromCCTServerRequest parameters) throws SessionNotCreatedException, LogOffFromCCTServerException
Operation Summary:
Logs off a CCT Server User and invalidates their session token
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
logOffFromCCTServer
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the LogOffFromCCTServerRequest
containing the SsoToken
to invalidate and hence user to LogoffSessionNotCreatedException
LogOffFromCCTServerException
public void logOffFromCCTServer(SsoToken ssoToken) throws SessionNotCreatedException, LogOffFromCCTServerException
public LogInToCCTServerResponse logInToCCTServer(LogInToCCTServerRequest parameters) throws LogInToCCTServerException
Operation Summary:
Logs in a CCT User and returns their session token
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
logInToCCTServer
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the LogInToCCTServerRequest
containing the credentials of the userLogInToCCTServerResponse
the SsoRequest
representing the Users new sessionLogInToCCTServerException
public LogInToCCTServerResponse logInToCCTServer(AuthenticationLevel authenticationLevel) throws LogInToCCTServerException
LogInToCCTServerException
public AddressList getAddresses(GetAddressesRequest parameters) throws SessionNotCreatedException, GetAddressesException
Operation Summary:
Retrieve the Addresses associated with a given user
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getAddresses
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the GetAddressesRequest
containing the SsoToken
representing the user's sessionAddressList
the Address
es associated with the userSessionNotCreatedException
GetAddressesException
public AddressList getAddresses(SsoToken ssoToken) throws SessionNotCreatedException, GetAddressesException
public TerminalList getTerminals(GetTerminalsRequest parameters) throws GetTerminalsException, SessionNotCreatedException
Operation Summary:
Retrieve the Terminals associated with a given user
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getTerminals
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the GetTerminalsRequest
containing the SsoToken
representing the user's sessionTerminalList
the Terminal
s associated with the userGetTerminalsException
SessionNotCreatedException
public TerminalList getTerminals(SsoToken ssoToken) throws GetTerminalsException, SessionNotCreatedException
public AddressList getTerminalAddresses(GetTerminalAddressesRequest parameters) throws GetTerminalAddressesException, SessionNotCreatedException
Operation Summary:
Retrieve the Addresses associated with a given Terminal
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getTerminalAddresses
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the GetTerminalAddressesRequest
containing the Terminal
to retrieve the Address
es forAddressList
the Address
es associated with the Terminal
GetTerminalAddressesException
SessionNotCreatedException
public AddressList getTerminalAddresses(SsoToken ssoToken, Terminal terminal) throws GetTerminalAddressesException, SessionNotCreatedException
public TerminalList getAgentTerminals(GetAgentTerminalsRequest parameters) throws SessionNotCreatedException, GetAgentTerminalsException
Operation Summary:
Retrieve the Terminals associated with a given Agent
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getAgentTerminals
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the GetAgentTerminalsRequest
containing the Agent
to retrieve the Terminal
s forTerminalList
the Terminal
s associated with the Agent
SessionNotCreatedException
GetAgentTerminalsException
public TerminalList getAgentTerminals(SsoToken ssoToken, Agent agent) throws SessionNotCreatedException, GetAgentTerminalsException
public AddressResponse getAddress(GetAddressRequest parameters) throws SessionNotCreatedException, GetAddressException
Operation Summary:
Retrieve the Address given the Address Name
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getAddress
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the GetAddressRequest
containing the name of the Address
to retrieveAddressResponse
the Address
SessionNotCreatedException
GetAddressException
public AddressResponse getAddress(SsoToken ssoToken, java.lang.String addressName) throws SessionNotCreatedException, GetAddressException
public TerminalResponse getTerminal(GetTerminalRequest parameters) throws GetTerminalException, SessionNotCreatedException
Operation Summary:
Retrieve the Terminal given the Terminal Name
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getTerminal
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the GetTerminalRequest
containing the name of the Terminal
to retrieveTerminalResponse
the Terminal
GetTerminalException
SessionNotCreatedException
public TerminalResponse getTerminal(SsoToken ssoToken, java.lang.String termName) throws GetTerminalException, SessionNotCreatedException
public GetAgentsResponse getAgents(SsoRequest parameters) throws GetAgentsException, SessionNotCreatedException
getAgents
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
GetAgentsException
SessionNotCreatedException
public GetAgentsResponse getAgents(SsoToken ssoToken) throws GetAgentsException, SessionNotCreatedException
Operation Summary:
Retrieve the Agents associated with a given user
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
parameters
- the SsoRequest
containing the SsoToken
representing the user's sessionGetAgentsResponse
the Agent
s associated with the userGetAgentsException
SessionNotCreatedException
public void loginAgentToTerminal(LoginAgentToTerminalRequest parameters) throws LoginAgentToTerminalException, SessionNotCreatedException
Operation Summary:
Logon an Agent to a specified Agent terminal.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
loginAgentToTerminal
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the LoginAgentToTerminalRequest
containing the Terminal
and the Agent
credentialsLoginAgentToTerminalException
SessionNotCreatedException
public void loginAgentToTerminal(SsoToken ssoToken, Terminal terminal, java.lang.String agentId, java.lang.String password, java.lang.Integer initialState) throws LoginAgentToTerminalException, SessionNotCreatedException
public void logoutAgentFromTerminal(LogoutAgentFromTerminalRequest parameters) throws LogoutAgentFromTerminalException, SessionNotCreatedException
Operation Summary:
Logout an Agent from a specified Agent terminal.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
logoutAgentFromTerminal
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
request
- the LogoutAgentFromTerminalRequest
containing the AgentTerminal
to logout fromLogoutAgentFromTerminalException
SessionNotCreatedException
public void logoutAgentFromTerminal(SsoToken ssoToken, Terminal terminal) throws LogoutAgentFromTerminalException, SessionNotCreatedException
public void dispose(SsoRequest parameters) throws DisposeException, SessionNotCreatedException
dispose
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
DisposeException
SessionNotCreatedException
public void generateDTMF(GenerateDTMFRequest parameters) throws GenerateDTMFException, SessionNotCreatedException
Operation Summary:
Create DTMF tones on a selected contact
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
generateDTMF
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the GenerateDTMFRequest
containing the Contact
and Terminal
details on which DTMF tones are to be createdGenerateDTMFException
SessionNotCreatedException
public void generateDTMF(SsoToken ssoToken, Terminal terminal, Contact contact, java.lang.String digits) throws GenerateDTMFException, SessionNotCreatedException
public AddressList getAgentAddresses(GetAgentAddressesRequest parameters) throws GetAgentAddressesException, SessionNotCreatedException
Operation Summary:
Retrieve the Addresses associated with a given Agent
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getAgentAddresses
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the GetAgentAddressesRequest
containing the Agent
to retrieve the Address
es forAddressList
the Address
es associated with the Agent
GetAgentAddressesException
SessionNotCreatedException
public AddressList getAgentAddresses(SsoToken ssoToken, Agent agent) throws GetAgentAddressesException, SessionNotCreatedException
public ContactResponse getContact(ContactRequest parameters) throws GetContactException, SessionNotCreatedException
Operation Summary:
Retrieve the Contact given the Contact containing an ID
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getContact
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the ContactRequest
containing Contact
populated with IDContactResponse
the fully populated Contact
GetContactException
SessionNotCreatedException
public ContactResponse getContact(SsoToken ssoToken, Contact contact) throws GetContactException, SessionNotCreatedException
public int getCurrentAddressCount(SsoRequest parameters) throws GetCurrentAddressCountException, SessionNotCreatedException
Operation Summary:
Retrieve the number of addresses associated with the CCT user
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getCurrentAddressCount
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the SsoRequest
containing SsoToken
representing the users's sessionAddress
esGetCurrentAddressCountException
SessionNotCreatedException
public int getCurrentAddressCount(SsoToken ssoToken) throws GetCurrentAddressCountException, SessionNotCreatedException
public int getCurrentTerminalCount(SsoRequest parameters) throws GetCurrentTerminalCountException, SessionNotCreatedException
Operation Summary:
Retrieve the number of terminals associated with the CCT user
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getCurrentTerminalCount
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the SsoRequest
containing SsoToken
representing the users's sessionTerminal
sGetCurrentTerminalCountException
SessionNotCreatedException
public int getCurrentTerminalCount(SsoToken ssoToken) throws GetCurrentTerminalCountException, SessionNotCreatedException
public GetVersionResponse getVersion(GetVersionRequest parameters) throws GetVersionException, SessionNotCreatedException
Operation Summary:
Retrieve the version number of the SessionService
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getVersion
in interface com.nortel.soa.oi.cct.sessionservice.SessionService
parameters
- the GetVersionRequest
version requestGetVersionResponse
the version number as a stringGetVersionException
SessionNotCreatedException
Copyright © 2010 All Rights Reserved.