Interaction SDK
(Web Services)

Service: InteractionMailService


This service manages actions on e-mails exchanged between a customer and the Call Center. An InteractionMailIn is an e-mail received by the Call Center, and an InteractionMailOut is an e-mail sent by the Call Center.
Attribute Summary
com.genesyslab.ail.ws.interaction.mail.InteractionMailAction[] interaction.mail:actionsPossible
           The possible actions on this e-mail.
com.genesyslab.ail.ws.interaction.SuggestedCategory[] interaction.mail:addSuggestedCategories
           Adds or updates the suggested categories for this e-mail. If none of the interaction's suggested categories is satisfactory, and if the agent uses another category's response, add the corresponding category ID with a null relevancy using this attribute. Then, assign the corresponding category ID using the categoryID attribute and approve it using the isCategoryApproved attribute to provide the appropriate feedback.
com.genesyslab.ail.ws.Attachment[] interaction.mail:attachments
           The attached files of this e-mail. Write only on outgoing e-mails.
String[] interaction.mail:availableQueuesForChildInteraction
           The queues in which a child interaction can be created. This corresponds to the 'Output Queues' of the Interaction Workflow Designer (IWD).
String[] interaction.mail:availableQueuesForThisInteraction
           The queues where this interaction can be put. This corresponds to the 'Input Queues' of the Interaction Workflow Designer (IWD).
String interaction.mail:categoryId
           ID of the category assigned to this interaction (by manual override at the desktop level).
com.genesyslab.ail.ws.interaction.mail.EmailAddress[] interaction.mail:ccAddresses
           The addresses that received a copy of this e-mail.
com.genesyslab.ail.ws.interaction.mail.CollaborationStatus interaction.mail:collaborationStatus
           The collaboration status of this interaction, if any.
long interaction.mail:dateSent
           The date time when the message was sent. This date time can be different from Interaction:dateCreated.
String interaction.mail:externalId
           External identifier that was assigned to this interaction.
com.genesyslab.ail.ws.interaction.mail.EmailAddress interaction.mail:fromAddress
           The address from which this e-mail was sent. Write only on outgoing e-mails
boolean interaction.mail:hasAttachments
           true if this e-mail has attached files.
boolean interaction.mail:isCategoryApproved
           Tells whether an agent has approved or disapproved the category that was suggested by Classification Server. If null, no agent has given a feedback on the suggested category. If true, an agent has approved it. If false, an agent has disapproved it.
boolean interaction.mail:isMarkDoneAvailable
           true if this interaction can be stopped with no more processing.
String interaction.mail:messageText
          
byte[] interaction.mail:mimeMessage
           The whole content of this e-mail as a message according the RFC 822 / MIME format. Deprecated, use interaction:contentBinary instead.
String interaction.mail:queue
           The queue of this interaction. Note that an interaction still is in the queue even when it is handled by an agent or a router.
com.genesyslab.ail.ws.ShortAttachment[] interaction.mail:shortAttachments
           The short form of the attachment without the data.
String interaction.mail:structTextMimeType
           The MIME type of the structuredText field. Must comply with rules described in RFC 2046. See MimeType domain definition for further information.
String interaction.mail:structuredText
           The structured text of the interaction. It allows easy access to the structured interaction information. For an e-mail whose body is HTML-formatted, the structured text is the HTML body. For a chat transcript, the structured text is some formatted version of the transcript.
com.genesyslab.ail.ws.interaction.SuggestedCategory[] interaction.mail:suggestedCategories
           The suggested categories for this e-mail as a list of SuggestedCategory.
com.genesyslab.ail.ws.interaction.mail.EmailAddress[] interaction.mail:toAddresses
           The addresses to which this e-mail was sent.
String interaction.mail.in:currentReplyMailoutId
           ID of the current e-mail interaction replying to this e-mail, if any.
com.genesyslab.ail.ws.interaction.mail.CustomData[] interaction.mail.in:customData
           The custom data associated with this incoming e-mail.
com.genesyslab.ail.ws.interaction.mail.EmailAddress interaction.mail.in:externalAgentTransferAddress
           The e-mail address of the external agent to whom this e-mail had been transferred.
