Jump to: navigation, search

CometD notifications

Many requests in the Web Services API are asynchronous. When you send an asynchronous request, typically an operation, Web Services still returns an HTTP response with a status code like other requests, but this only means the request was processed and sent to a backend Genesys server, like T-Server. When the server finishes processing the request and notifies Web Services of any changes in state or errors, Web Services then sends the updated state or error details to the client application as CometD notifications.

Web Services uses CometD to deliver these unsolicited notifications to clients. CometD is a library that allows the server to deliver messages to a web-based client with low-latency using a variety of transports. The transport used to deliver messages is negotiated between the client and server based on what the client supports running in a particular browser. Example transports include long polling and web sockets. CometD also provides a basic infrastructure for publishing and subscribing to messages. For more information about CometD, or for details about where to obtain client-side CometD libraries for various platforms, see the official CometD site.

A basic understanding of CometD is a prerequisite to developing a client application using the Web Services API.


Once your client application establishes a CometD session, you must create a subscription to one or more of the CometD topics used by the Web Services API. Your subscriptions should be based on the functionality available in your client application.

Topic Description MessageTypes
/v2/me/devices Messages related to devices. Examples include changes to agent state, do-not-disturb, call forwarding, and supervisor monitoring.
/v2/me/calls Messages related to calls. Examples include changes to call state, updates to call participant information, and updates to call data.
/notifications/services Messages relating to the state of different services. If the connection to T-Server is lost, or T-Server's connection to the CTI link is broken, a message is delivered to the client.
  • ServiceStateChangeMessage
/v2/me/chats Messages related to chats. Examples include changes to chat state, updates to chat participant information, updates to chat data, and updates to chat transcript.
/v2/me/emails Messages related to emails. Examples include changes to email state and updates to email data.
/v2/me/facebook Messages related to Facebook interactions. Examples include changes to Facebook interaction state and updates to Facebook interaction data.
/v2/me/facebooksession Messages related to private Facebook messages. Examples include changes to private Facebook message state, updates to private Facebook message data, and updates to private Facebook message transcript.
/v2/me/im-sessions Messages related to instant messaging between agents. Examples include changes to IM session state and updates to IM session data.
/v2/me/openmedia Messages related to OpenMedia interactions. Examples include changes to OpenMedia interaction state and updates to OpenMedia interaction data.
/v2/me/twitter Messages related to Twitter interactions. Examples include changes Twitter interaction state, updates to Twitter interaction data, and updates to Twitter account following.
/v2/me/workbins Messages related to workbins. Examples include changes to workbin state and updates to workbin contents.
/v2/me/workitems Messages related to workitems. Examples include changes to workitem state and updates to workitem data.


[+] ServiceStateChangeMessage

This page was last edited on September 2, 2016, at 19:10.
blog comments powered by Disqus