Interaction SDK
(Web Services)

Service: ContactService


Accesses the contacts' data stored in the Contact Server.
Attribute Summary

Method Summary
int countContacts
           Count the number of contacts matching the provided search template.
com.genesyslab.ail.ws.contact.ContactResult[] createContacts
           Creates contacts with the given information.
com.genesyslab.ail.ws.contact.ContactAttributeMetaData[] getContactAttributeMetaDataById
           Retrieves a list of contact attributes metadata.
com.genesyslab.ail.ws.contact.ContactAttributeMetaData[] getContactAttributeMetaDataByName
           Retrieves a list of contact attribute metadata.
com.genesyslab.ail.ws.contact.ContactAttributePredefinedMetaData[] getContactAttributePredefinedMetaData
           Returns a list of all fixed contact attribute metadata.
com.genesyslab.ail.ws.contact.ContactInfo[] getContactInfos
           Retrieves additional information on these contacts.
com.genesyslab.ail.ws.contact.ContactValue[] getContacts
           Retrieves all the requested attributes on these contacts.
com.genesyslab.ail.ws.contact.ContactMergeDetail getMergeDetail
           Returns the details of the last merge action performed on the specified destination contact.
void merge
           Merges all the history from the source contact into the destination contact.
com.genesyslab.ail.ws.contact.ContactError[] mergeContacts
           Merges contacts together.
com.genesyslab.ail.ws.contact.ContactError[] removeContactAttributes
           Removes the specified contacts' attributes.
com.genesyslab.ail.ws.contact.ContactError[] removeContacts
           Removes a list of contacts.
com.genesyslab.ail.ws.contact.ContactValue[] searchContacts
           Searches contacts from a template.
com.genesyslab.ail.ws.contact.ContactResult[] setContactAttributes
           Sets data on contacts with the given information .
void undoMerge
           Undoes the last merge action performed for the specified destination contact.

Event Summary

Attribute Detail

Method Detail

countContacts

Count the number of contacts matching the provided search template.
Parameters:

  searchTemplate  com.genesyslab.ail.ws.contact.ContactSearchTemplate
   The search template.

Returns:

  Type:  int

   The number of contacts matching the search template.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid

  error.common.RequestFailed

  error.common.DatabaseService

  error.contact.ContactManagerNotExist


createContacts

Creates contacts with the given information.
Parameters:

  datas  com.genesyslab.ail.ws.contact.ContactAttributeCreate[]
   The attributes to create for each contact.

  returnValues  boolean
   If true, the returned ContactResults contain the created contact attributes; otherwise, for each returned ContactResult, the ContactResult.attributes field is null.

Returns:

  Type:  com.genesyslab.ail.ws.contact.ContactResult[]

   The result on each contact.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid
  

  error.common.RequestFailed
  

  error.common.DatabaseService
  

  error.contact.AttributeNameInvalid
  

  error.contact.ContactManagerNotExist


getContactAttributeMetaDataById

Retrieves a list of contact attributes metadata.
Parameters:

  attributeMetaDataIds  String[]
   The IDs of the attribute metadata to retrieve. Null to retrieve all the metadata.

Returns:

  Type:  com.genesyslab.ail.ws.contact.ContactAttributeMetaData[]

   The attribute metadata containers.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid

  error.common.RequestFailed

  error.common.DatabaseService

  error.contact.ContactManagerNotExist


getContactAttributeMetaDataByName

Retrieves a list of contact attribute metadata.
Parameters:

  attributeMetaDataNames  String[]
   The names of the metadata to retrieve. Null to retrieve all the metadata.

Returns:

  Type:  com.genesyslab.ail.ws.contact.ContactAttributeMetaData[]

   The attribute metadata containers.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid

  error.common.RequestFailed

  error.common.DatabaseService

  error.contact.ContactManagerNotExist


getContactAttributePredefinedMetaData

Returns a list of all fixed contact attribute metadata.
Parameters:

Returns:

  Type:  com.genesyslab.ail.ws.contact.ContactAttributePredefinedMetaData[]

   The fixed attribute metadata containers.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.DatabaseService

  error.contact.ContactManagerNotExist


getContactInfos

Retrieves additional information on these contacts.
Parameters:

  contactIds  String[]
   The contact identifiers.

Returns:

  Type:  com.genesyslab.ail.ws.contact.ContactInfo[]

   The additional information for each contact.

Errors:

  error.common.AilFactoryNotInitialized

  error.contact.IdentifiersEmpty

  error.contact.ContactManagerNotExist


getContacts