boolean interaction.mail.in:isEscalated
           true if this e-mail was escalated. If an e-mail has been transferred to an external agent and is routed back to an internal agent, this e-mail is considered as being escalated until it is replied to, marked done, or deleted by an internal agent.
String interaction.mail.in.collaboration:collaborativeReply
           The collaborative reply of this invitation (if any).
com.genesyslab.ail.ws.Attachment[] interaction.mail.out:addAttachments
           Adds attached files.
com.genesyslab.ail.ws.interaction.mail.EmailAddress[] interaction.mail.out:bccAddresses
           The addresses to which copies of this e-mail will be silently sent.
String[] interaction.mail.out:invitations
           The sent invitation identifiers for this outgoing e-mail.
String interaction.mail.out:invitationSentId
           Identifier of a sent invitation for a collaboration on this outgoing e-mail. Available only when receiving an InvitationEvent.
boolean interaction.mail.out:isQAReview
           true if this interaction is submitted for QA review.
String[] interaction.mail.out:removeAttachmentByIds
           Removes attached files. Attachment identifier list.
String[] interaction.mail.out:removeAttachments
           Removes attached files. Attachment filename list. Deprecated.
com.genesyslab.ail.ws.interaction.mail.EmailAddress interaction.mail.out:replyToAddress
           The reply-to address of this e-mail.

Method Summary
void acceptInvitation
           Accepts a collaboration invitation.
void answer
           Answers this interaction.
void copyAttachments
           Copies the attachment instances that belong to another SRL or InteractionMailOut source into the given interaction.
com.genesyslab.ail.ws.interaction.InteractionDTO createInteractionMailAgentDTO
           Creates a new outgoing e-mail interaction on an agent .
com.genesyslab.ail.ws.interaction.InteractionDTO createInteractionMailPlaceDTO
           Creates a new outgoing e-mail interaction on a place.
void declineInvitation
           Declines a collaboration invitation.
void delete
           Deletes this interaction.
com.genesyslab.ail.ws.interaction.InteractionDTO getCollaborativeReplyDTO
           Gets the collaborative reply (if any) to a sent invitation.
com.genesyslab.ail.ws.interaction.InteractionDTO[] getSentInvitationsDTO
           Gets all sent parent invitations for this outgoing e-mail interaction.
void markDone
           Marks this interaction as done.
void merge
           Moves this interaction into the history of another contact. This is useful if an agent discovers that the interaction has been assigned to the wrong contact, or that this interaction is duplicated elsewhere in the contact database. This method allows the agent to merge this interaction into the history of the correct contact, or to similarly merge all interactions that were mistakenly applied to this contact.
void placeInQueue
           Places an interaction into a queue.
void recallInvitation
           Recalls the invitation from a pending participant. This is a parent action only available if the invitation is in status ACCEPTANCE_PENDING or ACCEPTED.
void release
           Releases this interaction.
void remindInvitation
           Reminds the invitation to a pending participant. This is a parent action only available if the invitation is in status ACCEPTANCE_PENDING or ACCEPTED.
com.genesyslab.ail.ws.interaction.InteractionDTO replyDTO
           Creates a reply to an incoming e-mail.
com.genesyslab.ail.ws.interaction.InteractionDTO replyExDTO
           Creates a reply to an incoming e-mail.
com.genesyslab.ail.ws.interaction.InteractionDTO replyInvitationDTO
           Creates an outgoing collaboration interaction which replies to the incoming collaboration invitation.
void send
           Sends this outgoing e-mail and releases this interaction.
com.genesyslab.ail.ws.interaction.InteractionDTO[] sendInvitations
           Sends or places InteractionInvitationIns into workbin or queue according to the type of the Participant: if Agent type: the invitation in is put into agent's workbin (pull method to put invitations into child collaboration workbin); if Queue type: the invitation in is placed into the defined queue. Use transferInvitations() method to push invitations in.
String setAttachment
           Sets an attached file to this outgoing e-mail interaction.
void submit
           Submits this interaction to the Interaction Server..
void transferAgent
           Transfers an interaction on another agent.
