|
Interaction SDK (Web Services) |
||||||||
| PREV SERVICE NEXT SERVICE | FRAMES NO FRAMES | ||||||||
| SUMMARY: ATTRIBUTE | METHOD | EVENT | DETAIL: ATTRIBUTE | METHOD | EVENT | ||||||||
| Attribute Summary | |
com.genesyslab.ail.ws.interaction.mail.InteractionMailAction[] |
interaction.mail:actionsPossibleThe possible actions on this e-mail. |
com.genesyslab.ail.ws.interaction.SuggestedCategory[] |
interaction.mail:addSuggestedCategoriesAdds 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:attachmentsThe attached files of this e-mail. Write only on outgoing e-mails. |
String[] |
interaction.mail:availableQueuesForChildInteractionThe queues in which a child interaction can be created. This corresponds to the 'Output Queues' of the Interaction Workflow Designer (IWD). |
String[] |
interaction.mail:availableQueuesForThisInteractionThe queues where this interaction can be put. This corresponds to the 'Input Queues' of the Interaction Workflow Designer (IWD). |
String |
interaction.mail:categoryIdID of the category assigned to this interaction (by manual override at the desktop level). |
com.genesyslab.ail.ws.interaction.mail.EmailAddress[] |
interaction.mail:ccAddressesThe addresses that received a copy of this e-mail. |
com.genesyslab.ail.ws.interaction.mail.CollaborationStatus |
interaction.mail:collaborationStatusThe collaboration status of this interaction, if any. |
long |
interaction.mail:dateSentThe date time when the message was sent. This date time can be different from Interaction:dateCreated. |
String |
interaction.mail:externalIdExternal identifier that was assigned to this interaction. |
com.genesyslab.ail.ws.interaction.mail.EmailAddress |
interaction.mail:fromAddressThe address from which this e-mail was sent. Write only on outgoing e-mails |
boolean |
interaction.mail:hasAttachmentstrue if this e-mail has attached files. |
boolean |
interaction.mail:isCategoryApprovedTells 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:isMarkDoneAvailabletrue if this interaction can be stopped with no more processing. |
String |
interaction.mail:messageText |
byte[] |
interaction.mail:mimeMessageThe whole content of this e-mail as a message according the RFC 822 / MIME format. Deprecated, use interaction:contentBinary instead. |
String |
interaction.mail:queueThe 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:shortAttachmentsThe short form of the attachment without the data. |
String |
interaction.mail:structTextMimeTypeThe MIME type of the structuredText field. Must comply with rules described in RFC 2046. See MimeType domain definition for further information. |
String |
interaction.mail:structuredTextThe 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:suggestedCategoriesThe suggested categories for this e-mail as a list of SuggestedCategory. |
com.genesyslab.ail.ws.interaction.mail.EmailAddress[] |
interaction.mail:toAddressesThe addresses to which this e-mail was sent. |
String |
interaction.mail.in:currentReplyMailoutIdID of the current e-mail interaction replying to this e-mail, if any. |
com.genesyslab.ail.ws.interaction.mail.CustomData[] |
interaction.mail.in:customDataThe custom data associated with this incoming e-mail. |
com.genesyslab.ail.ws.interaction.mail.EmailAddress |
interaction.mail.in:externalAgentTransferAddressThe e-mail address of the external agent to whom this e-mail had been transferred. |
boolean |
interaction.mail.in:isEscalatedtrue 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:collaborativeReplyThe collaborative reply of this invitation (if any). |
com.genesyslab.ail.ws.Attachment[] |
interaction.mail.out:addAttachmentsAdds attached files. |
com.genesyslab.ail.ws.interaction.mail.EmailAddress[] |
interaction.mail.out:bccAddressesThe addresses to which copies of this e-mail will be silently sent. |
String[] |
interaction.mail.out:invitationsThe sent invitation identifiers for this outgoing e-mail. |
String |
interaction.mail.out:invitationSentIdIdentifier of a sent invitation for a collaboration on this outgoing e-mail. Available only when receiving an InvitationEvent. |
boolean |
interaction.mail.out:isQAReviewtrue if this interaction is submitted for QA review. |
String[] |
interaction.mail.out:removeAttachmentByIdsRemoves attached files. Attachment identifier list. |
String[] |
interaction.mail.out:removeAttachmentsRemoves attached files. Attachment filename list. Deprecated. |
com.genesyslab.ail.ws.interaction.mail.EmailAddress |
interaction.mail.out:replyToAddressThe reply-to address of this e-mail. |
| Method Summary | |
void |
acceptInvitationAccepts a collaboration invitation. |
void |
answerAnswers this interaction. |
void |
copyAttachmentsCopies the attachment instances that belong to another SRL or InteractionMailOut source into the given interaction. |
com.genesyslab.ail.ws.interaction.InteractionDTO |
createInteractionMailAgentDTOCreates a new outgoing e-mail interaction on an agent . |
com.genesyslab.ail.ws.interaction.InteractionDTO |
createInteractionMailPlaceDTOCreates a new outgoing e-mail interaction on a place. |
void |
declineInvitationDeclines a collaboration invitation. |
void |
deleteDeletes this interaction. |
com.genesyslab.ail.ws.interaction.InteractionDTO |
getCollaborativeReplyDTOGets the collaborative reply (if any) to a sent invitation. |
com.genesyslab.ail.ws.interaction.InteractionDTO[] |
getSentInvitationsDTOGets all sent parent invitations for this outgoing e-mail interaction. |
void |
markDoneMarks this interaction as done. |
void |
mergeMoves 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 |
placeInQueuePlaces an interaction into a queue. |
void |
recallInvitationRecalls the invitation from a pending participant. This is a parent action only available if the invitation is in status ACCEPTANCE_PENDING or ACCEPTED. |
void |
releaseReleases this interaction. |
void |
remindInvitationReminds 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 |
replyDTOCreates a reply to an incoming e-mail. |
com.genesyslab.ail.ws.interaction.InteractionDTO |
replyExDTOCreates a reply to an incoming e-mail. |
com.genesyslab.ail.ws.interaction.InteractionDTO |
replyInvitationDTOCreates an outgoing collaboration interaction which replies to the incoming collaboration invitation. |
void |
sendSends this outgoing e-mail and releases this interaction. |
com.genesyslab.ail.ws.interaction.InteractionDTO[] |
sendInvitationsSends 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 |
setAttachmentSets an attached file to this outgoing e-mail interaction. |
void |
submitSubmits this interaction to the Interaction Server.. |
void |
transferAgentTransfers an interaction on another agent. |
void |
transferExternalAgentForwards 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[] |
transferInvitationsSends 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 |
transferPlaceTransfers an interaction on a place. |
void |
transferQueueTransfers an interaction on a queue. |
| Event Summary | |
InvitationEventInvitation event |
|
| Attribute Detail |
| Attributes of domain interaction.mail |
Type: com.genesyslab.ail.ws.interaction.mail.InteractionMailAction[]
Type: com.genesyslab.ail.ws.interaction.SuggestedCategory[]
Type: com.genesyslab.ail.ws.Attachment[]
Type: String[]
Type: String[]
Type: String
Type: com.genesyslab.ail.ws.interaction.mail.EmailAddress[]
Type: com.genesyslab.ail.ws.interaction.mail.CollaborationStatus
Type: long
Type: String
Type: com.genesyslab.ail.ws.interaction.mail.EmailAddress
Type: boolean
Type: boolean
Type: boolean
Type: String
Type: byte[]
Type: String
Type: com.genesyslab.ail.ws.ShortAttachment[]
Type: String
Type: String
Type: com.genesyslab.ail.ws.interaction.SuggestedCategory[]
Type: com.genesyslab.ail.ws.interaction.mail.EmailAddress[]
| Attributes of domain interaction.mail.in |
Type: String
Type: com.genesyslab.ail.ws.interaction.mail.CustomData[]
Type: com.genesyslab.ail.ws.interaction.mail.EmailAddress
Type: boolean
| Attributes of domain interaction.mail.in.collaboration |
Type: String
| Attributes of domain interaction.mail.out |
Type: com.genesyslab.ail.ws.Attachment[]
Type: com.genesyslab.ail.ws.interaction.mail.EmailAddress[]
Type: String[]
Type: String
Type: boolean
Type: String[]
Type: String[]
Type: com.genesyslab.ail.ws.interaction.mail.EmailAddress
| Method Detail |
StringStringvoidStringvoidStringString[]voidStringStringString[]com.genesyslab.ail.ws.interaction.InteractionDTOStringStringString[]com.genesyslab.ail.ws.interaction.InteractionDTOStringStringvoidStringvoidStringString[]com.genesyslab.ail.ws.interaction.InteractionDTOStringString[]com.genesyslab.ail.ws.interaction.InteractionDTO[]StringvoidStringStringbooleanvoidStringStringvoidStringStringvoidStringvoidStringStringvoidStringStringbooleanString[]com.genesyslab.ail.ws.interaction.InteractionDTOStringStringbooleanbooleanString[]com.genesyslab.ail.ws.interaction.InteractionDTOStringStringString[]com.genesyslab.ail.ws.interaction.InteractionDTOStringStringvoidStringcom.genesyslab.ail.ws.interaction.mail.Participant[]StringStringString[]com.genesyslab.ail.ws.interaction.InteractionDTO[]Stringcom.genesyslab.ail.ws.AttachmentbooleanStringStringStringvoidStringStringStringvoidStringcom.genesyslab.ail.ws.interaction.mail.EmailAddressStringvoidStringcom.genesyslab.ail.ws.interaction.mail.Participant[]StringStringString[]com.genesyslab.ail.ws.interaction.InteractionDTO[]StringStringStringvoidStringStringStringvoid| Event Detail |
|
Interaction SDK (Web Services) |
||||||||
| PREV SERVICE NEXT SERVICE | FRAMES NO FRAMES | ||||||||
| SUMMARY: ATTRIBUTE | METHOD | EVENT | DETAIL: ATTRIBUTE | METHOD | EVENT | ||||||||