Interaction SDK
(Web Services)

Service: HistoryService


The history of a contact. The history contains, in a tree structure, all interactions that the contact had with this contact center. An interaction can have child interactions. For example, an agent's outgoing reply to an incoming email is the child of the incoming email.
Attribute Summary
com.genesyslab.ail.ws.history.HistoryItemDTO[] history:children
           The children of this item. Child interactions are interactions that reply to another interaction. For instance, an InteractionMailOut is a child of the InteractionMailIn to which it replies.
long history:dateCreated
           The date of creation of this item.
boolean history:done
           true, if this interaction is terminated. .
String history:interactionId
           The interaction identifier.
com.genesyslab.ail.ws.interaction.InteractionType history:interactionType
           The type of this interaction.
boolean history:isArchive
           true, if this item belongs to the archive history.
String history:mediaType
           The MediaType of this interaction.
String history:sender
           The sender of this interaction. If this is an incoming interaction, the name of the customer. If this is an outgoing interaction, the name of the agent who has processed this interaction. Can be empty for incoming e-mails; in this case, the sender is the contact.
String history:subject
           The subject of this interaction.

Method Summary
com.genesyslab.ail.ws.history.HistoryItemDTO[] getHistoryDTO
           Returns the history of this contact.
boolean isArchiveEnabled
           Returns true if Archive database is enable.

Event Summary

Attribute Detail

Attributes of domain history

History attributes definition


children

Type: com.genesyslab.ail.ws.history.HistoryItemDTO[]
The children of this item. Child interactions are interactions that reply to another interaction. For instance, an InteractionMailOut is a child of the InteractionMailIn to which it replies.
Properties: read read-default


dateCreated

Type: long
The date of creation of this item.
Properties: read read-default


done

Type: boolean
true, if this interaction is terminated. .
Properties: read read-default


interactionId

Type: String
The interaction identifier.
Properties: read read-default


interactionType

Type: com.genesyslab.ail.ws.interaction.InteractionType
The type of this interaction.
Properties: read read-default


isArchive

Type: boolean
true, if this item belongs to the archive history.
Properties: read read-default


mediaType

Type: String
The MediaType of this interaction.
Properties: read read-default


sender

Type: String
The sender of this interaction. If this is an incoming interaction, the name of the customer. If this is an outgoing interaction, the name of the agent who has processed this interaction. Can be empty for incoming e-mails; in this case, the sender is the contact.
Properties: read read-default


subject

Type: String
The subject of this interaction.
Properties: read read-default


Method Detail

getHistoryDTO

Returns the history of this contact.
Parameters:

  contactId  String
   The contact identifier.

  searchTemplate  com.genesyslab.ail.ws.history.InteractionSearchTemplate
   The search template.

  archive  boolean
   false for current history, true for archive history.

  attributes  String[]
   no description

Returns:

  Type:  com.genesyslab.ail.ws.history.HistoryItemDTO[]

   The keys of the attributes to retrieve for each history item (history.*:*).

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid

  error.common.RequestFailed

  error.common.DatabaseService

  error.history.ContactManagerNoExist

  error.history.HistoryManagerNoExist


isArchiveEnabled

Returns true if Archive database is enable.
Parameters:

Returns:

  Type:  boolean

   Returns true if Archive database is enable.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.history.HistoryManagerNoExist


Event Detail

Interaction SDK
(Web Services)