The messaging service provides clients with methods to retrieve messages from the ICWS server. There are 2 supported methods of retrieval:

  • The short-polling method of message retrieval relies on periodically polling the GET /icws/{sessionId}/messaging/messages method to retrieve the messages that have been queued on the ICWS server. Note that the result can be an empty array if there are no queued messages.
  • The server-sent events method of message retrieval relies on setting up an event source instance that keeps an open connection to the ICWS server to receive messages as they occur.

For more information on handling message retrieval, including how to check if the ICWS server supports server-sent events, see Retrieving Messages.