|
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.chat.InteractionChatAction[] |
interaction.chat:actionsPossibleThe possible actions on the chat interaction. |
com.genesyslab.ail.ws.interaction.SuggestedCategory[] |
interaction.chat:addSuggestedCategoriesAdds or updates the suggested categories for this chat. |
String[] |
interaction.chat:availableQueuesForChildInteractionThe queues in which a child interaction can be created. This corresponds to the 'Output Queues' of the Interaction Workflow Designer (IWD). |
String[] |
interaction.chat:availableQueuesForThisInteractionThe queues where this interaction can be put. This corresponds to the 'Input Queues' of the Interaction Workflow Designer (IWD). |
String |
interaction.chat:categoryIdID of the category assigned to this interaction (by manual override at the desktop level). |
String |
interaction.chat:cobrowseIdPartyThe CoBrowse id party, or null if there is no CoBrowse party. |
long |
interaction.chat:durationThe duration of this chat session in seconds. |
com.genesyslab.ail.ws.interaction.chat.ChatEvent[] |
interaction.chat:eventsEvents received since the beginning of the chat session. |
com.genesyslab.ail.ws.interaction.chat.ChatEventType |
interaction.chat:eventTypeThe chat event type. |
String |
interaction.chat:externalIdExternal identifier that was assigned to this interaction. |
boolean |
interaction.chat:isCategoryApprovedTells whether an agent has approved or disapproved the category ID assigned to the interaction. 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. Note: if false and if the assigned category has the max relevancy of the suggested categories, all the suggested categories are disapproved. |
boolean |
interaction.chat:isMarkDoneAvailabletrue if this interaction can be stopped with no more processing. |
boolean |
interaction.chat:isOnLinetrue if the chat interaction has a corresponding session in the Chat Server. |
com.genesyslab.ail.ws.interaction.chat.ChatMessage |
interaction.chat:messageEventThe message received on a chat event. Note: This attribute is only received when subscribing to ChatEvent and a message is received |
com.genesyslab.ail.ws.interaction.chat.ChatMessage[] |
interaction.chat:messagesAll the messages exchanged from the beginning of the session or null if no message. |
String |
interaction.chat:nicknameNickname of the agent. Your application has to write this attribute value before answering, otherwise the nickname is the username of the agent. |
com.genesyslab.ail.ws.interaction.chat.ChatParty[] |
interaction.chat:partiesAll the known parties on this chat session. |
com.genesyslab.ail.ws.interaction.chat.ChatParty |
interaction.chat:partyEventThe party on a chat event. Note: This attribute is only received when a party joined or left the chat session. |
com.genesyslab.ail.ws.interaction.chat.ChatPartyType |
interaction.chat:partyTypeThe chat party type. |
String |
interaction.chat:pushURLpushed URL |
String |
interaction.chat: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. |
String |
interaction.chat:structTextMimeTypeThe MIME type of the structuredText field. Must comply with rules described in RFC 2046. See MimeType domain definition for further information. |
String |
interaction.chat: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.chat:suggestedCategoriesThe suggested categories for this chat as a list of SuggestedCategory. |
com.genesyslab.ail.ws.interaction.chat.ChatPartyVisibility |
interaction.chat:visibilityThe visibility of the agent. Your application has to write this attribute value before answering to specify the join mode, or once the agent has joined to change the agent visibility. |
| Method Summary | |
void |
answerAnswers this interaction. |
void |
answerExtendedAnswers this interaction with extended parameters. |
void |
clearDisconnects from the Chat Server in after_action mode 'ForceClose' or 'CloseIfNoAgents'. To disconnect in after_action mode 'KeepAlive' , use release method. |
void |
conferenceAgentRequests an agent or supervisor to join the chat session. If failure, the initiator will receive an Error InteractionEvent containing error description in extensions. If success, the invited agent will receive a RINGING InteractionEvent containing in extensions: RINGING_CONFERENCED = initiator, RINGING_CONFERENCE_REASON = reason, RINGING_CONFERENCE_VISIBILITY = ChatPartyVisibility |
void |
conferencePlaceRequests an agent or supervisor to join the chat session. If failure, the initiator will receive an Error InteractionEvent containing error description in extensions. If success, the invited agent will receive a RINGING InteractionEvent containing in extensions: RINGING_CONFERENCED = initiator, RINGING_CONFERENCE_REASON = reason, RINGING_CONFERENCE_VISIBILITY = ChatPartyVisibility |
void |
deleteDeletes this 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 |
pushURLPushes a URL to participants in the specified chat interaction |
void |
releaseReleases this interaction. |
void |
sendMessageSends a chat message to all the parties. |
void |
startTypingSends a startTyping message to participants in the specified chat interaction |
void |
stopTypingSends a stopTyping message to participants in the specified chat interaction |
void |
transferAgentTransfers an interaction on another agent. |
void |
transferPlaceTransfers an interaction on a place. |
void |
transferQueueTransfers an interaction on a queue. |
| Event Summary | |
ChatEventChat event |
|
| Attribute Detail |
| Attributes of domain interaction.chat |
Type: com.genesyslab.ail.ws.interaction.chat.InteractionChatAction[]
Type: com.genesyslab.ail.ws.interaction.SuggestedCategory[]
Type: String[]
Type: String[]
Type: String
Type: String
Type: long
Type: com.genesyslab.ail.ws.interaction.chat.ChatEvent[]
Type: com.genesyslab.ail.ws.interaction.chat.ChatEventType
Type: String
Type: boolean
Type: boolean
Type: boolean
Type: com.genesyslab.ail.ws.interaction.chat.ChatMessage
Type: com.genesyslab.ail.ws.interaction.chat.ChatMessage[]
Type: String
Type: com.genesyslab.ail.ws.interaction.chat.ChatParty[]
Type: com.genesyslab.ail.ws.interaction.chat.ChatParty
Type: com.genesyslab.ail.ws.interaction.chat.ChatPartyType
Type: String
Type: String
Type: String
Type: String
Type: com.genesyslab.ail.ws.interaction.SuggestedCategory[]
Type: com.genesyslab.ail.ws.interaction.chat.ChatPartyVisibility
| Method Detail |
StringvoidStringStringcom.genesyslab.ail.ws.interaction.chat.ChatPartyTypecom.genesyslab.ail.ws.interaction.chat.ChatPartyVisibilityvoidStringbooleanvoidStringStringcom.genesyslab.ail.ws.interaction.chat.ChatPartyVisibilityStringvoidStringStringcom.genesyslab.ail.ws.interaction.chat.ChatPartyVisibilityStringvoidStringvoidStringvoidStringStringbooleanvoidStringStringvoidStringStringvoidStringvoidStringStringvoidStringvoidStringvoidStringStringStringvoidStringStringStringvoidStringStringStringvoid| Event Detail |
|
Interaction SDK (Web Services) |
||||||||
| PREV SERVICE NEXT SERVICE | FRAMES NO FRAMES | ||||||||
| SUMMARY: ATTRIBUTE | METHOD | EVENT | DETAIL: ATTRIBUTE | METHOD | EVENT | ||||||||