Retrieves all the requested attributes on these contacts.
Parameters:

  contactIds  String[]
   The contact identifiers.

  retrieveAttributes  com.genesyslab.ail.ws.contact.ContactRetrieveAttribute[]
   The attribute values (primary or not) to retrieve. Null to retrieve all the primaries attribute values.

Returns:

  Type:  com.genesyslab.ail.ws.contact.ContactValue[]

   The values for each contact.

Errors:

  error.common.AilFactoryNotInitialized

  error.contact.IdentifiersEmpty

  error.contact.ContactManagerNotExist


getMergeDetail

Returns the details of the last merge action performed on the specified destination contact.
Parameters:

  contactId  String
   The contact identifier.

Returns:

  Type:  com.genesyslab.ail.ws.contact.ContactMergeDetail

   a ContactMergeDetail instance that contains source and destination information about the last merge action performed on this contact.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid

  error.common.RequestFailed

  error.common.DatabaseService

  error.history.HistoryManagerNoExist

  error.contact.ContactNotExist

  error.contact.ContactManagerNotExist


merge

Merges all the history from the source contact into the destination contact.
Parameters:

  destinationContactId  String
   The identifier of the destination contact (mandatory).

  sourceContactId  String
   The identifier of the source contact (mandatory).

  agentId  String
   The identifier of the agent who is responsible for this merge action (optional).

  reason  String
   The reason for this merge action (optional).

  description  String
   The description for this merge action (optional).

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid

  error.common.RequestFailed

  error.common.DatabaseService

  error.contact.ContactNotExist

  error.contact.ContactManagerNotExist


mergeContacts

Merges contacts together.
Parameters:

  forms  com.genesyslab.ail.ws.contact.ContactMergeForm[]
   The contact IDs To and From.

Returns:

  Type:  com.genesyslab.ail.ws.contact.ContactError[]

   The errors on each contact.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid
  

  error.common.RequestFailed
  

  error.common.DatabaseService
  

  error.contact.ContactNotExist
  

  error.contact.ContactManagerNotExist


removeContactAttributes

Removes the specified contacts' attributes.
Parameters:

  datas  com.genesyslab.ail.ws.contact.ContactAttributeRemove[]
   The attributes to remove for each contact.

Returns:

  Type:  com.genesyslab.ail.ws.contact.ContactError[]

   The errors on each contact.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid
  

  error.common.RequestFailed
  

  error.common.DatabaseService
  

  error.contact.ContactNotExist
  

  error.contact.AttributeNameInvalid
  

  error.contact.ContactManagerNotExist


removeContacts

Removes a list of contacts.
Parameters:

  contactIds  String[]
   The IDs of the contacts to remove.

Returns:

  Type:  com.genesyslab.ail.ws.contact.ContactError[]

   The errors on each contact.

Errors:

  error.common.AilFactoryNotInitialized

  error.contact.IdentifiersEmpty

  error.common.ParameterInvalid
  

  error.common.RequestFailed
  

  error.common.DatabaseService
  

  error.contact.ContactNotExist
  

  error.contact.ContactFactoryNotInitialized


searchContacts

Searches contacts from a template.
Parameters:

  searchTemplate  com.genesyslab.ail.ws.contact.ContactSearchTemplate
   The search template.

Returns:

  Type:  com.genesyslab.ail.ws.contact.ContactValue[]

   The values for each contact.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid

  error.common.RequestFailed

  error.common.DatabaseService

  error.contact.ContactManagerNotExist


setContactAttributes

Sets data on contacts with the given information .
Parameters:

  datas  com.genesyslab.ail.ws.contact.ContactValue[]
   The attributes to set on each contact.

  updateType  com.genesyslab.ail.ws.contact.ContactUpdateType
   The manner how the contact is updated.

  returnValues  boolean
   If true, the returned ContactResults contain the created contact attributes; otherwise, for each returned ContactResult, the ContactResult.attributes field is null.

Returns:

  Type:  com.genesyslab.ail.ws.contact.ContactResult[]

   The result on each contact.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid
  

  error.common.RequestFailed
  

  error.common.DatabaseService
  

  error.contact.ContactNotExist
  

  error.contact.AttributeNameInvalid
  

  error.contact.ContactManagerNotExist


undoMerge

Undoes the last merge action performed for the specified destination contact.
Parameters:

  contactId  String
   The contact identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid

  error.common.RequestFailed

  error.common.DatabaseService

  error.contact.ContactNotExist

  error.contact.ContactManagerNotExist


Event Detail

Interaction SDK
(Web Services)