public class ContactServiceImpl
extends java.lang.Object
implements com.nortel.soa.oi.cct.contactservice.ContactService
This service models a Contact in the System and as such provides functionality for querying and
manipulating a given contact. A Contact represents the communication between two or more addresses.
A contact is referenced using its unique identifier and can be of a variety of types including Voice, Email, IM.
Each Contact has properties that can be accessed and/or updated. The collection of operations exposed by
this Service represent a platform neutral means to achieve this
Prerequisites to usage: This represents the minimal data artifacts required to successfully invoke this web service.
Operations: View WSDL
As with all of the OI services Contact Types and Capabilities are accessible.
Since this is a contact-centric service specific operations exist for the discovery of
Connections attached to a contact as well as the manipulation of contact properties
including Attached Data, UUI Data, Intrinsic Data and Treatment.
| Constructor and Description |
|---|
ContactServiceImpl() |
| Modifier and Type | Method and Description |
|---|---|
ConnectionResponse |
addParty(AddPartyRequest parameters)
Add an additional party to an existing contact.
|
ConnectionResponse |
bargeIn(BargeInRequest parameters)
Forcefully adds a party to the contact
|
void |
drop(ContactRequest request) |
GetAttachedDataResponse |
getAttachedData(ContactRequest parameters)
Retrieve attached data associated with a contact
|
GetAttachedXMLDataResponse |
getAttachedXMLData(ContactRequest parameters) |
GetAttachedXMLDataResponse |
getAttachedXMLData(SsoToken ssoToken,
Contact contact)
Retrieve attached XML data values associated with a contact.
|
AddressResponse |
getCalledAddress(ContactRequest parameters)
The first destination address associated with this contact
|
AddressResponse |
getCallingAddress(ContactRequest parameters)
Retrieve the address that was the original source of this contact
|
TerminalResponse |
getCallingTerminal(ContactRequest parameters)
Retrieve the terminal that was the original source of this contact
|
GetContactCapabilitiesResponse |
getCapabilities(ContactRequest parameters)
Retrieve the Capabilities of the current contact.
|
ConnectionResponse |
getConnection(ContactAddressRequest parameters)
Retrieve a specified connection associated with this contact
|
GetConnectionsResponse |
getConnections(ContactRequest parameters)
Retrieve an array of all connections currently active on this contact.
|
GetContactTypesResponse |
getContactTypes(ContactRequest parameters)
An array of contact types that are currently represented by this contact.
|
GetInstantMessagesResponse |
getInstantMessages(ContactRequest parameters)
Retrieve the instant messages associated with a contact
|
GetIntrinsicsResponse |
getIntrinsics(ContactRequest parameters)
Retrieve intrinsic data associated with a contact
|
AddressResponse |
getLastRedirectedAddress(ContactRequest parameters)
Retrieve the most recent address from which a contact was redirected
|
AddressResponse |
getOriginalDestinationAddress(ContactRequest parameters)
Retrieve the original destination address of a contact
|
GetUUIResponse |
getUUI(ContactRequest parameters)
Retrieve user-user info (UUI) associated with a contact
|
java.lang.String |
getVersion() |
GetVersionResponse |
getVersion(GetVersionRequest parameters) |
TreatmentConnectionResponse |
giveTreatment(GiveTreatmentRequest parameters)
Assign treatment to a connection associated with a given contact
|
ConnectionResponse |
observe(ObserveRequest request)
Creates an "observe" connection to this contact
|
ConnectionResponse |
observeTargetConnection(ObserveTargetConnectionRequest request)
Creates an "observe" connection to this contact
|
void |
setAttachedData(ContactAttachedDataRequest parameters)
Set attached data associated with a contact
|
void |
setInstantMessages(SetInstantMessagesRequest parameters)
Associate an instant message with a contact
|
void |
setIntrinsics(SetIntrinsicsRequest parameters)
Set intrinsic data associated with a contact
|
void |
setUUI(SetUUIRequest parameters)
Manipulate user-user info (UUI) associated with a contact
|
ConnectionResponse |
whisper(WhisperRequest parameters)
Deprecated.
|
ConnectionResponse |
whisperTargetConnection(WhisperTargetConnectionRequest parameters)
Creates a "whisper" connection to this contact
|
public AddressResponse getOriginalDestinationAddress(ContactRequest parameters) throws SessionNotCreatedException, GetOriginalDestinationAddressException
Operation Summary:
Retrieve the original destination address used by the caller to reach the system, sometimes referred
to as the DNIS (Dialed Number Identification Service).
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getOriginalDestinationAddress in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactRequest containing the contact informationAddressResponse the original destinationAddress of to the ContactSessionNotCreatedExceptionGetOriginalDestinationAddressExceptionpublic AddressResponse getLastRedirectedAddress(ContactRequest parameters) throws GetLastRedirectedAddressException, SessionNotCreatedException
Operation Summary:
Retrieve the most recent address from which this contact was redirected
(for example, if the contact was routed through a Route Point Address).
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getLastRedirectedAddress in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactRequest containing the contact informationAddressResponse the original destinationAddress of to the ContactGetLastRedirectedAddressExceptionSessionNotCreatedExceptionpublic ConnectionResponse getConnection(ContactAddressRequest parameters) throws GetConnectionException, SessionNotCreatedException
Operation Summary:
Retrieve the Connection associated with a given Contact and Address
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getConnection in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactAddressRequest containing the contact and address informationConnectionResponse the Connection attached to the ContactGetConnectionExceptionSessionNotCreatedExceptionpublic GetConnectionsResponse getConnections(ContactRequest parameters) throws SessionNotCreatedException, GetConnectionsException
Operation Summary:
Retrieve an array of all Connections currently active on this contact.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getConnections in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactRequest containing the contact informationGetConnectionsResponse the Connections attached to the ContactSessionNotCreatedExceptionGetConnectionsExceptionpublic GetAttachedDataResponse getAttachedData(ContactRequest parameters) throws GetAttachedDataException, SessionNotCreatedException
Operation Summary:
Retrieve attached data associated with a contact. This data can be of one of three forms;
String, Binary or Key-Value Pair. The service, on retrieval of the attached data, identifies
the form and builds the response accordingly populating the type along with the
corresponding data holder i.e. one of binaryData | keyValueData | stringData.
If the contact has no attached data, nothing is set on the returned AttachedData object as
part of the response.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getAttachedData in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactRequest containing the contact informationGetAttachedDataResponse the AttachedData attached to the ContactGetAttachedDataExceptionSessionNotCreatedExceptionpublic GetAttachedXMLDataResponse getAttachedXMLData(ContactRequest parameters) throws GetAttachedXMLDataException, SessionNotCreatedException
getAttachedXMLData in interface com.nortel.soa.oi.cct.contactservice.ContactServiceGetAttachedXMLDataExceptionSessionNotCreatedExceptionpublic GetAttachedXMLDataResponse getAttachedXMLData(SsoToken ssoToken, Contact contact) throws GetAttachedXMLDataException, SessionNotCreatedException
Operation Summary:
This web services is designed to be used in conjunction with the Database Integration Wizard so that XML data associated with the contact
can be parsed and used within TFE scripts. The XML data must be in format: <data> <value>value1</value> <value>value2</value> </data>
for up to nine values (maximum HDX supports). Order of the values is retained from the XML to the TFE script.
If the contact has no attached data, nothing is set on the returned AttachedXMLData object as part of the response.
parameters - the ContactRequest containing the contact informationGetAttachedXMLDataResponse the AttachedXMLData attached to the ContactGetAttachedXMLDataExceptionSessionNotCreatedExceptionpublic TerminalResponse getCallingTerminal(ContactRequest parameters) throws GetCallingTerminalException, SessionNotCreatedException
Operation Summary:
Retrieve the terminal that was the original source of this contact.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getCallingTerminal in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactRequest containing the contact informationTerminalResponse the Terminal attached to the ContactGetCallingTerminalExceptionSessionNotCreatedExceptionpublic AddressResponse getCallingAddress(ContactRequest parameters) throws SessionNotCreatedException, GetCallingAddressException
Operation Summary:
Retrieve the address that was the original source of this contact.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getCallingAddress in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactRequest containing the contact informationAddressResponse the Address attached to the ContactSessionNotCreatedExceptionGetCallingAddressExceptionpublic GetContactCapabilitiesResponse getCapabilities(ContactRequest parameters) throws GetCapabilitiesException, SessionNotCreatedException
Operation Summary:
Retrieve the Capabilities specific to the current contact.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getCapabilities in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactRequest containing the contact informationGetContactCapabilitiesResponse the ContactCapabilities attached to the ContactGetCapabilitiesExceptionSessionNotCreatedExceptionpublic void setAttachedData(ContactAttachedDataRequest parameters) throws SetAttachedDataException, SessionNotCreatedException
Operation Summary:
Associate data with a contact. This data can be of one of three forms;
String, Binary or Key-Value Pair. The service, on receipt of data, identifies
the form and attaches the data to the contact accordingly
Sample Usage:
SOAP Request/Response:
Sample Request
setAttachedData in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactAttachedDataRequest containing the contact attachment informationSetAttachedDataExceptionSessionNotCreatedExceptionpublic AddressResponse getCalledAddress(ContactRequest parameters) throws SessionNotCreatedException, GetCalledAddressException
Operation Summary:
The first destination address associated with this contact (the first address that received an inbound connection).
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getCalledAddress in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactRequest containing the contact informationAddressResponse the Address called when creating the ContactSessionNotCreatedExceptionGetCalledAddressExceptionpublic TreatmentConnectionResponse giveTreatment(GiveTreatmentRequest parameters) throws GiveTreatmentException, SessionNotCreatedException
Operation Summary:
Specify a treatment to be played to a specific address
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
giveTreatment in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the GiveTreatmentRequest containing the MediaTreatment and Contact informationTreatmentConnectionResponse the Connection and its associated MediaTreatmentGiveTreatmentExceptionSessionNotCreatedExceptionpublic ConnectionResponse addParty(AddPartyRequest parameters) throws AddPartyException, SessionNotCreatedException
Operation Summary:
Adds an additional party to an existing contact.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
addParty in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the AddPartyRequest containing the party information to add to the ContactConnectionResponse the Connection added to the ContactAddPartyExceptionSessionNotCreatedExceptionpublic ConnectionResponse bargeIn(BargeInRequest parameters) throws BargeInException, SessionNotCreatedException
Operation Summary:
Forcefully adds a TerminalConnection and Connection to the specified terminal and address.
Allows a new connection to be added to a contact without requesting the addition via a conference, and so on.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
bargeIn in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - information necessary to add the new ConnectionConnectionResponse the Connection added to the ContactBargeInExceptionSessionNotCreatedExceptionpublic GetContactTypesResponse getContactTypes(ContactRequest parameters) throws GetContactTypesException, SessionNotCreatedException
Operation Summary:
Retrieve an array of contact types that are currently represented by this contact.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getContactTypes in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactRequest containing the contact informationGetContactTypesResponse the ContactTypes associated with the ContactGetContactTypesExceptionSessionNotCreatedExceptionpublic GetInstantMessagesResponse getInstantMessages(ContactRequest parameters) throws SessionNotCreatedException, GetInstantMessagesException
Operation Summary:
Retrieve the instant messages associated with a contact
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getInstantMessages in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactRequest containing the Contact informationGetInstantMessagesResponse the instant messages associated with to the ContactSessionNotCreatedExceptionGetInstantMessagesExceptionpublic void setInstantMessages(SetInstantMessagesRequest parameters) throws SetInstantMessagesException, SessionNotCreatedException
Operation Summary:
Associates an instant message with a contact
Sample Usage:
SOAP Request/Response:
Sample Request
setInstantMessages in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the SetInstantMessagesRequest containing the Contact and InstantMessage informationSetInstantMessagesExceptionSessionNotCreatedExceptionpublic GetIntrinsicsResponse getIntrinsics(ContactRequest parameters) throws GetIntrinsicsException, SessionNotCreatedException
Operation Summary:
Retrieve the Intrinsics allowing the client to manipulate the mutable intrinsics associated with the contact.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getIntrinsics in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactRequest containing the contact informationGetIntrinsicsResponse the Intrinsics associated with the ContactGetIntrinsicsExceptionSessionNotCreatedExceptionpublic void setIntrinsics(SetIntrinsicsRequest parameters) throws SetIntrinsicsException, SessionNotCreatedException
Operation Summary:
Set the mutable Intrinsics associated with the contact.
Sample Usage:
SOAP Request/Response:
Sample Request
setIntrinsics in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the SetIntrinsicsRequest containing the Intrinsic informationSetIntrinsicsExceptionSessionNotCreatedExceptionpublic GetUUIResponse getUUI(ContactRequest parameters) throws GetUUIException, SessionNotCreatedException
Operation Summary:
Retrieve user-user info (UUI). UUI is call (contact) related data that can
be transferred with a call through ISDN signaling.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getUUI in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ContactRequest containing the contact informationGetUUIResponse the UUI associated with the ContactGetUUIExceptionSessionNotCreatedExceptionpublic void setUUI(SetUUIRequest parameters) throws SetUUIException, SessionNotCreatedException
Operation Summary:
Manipulate user-user info (UUI). UUI is call (contact) related data that can
be transferred with a call through ISDN signaling.
Sample Usage:
SOAP Request/Response:
Sample Request
setUUI in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the SetUUIRequest containing the UUI and Contact informationSetUUIExceptionSessionNotCreatedExceptionpublic ConnectionResponse whisper(WhisperRequest parameters) throws WhisperException, SessionNotCreatedException
whisperTargetConnection(WhisperTargetConnectionRequest)
Operation Summary:
Creates a "whisper" connection to this contact, allowing a supervisor to listen to all parties
involved in the contact and talk to the agent without being heard by anyone else on the contact.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
whisper in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the WhisperRequest containing information necessary to construct a new call legConnectionResponse the new Connection attached to the ContactWhisperExceptionSessionNotCreatedExceptionpublic ConnectionResponse whisperTargetConnection(WhisperTargetConnectionRequest parameters) throws SessionNotCreatedException, WhisperException
Operation Summary:
Creates a "whisper" connection to this contact, allowing a supervisor to listen to all parties
involved in the contact and talk to the agent without being heard by anyone else on the contact.
When the target conenction drops off the call, the whisper connection should also drop off.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
whisperTargetConnection in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the WhisperRequest containing information necessary to construct a new call legConnectionResponse the new Connection attached to the ContactSessionNotCreatedExceptionWhisperExceptionpublic ConnectionResponse observe(ObserveRequest request) throws ObserveException, SessionNotCreatedException
Operation Summary:
Creates an "observe" connection to this contact, allowing a supervisor to listen to the contact without being heard.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
observe in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ObserveRequest containing information to add a leg to the contact informationConnectionResponse the new Connection attached to the ContactObserveExceptionSessionNotCreatedExceptionpublic ConnectionResponse observeTargetConnection(ObserveTargetConnectionRequest request) throws SessionNotCreatedException, ObserveException
Operation Summary:
Creates an "observe" connection to this contact, allowing a supervisor to listen to the contact without being heard.
When the target Connection drops of the Contact the observe connection should also drop from the Contact
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
observeTargetConnection in interface com.nortel.soa.oi.cct.contactservice.ContactServiceparameters - the ObserveRequest containing information to add a leg to the contact informationConnectionResponse the new Connection attached to the ContactSessionNotCreatedExceptionObserveExceptionpublic void drop(ContactRequest request) throws DropException, SessionNotCreatedException
drop in interface com.nortel.soa.oi.cct.contactservice.ContactServiceDropExceptionSessionNotCreatedExceptionpublic GetVersionResponse getVersion(GetVersionRequest parameters) throws SessionNotCreatedException, GetVersionException
getVersion in interface com.nortel.soa.oi.cct.contactservice.ContactServiceSessionNotCreatedExceptionGetVersionExceptionpublic java.lang.String getVersion()
throws SessionNotCreatedException,
GetVersionException
Copyright © 2010 All Rights Reserved.