void transferExternalAgent
           Forwards an incoming e-mail to an external agent. This method must be used after an agent has taken a pending external agent e-mail, and the agent finally does not want to do reply, nor to mark it done, but wants to let it pending on the external agent.
com.genesyslab.ail.ws.interaction.InteractionDTO[] transferInvitations
           Sends or places InteractionInvitationIns into workbin or queue according to the type of the Participant: if Agent type: the invitation in is transferred to this agent (push method to transfer into child agent desktop).
void transferPlace
           Transfers an interaction on a place.
void transferQueue
           Transfers an interaction on a queue.

Event Summary
InvitationEvent
           Invitation event

Attribute Detail

Attributes of domain interaction.mail

Mail interaction attributes definition


actionsPossible

Type: com.genesyslab.ail.ws.interaction.mail.InteractionMailAction[]
The possible actions on this e-mail.
Properties: read event


addSuggestedCategories

Type: com.genesyslab.ail.ws.interaction.SuggestedCategory[]
Adds or updates the suggested categories for this e-mail. If none of the interaction's suggested categories is satisfactory, and if the agent uses another category's response, add the corresponding category ID with a null relevancy using this attribute. Then, assign the corresponding category ID using the categoryID attribute and approve it using the isCategoryApproved attribute to provide the appropriate feedback.
Properties: write


attachments

Type: com.genesyslab.ail.ws.Attachment[]
The attached files of this e-mail. Write only on outgoing e-mails.
Properties: read write event


availableQueuesForChildInteraction

Type: String[]
The queues in which a child interaction can be created. This corresponds to the 'Output Queues' of the Interaction Workflow Designer (IWD).
Properties: read event


availableQueuesForThisInteraction

Type: String[]
The queues where this interaction can be put. This corresponds to the 'Input Queues' of the Interaction Workflow Designer (IWD).
Properties: read event


categoryId

Type: String
ID of the category assigned to this interaction (by manual override at the desktop level).
Properties: read write event


ccAddresses

Type: com.genesyslab.ail.ws.interaction.mail.EmailAddress[]
The addresses that received a copy of this e-mail.
Properties: read read-default write event


collaborationStatus

Type: com.genesyslab.ail.ws.interaction.mail.CollaborationStatus
The collaboration status of this interaction, if any.
Properties: read event


dateSent

Type: long
The date time when the message was sent. This date time can be different from Interaction:dateCreated.
Properties: read read-default event


externalId

Type: String
External identifier that was assigned to this interaction.
Properties: read write event


fromAddress

Type: com.genesyslab.ail.ws.interaction.mail.EmailAddress
The address from which this e-mail was sent. Write only on outgoing e-mails
Properties: read read-default write event


hasAttachments

Type: boolean
true if this e-mail has attached files.
Properties: read read-default event


isCategoryApproved

Type: boolean
Tells whether an agent has approved or disapproved the category that was suggested by Classification Server. If null, no agent has given a feedback on the suggested category. If true, an agent has approved it. If false, an agent has disapproved it.
Properties: read write event


isMarkDoneAvailable

Type: boolean
true if this interaction can be stopped with no more processing.
Properties: read event


messageText

Type: String
Properties: read read-default write event


mimeMessage

Type: byte[]
The whole content of this e-mail as a message according the RFC 822 / MIME format. Deprecated, use interaction:contentBinary instead.
Properties: read


queue

Type: String
The queue of this interaction. Note that an interaction still is in the queue even when it is handled by an agent or a router.
Properties: read read-default event


shortAttachments

Type: com.genesyslab.ail.ws.ShortAttachment[]
The short form of the attachment without the data.
Properties: read event


structTextMimeType

Type: String
The MIME type of the structuredText field. Must comply with rules described in RFC 2046. See MimeType domain definition for further information.
Properties: read write event


structuredText

Type: String
The structured text of the interaction. It allows easy access to the structured interaction information. For an e-mail whose body is HTML-formatted, the structured text is the HTML body. For a chat transcript, the structured text is some formatted version of the transcript.
Properties: read write event


suggestedCategories

Type: com.genesyslab.ail.ws.interaction.SuggestedCategory[]
The suggested categories for this e-mail as a list of SuggestedCategory.
Properties: read event


toAddresses

