GET (Events)

This API gets events queued on the chat proxy starting from the specified eventid. GET returns an XML payload wrapped in a <ChatEvents> tag containing 0 or more event types returned in the order they were received. When first called, eventid should be set to 0. Subsequent calls should identify the id of the last processed event.

Note
Because there is no identifier specifying which chat we are getting events for, API calls only work with a valid session cookie. The session cookie returned from the POST or GET should be provided on subsequent chat proxy API calls.

URL example:

https://<ServerIP>:<Port>/ccp/rest/chat?eventid=0&all=false

HTTPS method:

GET

Parameter:

See below.

Example response payload: 


<ChatEvents>
	<PresenceEvent>
		<id>2</id>
		<from>Steve</from>
		<status>joined</status>
	</PresenceEvent>
 <TypingEvent>
   <id>2</id>
   <from>Steve</from>
   <status>composing</status>
	<MessageEvent>
		<id>3</id>
		<from>Steve</from>
		<body>Hi There</body>
	</MessageEvent>
	<MessageEvent>
		<id>4 </id>
		<from>Steve</from>
		<body>How can I help you?</body>
	</MessageEvent>
 <TypingEvent>
   <id>3</id>
   <from>Steve</from>
   <status>paused</status>
  </TypingEvent>
</ChatEvents>

HTTPS response headers:

200 (Succeeded) or 400/500 (Failed).

See HTTPS Responses.