Interaction SDK
(Web Services)

com.genesyslab.ail.ws.interaction.chat

Class Summary
ChatEvent This class describes a chat event. If this event occurred due to a chat message, this class contains the chat message.
ChatMessage This class describes a chat message.
ChatParty This class describes a chat party.

Enum Summary
InteractionChatAction This enum lists the possible actions on a chat interaction.
ChatEventType This enum lists the possible types of chat event.
ChatPartyType This enum lists the possible types of a chat party.
ChatPartyVisibility This enum lists the possible constants for the visibility of a party.

Class Detail

ChatEvent

This class describes a chat event. If this event occurred due to a chat message, this class contains the chat message.

Fields:

  date  long
   The GMT date at which this message was created, in seconds.

  nicknameParty  String
   The nickname of the author of this message.

  text  String
   The body text of this message. If the event type is ERROR_RECEIVED, the body text contains the error. If the event type is MESSAGE_RECEIVED, the body text contains the chat message text.

  number  int
   The index of this event in the range [0..n] where 0 is the first event since the session creation and n the last event received .

  eventType  com.genesyslab.ail.ws.interaction.chat.ChatEventType
   The type of this event. .

ChatMessage

This class describes a chat message.

Fields:

  date  long
   The GMT date at which this message was created, in seconds.

  nicknameParty  String
   The nickname of the author of this message.

  text  String
   The body text of this message.

ChatParty

This class describes a chat party.

Fields:

  connected  boolean
   true, if this party connected.

  nickname  String
   The nickname of this party.

  type  com.genesyslab.ail.ws.interaction.chat.ChatPartyType
   The type of this party.

  visibility  com.genesyslab.ail.ws.interaction.chat.ChatPartyVisibility
   The visibility of this party.

  joinedSessionTimestamp  long
   The timestamp when the party joined the chat session

Enum Detail

InteractionChatAction

This enum lists the possible actions on a chat interaction.

Members:

  ANSWER_CALL
   The 'answer call' action.

  MARK_DONE
   The 'mark done' action.

  RELEASE_CALL
   The 'release call' action.

  SAVE
   The 'save' action.

  TRANSFER
   The 'transfer' action.

ChatEventType

This enum lists the possible types of chat event.

Members:

  DISCONNECTED
   Event type disconnected.

  ERROR_RECEIVED
   Event type error received.

  MESSAGE_RECEIVED
   Event type message received.

  USER_JOINED
   Event type user joined.

  USER_LEFT
   Event type user left.

  USER_REENTER
   Event type user reenter a chat session (visibility changed).

  TYPING_STARTED
   Event type user started typing

  TYPING_STOPPED
   Event type user stopped typing

  PUSH_URL
   Event pushed URL

  TRANSCRIPT_SAVE_DONE
   Event Transcript save done

ChatPartyType

This enum lists the possible types of a chat party.

Members:

  UNKNOWN
   Constant for supervsor party type.

  AGENT
   Constant for agent party type.

  CLIENT
   Constant for client party type.

  SUPERVISOR
   Constant for supervsor party type.

ChatPartyVisibility

This enum lists the possible constants for the visibility of a party.

Members:

  UNKNOWN
   Constant for monitoring visibility.

  ALL
   Constant for all visibility.

  INTERNAL
   Constant for internal visibility (agents and supervisor).

  VIP
   Constant for monitoring visibility.

Interaction SDK
(Web Services)