Type: com.genesyslab.ail.ws.interaction.mail.EmailAddress[]
The addresses to which this e-mail was sent.
Properties: read read-default write event


Attributes of domain interaction.mail.in

Incoming e-mail interaction attributes definition


currentReplyMailoutId

Type: String
ID of the current e-mail interaction replying to this e-mail, if any.
Properties: read read-default event


customData

Type: com.genesyslab.ail.ws.interaction.mail.CustomData[]
The custom data associated with this incoming e-mail.
Properties: read event


externalAgentTransferAddress

Type: com.genesyslab.ail.ws.interaction.mail.EmailAddress
The e-mail address of the external agent to whom this e-mail had been transferred.
Properties: read event


isEscalated

Type: boolean
true if this e-mail was escalated. If an e-mail has been transferred to an external agent and is routed back to an internal agent, this e-mail is considered as being escalated until it is replied to, marked done, or deleted by an internal agent.
Properties: read event


Attributes of domain interaction.mail.in.collaboration

Collaboration Incoming interaction attributes definition


collaborativeReply

Type: String
The collaborative reply of this invitation (if any).
Properties: read read-default event


Attributes of domain interaction.mail.out

Outgoing e-mail interaction attributes definition


addAttachments

Type: com.genesyslab.ail.ws.Attachment[]
Adds attached files.
Properties: write


bccAddresses

Type: com.genesyslab.ail.ws.interaction.mail.EmailAddress[]
The addresses to which copies of this e-mail will be silently sent.
Properties: read read-default write event


invitations

Type: String[]
The sent invitation identifiers for this outgoing e-mail.
Properties: read event


invitationSentId

Type: String
Identifier of a sent invitation for a collaboration on this outgoing e-mail. Available only when receiving an InvitationEvent.
Properties: event


isQAReview

Type: boolean
true if this interaction is submitted for QA review.
Properties: read event


removeAttachmentByIds

Type: String[]
Removes attached files. Attachment identifier list.
Properties: write


removeAttachments

Type: String[]
Removes attached files. Attachment filename list. Deprecated.
Properties: write


replyToAddress

Type: com.genesyslab.ail.ws.interaction.mail.EmailAddress
The reply-to address of this e-mail.
Properties: read read-default write event


Method Detail

acceptInvitation

Accepts a collaboration invitation.
Parameters:

  interactionId  String
   The incoming invitation interaction identifier.

  placeId  String
   The place identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.interaction.BadInteractionId

  error.interaction.BadInteractionType


answer

Answers this interaction.
Parameters:

  interactionId  String
   The interaction identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


copyAttachments

Copies the attachment instances that belong to another SRL or InteractionMailOut source into the given interaction.
Parameters:

  interactionId  String
   The interaction identifier.

  attachmentIds  String[]
   The attachments identifiers.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.interaction.BadInteractionType

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


createInteractionMailAgentDTO

Creates a new outgoing e-mail interaction on an agent .
Parameters:

  agentId  String
   The agent identifier.

  queue  String
   The queue on which this interaction must be created.

  attributes  String[]
   The attributes to retrieve (interaction.**:*).

Returns:

  Type:  com.genesyslab.ail.ws.interaction.InteractionDTO

   The attributes of the new outgoing e-mail interaction.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.interaction.BadAgentId

  error.interaction.NotAnAgent

  error.interaction.CannotCreateInteraction

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


createInteractionMailPlaceDTO

Creates a new outgoing e-mail interaction on a place.
Parameters:

  placeId  String
   The place identifier.

  queue  String
   The queue on which this interaction must be created.

  attributes  String[]
   The attributes to retrieve (interaction.**:*).

Returns:

  Type:  com.genesyslab.ail.ws.interaction.InteractionDTO

   The attributes of the new outgoing e-mail interaction.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.interaction.BadPlaceId

  error.interaction.CannotCreateInteraction

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


declineInvitation

Declines a collaboration invitation.
Parameters:

  interactionId  String
   The incoming invitation interaction identifier.

  placeId  String
   The place identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.interaction.BadInteractionId

  error.interaction.BadInteractionType

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


delete

