Jump to: navigation, search

Chat Server API selected notes and topics

The following pages describe only selected topics about special use cases which might require additional clarification or explanation for the purpose of being used in custom agent desktops and chat widgets. These pages do not contain the complete description of Chat Server API which is implemented in Genesys PSDK as flex (Genesyslab.Platform.WebMedia.Protocols > FlexChatProtocol) and basic (Genesyslab.Platform.WebMedia.Protocols > BasicChatProtocol) protocols.

Throughout these pages we will be using PSDK .NET for this demonstration purpose (Java PSDK is very similar).

Chat Server Client Version

Chat Server exposes two chat protocols: flex (connectionless) and basic (connection based). These protocols are constantly evolving with new capabilities. In order to allow the protocol negotiation with Chat Server, PSDK (which implements both protocols) has a special hard-coded attribute ClientVersion. This attribute defines what functionality is available for a Chat Server API client (for example, it prevents Chat Server from sending unsupported events and/or attributes in replies). The following table describes the existing protocol versions:

ClientVersion Chat Server version PSDK version Description (features added or changed)
101 Base chat functionality. Default version.
102 Support for user nickname change: new notice type USER_UPDATE_NICK.
103 Support for Idle control functionality: new notice types IDLE_CONTROL_ALERT, IDLE_CONTROL_CLOSE, IDLE_CONTROL_SET. New transcript attribute idleTimeExpire, new user type SYSTEM, new protocol type NONE.
104 Support for chat system commands: new notice type SYS_COMMAND. Flex transcript events have been extended with userData of type KeyValueCollection (only for notice event).
105 8.5.301.00 Support for chat session silent monitoring indication: new transcript attribute monitored.
106 All transcript events have been extended with eventAttributes of type KeyValueCollection.
This page was last edited on July 2, 2019, at 20:08.
Comments or questions about this documentation? Contact us for support!