Available on Agent 2.53.0 and above.
Get messages from an existing stream (IM, MIM, chatroom, wall post).
Additionally returns any attachments associated with the message.
Optional attributes returned
Note that some attributes are returned in the payload only under specific conditions:
sharedMessageonly when the message represented by this class is a wall post sharing another message;
replacingonly when the corresponding message is sent as an update to another message thanks to Update Message endpoint. Note that the first two attributes relate to the original (and therefore first) message sent, whereas the
replacingattribute relates to the message that has been updated by this message;
replacedByonly when this message has been updated by a new message. It contains the id of the replacing message.
parentMessageIdonly when this message is a reply or a forward of another message which id is returned in this attribute.
skip parameter is supposed to be used to skip messages that have the same timestamp as the one specified on
• Pagination is supposed to use the
since parameter instead of
If you want to get two messages at a time skipping the ones you have already seen, the calls should be the following:
Let's assume here that the timestamp from the message returned on the first call was 1551052800000 and there was no other message with that same timestamp returned.
It returns the two messages received after or on the timestamp 1551052800000, skipping one message from that same timestamp (which is the one you have already seen).
Note that you can keep doing this process with subsequent calls.
Supported stream types
In addition to conversation streams such as IM, MIM, Chat rooms and Wall posts, Symphony also supports other types of streams, some of them reserved for internal use. These other stream types (ACTION, POST, PRIVATE_CHANNEL, MEETING, SUPPRESS_JUSTIFICATION) are not supported by the Get Messages endpoint.
Message Format - MessageML
Message Format - ExtensionML