|
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: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 |
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 |
String
String
void
String
void
String
String[]
void
String
String
String[]
com.genesyslab.ail.ws.interaction.InteractionDTO
String
String
String[]
com.genesyslab.ail.ws.interaction.InteractionDTO
String
String
void
String
void
String
String[]
com.genesyslab.ail.ws.interaction.InteractionDTO
String
String[]
com.genesyslab.ail.ws.interaction.InteractionDTO[]
String
void
String
String
boolean
void
String
String
void
String
String
void
String
void
String
String
void
String
String
boolean
String[]
com.genesyslab.ail.ws.interaction.InteractionDTO
String
String
boolean
boolean
String[]
com.genesyslab.ail.ws.interaction.InteractionDTO
String
String
String[]
com.genesyslab.ail.ws.interaction.InteractionDTO
String
String
void
String
com.genesyslab.ail.ws.interaction.mail.Participant[]
String
String
String[]
com.genesyslab.ail.ws.interaction.InteractionDTO[]
String
com.genesyslab.ail.ws.Attachment
boolean
String
String
String
void
String
String
String
void
String
com.genesyslab.ail.ws.interaction.mail.EmailAddress
String
void
String
com.genesyslab.ail.ws.interaction.mail.Participant[]
String
String
String[]
com.genesyslab.ail.ws.interaction.InteractionDTO[]
String
String
String
void
String
String
String
void
Event Detail |
|
Interaction SDK (Web Services) |
||||||||
PREV SERVICE NEXT SERVICE | FRAMES NO FRAMES | ||||||||
SUMMARY: ATTRIBUTE | METHOD | EVENT | DETAIL: ATTRIBUTE | METHOD | EVENT |