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.SessionServicerequest - the TerminalContactRequest containing the contact informationSessionNotCreatedExceptionAnswerContactExceptionpublic 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.SessionServicerequest - the ContactRequest containing the source Terminal and Address as well as the destination Address informationContactResponse the newly created ContactCreateContactExceptionSessionNotCreatedExceptionpublic 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.SessionServicerequest - the ContactRequest containing the contact informationSessionNotCreatedExceptionDropContactExceptionpublic 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.SessionServicerequest - the TerminalRequest containing information of the Terminal being queriedGetReadyStateResponse the TerminalState of the given Terminal}SessionNotCreatedExceptionGetReadyStateExceptionpublic 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.SessionServicerequest - the TerminalContactRequest containing information of the Contact and the Terminal it is to be held onSessionNotCreatedExceptionHoldContactExceptionpublic 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.SessionServicerequest - the TerminalRequest containing information on the Terminal to be made busySessionNotCreatedExceptionMakeSetBusyExceptionpublic 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.SessionServicerequest - the SetActivityCodeRequest containing the Terminal and the activity code to setSessionNotCreatedExceptionSetActivityCodeExceptionpublic 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.SessionServiceGetIntrinsicsExceptionSessionNotCreatedExceptionpublic void setIntrinsics(SetIntrinsicsRequest parameters) throws SetIntrinsicsException, SessionNotCreatedException
setIntrinsics in interface com.nortel.soa.oi.cct.sessionservice.SessionServiceSetIntrinsicsExceptionSessionNotCreatedExceptionpublic 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.SessionServicerequest - the ContactRequest containing Contact to retrieve data onGetContactDataResponse the AttachedData on the given Contact}GetContactDataExceptionSessionNotCreatedExceptionpublic 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.SessionServicerequest - the SetContactDataRequest containing Contact information and the AttachedData to associate with itSessionNotCreatedExceptionSetContactDataExceptionpublic 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.SessionServicerequest - the SetToNotReadyStateWithReasonCodeRequest containing Terminal information and the Reason explaining the change in stateSessionNotCreatedExceptionSetToNotReadyStateWithReasonCodeExceptionpublic 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.SessionServicerequest - the TerminalRequest containing the Terminal to be set to the Ready stateSessionNotCreatedExceptionSetToReadyStateExceptionpublic 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.SessionServicerequest - the TerminalRequest containing the Terminal to be set to the NotReady stateSessionNotCreatedExceptionSetToNotReadyStateExceptionpublic 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.SessionServicerequest - the TerminalContactAddressRequest containing the Terminal to transfer the Contact from and the destination AddressSessionNotCreatedExceptionTransferContactExceptionpublic 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.SessionServicerequest - the TerminalContactRequest containing information of the Contact and the Terminal it is to be made active againSessionNotCreatedExceptionUnHoldContactExceptionpublic 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.SessionServicerequest - the TerminalContactAddressRequest containing the source Terminal, the active Contact as well as the destination Address to add to the conferenceContactResponse the ContactId of the newly created consult legSessionNotCreatedExceptionInitiateConferenceExceptionpublic 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.SessionServicerequest - the TerminalContactContactRequest containing the source Terminal, the original Contact and the consult Contact resulting from the initiation of the conferenceSessionNotCreatedExceptionCompleteConferenceExceptionpublic 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.SessionServicerequest - the LoginAgentRequest containing the Terminal and the Agent credentialsSessionNotCreatedExceptionLoginAgentExceptionpublic 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.SessionServicerequest - the LoginAgentToStateRequest containing the Terminal and the Agent credentials as well as the intended Agent stateSessionNotCreatedExceptionLoginAgentToStateExceptionpublic 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.SessionServicerequest - the LogoutAgentRequest containing the Terminal to log the Agent out ofSessionNotCreatedExceptionLogoutAgentExceptionpublic 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.SessionServicerequest - the TerminalContactContactRequest containing the source Terminal, the original Contact and the consult Contact resulting from the initiation of the supervised transferSessionNotCreatedExceptionCompleteSupervisedTransferExceptionpublic 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.SessionServicerequest - the TerminalContactAddressRequest containing the source Terminal, the active Contact as well as the destination Address to add to the conferenceContactResponse the ContactId of the newly created consult legSessionNotCreatedExceptionInitiateSupervisedTransferExceptionpublic 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.SessionServicerequest - the TerminalContactRequest containing the Terminal and Contact to conference the supervisor intoSessionNotCreatedExceptionEmergencyKeyExceptionpublic 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.SessionServiceparameters - the TerminalAddressRequest containing the Terminal to call the supervisor fromSessionNotCreatedExceptionCallSupervisorExceptionpublic 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.SessionServiceparameters - the LogOffFromCCTServerRequest containing the SsoToken to invalidate and hence user to LogoffSessionNotCreatedExceptionLogOffFromCCTServerExceptionpublic 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.SessionServiceparameters - the LogInToCCTServerRequest containing the credentials of the userLogInToCCTServerResponse the SsoRequest representing the Users new sessionLogInToCCTServerExceptionpublic LogInToCCTServerResponse logInToCCTServer(AuthenticationLevel authenticationLevel) throws LogInToCCTServerException
LogInToCCTServerExceptionpublic 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.SessionServiceparameters - the GetAddressesRequest containing the SsoToken representing the user's sessionAddressList the Addresses associated with the userSessionNotCreatedExceptionGetAddressesExceptionpublic 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.SessionServiceparameters - the GetTerminalsRequest containing the SsoToken representing the user's sessionTerminalList the Terminals associated with the userGetTerminalsExceptionSessionNotCreatedExceptionpublic 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.SessionServiceparameters - the GetTerminalAddressesRequest containing the Terminal to retrieve the Addresses forAddressList the Addresses associated with the TerminalGetTerminalAddressesExceptionSessionNotCreatedExceptionpublic 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.SessionServiceparameters - the GetAgentTerminalsRequest containing the Agent to retrieve the Terminals forTerminalList the Terminals associated with the AgentSessionNotCreatedExceptionGetAgentTerminalsExceptionpublic 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.SessionServiceparameters - the GetAddressRequest containing the name of the Address to retrieveAddressResponse the AddressSessionNotCreatedExceptionGetAddressExceptionpublic 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.SessionServiceparameters - the GetTerminalRequest containing the name of the Terminal to retrieveTerminalResponse the TerminalGetTerminalExceptionSessionNotCreatedExceptionpublic 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.SessionServiceGetAgentsExceptionSessionNotCreatedExceptionpublic 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 Agents associated with the userGetAgentsExceptionSessionNotCreatedExceptionpublic 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.SessionServicerequest - the LoginAgentToTerminalRequest containing the Terminal and the Agent credentialsLoginAgentToTerminalExceptionSessionNotCreatedExceptionpublic 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.SessionServicerequest - the LogoutAgentFromTerminalRequest containing the AgentTerminal to logout fromLogoutAgentFromTerminalExceptionSessionNotCreatedExceptionpublic 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.SessionServiceDisposeExceptionSessionNotCreatedExceptionpublic 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.SessionServiceparameters - the GenerateDTMFRequest containing the Contact and Terminal details on which DTMF tones are to be createdGenerateDTMFExceptionSessionNotCreatedExceptionpublic 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.SessionServiceparameters - the GetAgentAddressesRequest containing the Agent to retrieve the Addresses forAddressList the Addresses associated with the AgentGetAgentAddressesExceptionSessionNotCreatedExceptionpublic 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.SessionServiceparameters - the ContactRequest containing Contact populated with IDContactResponse the fully populated ContactGetContactExceptionSessionNotCreatedExceptionpublic 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.SessionServiceparameters - the SsoRequest containing SsoToken representing the users's sessionAddressesGetCurrentAddressCountExceptionSessionNotCreatedExceptionpublic 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.SessionServiceparameters - the SsoRequest containing SsoToken representing the users's sessionTerminalsGetCurrentTerminalCountExceptionSessionNotCreatedExceptionpublic 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.SessionServiceparameters - the GetVersionRequest version requestGetVersionResponse the version number as a stringGetVersionExceptionSessionNotCreatedExceptionCopyright © 2010 All Rights Reserved.