Deletes this interaction.
Parameters:

  interactionId  String
   The interaction identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId


getCollaborativeReplyDTO

Gets the collaborative reply (if any) to a sent invitation.
Parameters:

  interactionId  String
   The parent invitation interaction identifier.

  attributes  String[]
   The attributes to retrieve (interaction.**:*).

Returns:

  Type:  com.genesyslab.ail.ws.interaction.InteractionDTO

   The attributes of the collaborative reply interaction.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.interaction.BadInteractionId

  error.interaction.BadInteractionType

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


getSentInvitationsDTO

Gets all sent parent invitations for this outgoing e-mail interaction.
Parameters:

  interactionId  String
   The outgoing e-mail interaction identifier.

  attributes  String[]
   The attributes to retrieve (interaction.**:*).

Returns:

  Type:  com.genesyslab.ail.ws.interaction.InteractionDTO[]

   The attributes of the collaboration invitation interactions.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.interaction.BadInteractionId

  error.interaction.BadInteractionType

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


markDone

Marks this interaction as done.
Parameters:

  interactionId  String
   The interaction identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.interaction.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


merge

Moves this interaction into the history of another contact. This is useful if an agent discovers that the interaction has been assigned to the wrong contact, or that this interaction is duplicated elsewhere in the contact database. This method allows the agent to merge this interaction into the history of the correct contact, or to similarly merge all interactions that were mistakenly applied to this contact.
Parameters:

  interactionId  String
   The interaction identifier.

  contactId  String
   The contact into whose history this interaction must be merged

  all  boolean
   If true, also merges all the interactions of the same contact.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId


placeInQueue

Places an interaction into a queue.
Parameters:

  interactionId  String
   The interaction identifier.

  queue  String
   The queue.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


recallInvitation

Recalls the invitation from a pending participant. This is a parent action only available if the invitation is in status ACCEPTANCE_PENDING or ACCEPTED.
Parameters:

  interactionId  String
   The parent collaboration invitation identifier.

  placeId  String
   The place identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.interaction.BadInteractionId

  error.interaction.BadInteractionType

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


release

Releases this interaction.
Parameters:

  interactionId  String
   The interaction identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


remindInvitation

Reminds the invitation to a pending participant. This is a parent action only available if the invitation is in status ACCEPTANCE_PENDING or ACCEPTED.
Parameters:

  interactionId  String
   The parent collaboration invitation identifier.

  placeId  String
   The place identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.interaction.BadInteractionId

  error.interaction.BadInteractionType

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


replyDTO

Creates a reply to an incoming e-mail.
Parameters:

  interactionId  String
   The interaction identifier.

  queue  String
   The queue into which the reply will be submitted.

  reply_all  boolean
   If true, all the recipients of the original e-mail are added in the 'To' field of the the replying e-mail.

  attributes  String[]
   The attributes to retrieve (interaction.**:*).

Returns:

  Type:  com.genesyslab.ail.ws.interaction.InteractionDTO

   The attributes of the replying interaction.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.interaction.BadInteractionType

  error.interaction.CannotCreateInteraction

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


replyExDTO

Creates a reply to an incoming e-mail.
Parameters:

  interactionId  String
   The interaction identifier.

  queue  String
   The queue into which the reply will be submitted.

  reply_all  boolean
   If true, all the recipients of the original e-mail are added in the 'To' field of the the replying e-mail.

  mark_done  boolean
   If true, marks done the inbound e-mail interaction.

  attributes  String[]
   The attributes to retrieve (interaction.**:*).

Returns:

  Type:  com.genesyslab.ail.ws.interaction.InteractionDTO

   The attributes of the replying interaction.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.interaction.BadInteractionType

  error.interaction.CannotCreateInteraction

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


replyInvitationDTO

Creates an outgoing collaboration interaction which replies to the incoming collaboration invitation.
Parameters:

  interactionId  String
   The identifier of the invitation interaction.

  placeId  String
   The place identifier.

  attributes  String[]
   The attributes to retrieve (interaction.**:*).

Returns:

  Type:  com.genesyslab.ail.ws.interaction.InteractionDTO

   The attributes of the new outgoing collaboration interaction.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.interaction.BadInteractionId

  error.interaction.BadInteractionType

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


send

Sends this outgoing e-mail and releases this interaction.
Parameters:

  interactionId  String
   The interaction identifier.

  queue  String
   The queue through which this email must be sent.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.interaction.BadInteractionType

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


sendInvitations

Sends or places InteractionInvitationIns into workbin or queue according to the type of the Participant: if Agent type: the invitation in is put into agent's workbin (pull method to put invitations into child collaboration workbin); if Queue type: the invitation in is placed into the defined queue. Use transferInvitations() method to push invitations in.
Parameters:

  interactionId  String
   The outgoing e-mail interaction identifier.

  participants  com.genesyslab.ail.ws.interaction.mail.Participant[]
   The participants in this collaboration session.

  text  String
   The text input of the agent requesting the collaboration.

  subject  String
   The subject of this invitation. If null, the subject is the outgoing e-mail interaction's subject.

  attributes  String[]
   The attributes to retrieve (interaction.**:*).

Returns:

  Type:  com.genesyslab.ail.ws.interaction.InteractionDTO[]

   The attributes of the collaboration invitation interactions.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.interaction.BadDnId

  error.interaction.CannotCreateInteraction

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


setAttachment

Sets an attached file to this outgoing e-mail interaction.
Parameters:

  interactionId  String
   The interaction identifier.

  attachment  com.genesyslab.ail.ws.Attachment
   The attachment to set.

  addIfNotExists  boolean
   If false, modify the attachment fields regarding the attachment identifier. If true, add a new attachement if the attachment identifier is null or does not match to an existing one, otherwise modify the attachment fields regarding the attachment identifier.

Returns:

  Type:  String

   the Attachment identifier or null if cannot sets the attachment.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.interaction.BadInteractionType

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


submit

Submits this interaction to the Interaction Server..
Parameters:

  interactionId  String
   The interaction identifier.

  queue  String
   the queue where the interaction will be placed in.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


transferAgent

Transfers an interaction on another agent.
Parameters:

  interactionId  String
   The interaction identifier.

  agentId  String
   The Agent identifier.

  reason  String
   The transfer reason.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


transferExternalAgent

Forwards an incoming e-mail to an external agent. This method must be used after an agent has taken a pending external agent e-mail, and the agent finally does not want to do reply, nor to mark it done, but wants to let it pending on the external agent.
Parameters:

  interactionId  String
   The interaction identifier.

  externalAgentEmailn  com.genesyslab.ail.ws.interaction.mail.EmailAddress
   The e-mail address of the external agent.

  queue  String
   The queue.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.interaction.BadInteractionType

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


transferInvitations

Sends or places InteractionInvitationIns into workbin or queue according to the type of the Participant: if Agent type: the invitation in is transferred to this agent (push method to transfer into child agent desktop).
Parameters:

  interactionId  String
   The outgoing e-mail interaction identifier.

  participants  com.genesyslab.ail.ws.interaction.mail.Participant[]
   The participants in this collaboration session.

  text  String
   The text input of the agent requesting the collaboration.

  subject  String
   The subject of this invitation. If null, the subject is the outgoing e-mail interaction's subject.

  attributes  String[]
   The attributes to retrieve (interaction.**:*).

Returns:

  Type:  com.genesyslab.ail.ws.interaction.InteractionDTO[]

   The attributes of the collaboration invitation interactions.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.interaction.BadDnId

  error.interaction.CannotCreateInteraction

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


transferPlace

Transfers an interaction on a place.
Parameters:

  interactionId  String
   The interaction identifier.

  placeId  String
   The place identifier.

  reason  String
   The transfer reason.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


transferQueue

Transfers an interaction on a queue.
Parameters:

  interactionId  String
   The interaction identifier.

  queue  String
   The queue to transfer.

  reason  String
   The transfer reason.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


Event Detail

InvitationEvent

Invitation event
Available attributes:  interaction.mail.out:invitationSentId when an invitation is sent.

Filters:

Triggers:

  Key: AGENT   Value: agentId  -  Subscribes on this agent

  Key: PLACE   Value: placeId  -  Subscribes on this place


Interaction SDK
(Web Services)