Examples: query, "exact match", wildcard*, wild?ard, wild*rd
Fuzzy search: cake~ (finds cakes, bake)
Term boost: "red velvet"^4, chocolate^2
Field grouping: tags:(+work -"fun-stuff")
Escape special characters +-&|!(){}[]^"~*?:\ - e.g. \+ \* \!
Range search: properties.timestamp:[1587729413488 TO *] (inclusive), properties.title:{A TO Z}(excluding A and Z)
Combinations: chocolate AND vanilla, chocolate OR vanilla, (chocolate OR vanilla) NOT "vanilla pudding"
Field search: properties.title:"The Title" AND text
Are messages in the chat room will be deleted at some point in time?

We are thinking what information do we need when it comes to chat messages when we are integrating with Symphony. Our initial plan is to store the chat room id (stream ID) then if we want to pull the messages then invoke below command:

MessageService#listMessages(@Nonnull String streamId, @Nonnull Instant since, @Nonnull PaginationAttribute pagination)

However, will these messages from a chat-room be kept forever or will there be a retention period? If there is retention period, then what is the value for such?

Would you recommend our initial approach or it is better to just save everything on our end though seems redundant to us.

Thank you

Posted one year ago
Edited one year ago
Votes Newest


Hi Jun King,

Thank you for your question,

Depending on precisely what information you need when storing the 'StreamID' from your point of view - you may want to use the following REST API endpoints with the 'StreamID' to obtain the information:

Chat Room - Infomation = https://developers.symphony.com/restapi/reference/room-info-v3
Chat Room Stream Information = https://developers.symphony.com/restapi/reference/stream-info-v2
Chat Room - Members = https://developers.symphony.com/restapi/reference/room-members

However, should you wish to pull the chat messages from the chat room conversation - you will require the 'MessageID' of each message in the conversation before you can obtain information for it using the GET Message REST API endpoint (https://developers.symphony.com/restapi/reference/messages-v4).

Symphony recommends using the Content Export feature within your Symphony Pod environment to export the Chatroom Conversation Messages via daily exports to an SFTP location - which you can than later import into your back internal systems.

For Symphony pod environments - there is a default data retention period of 12 months for all chat message history - this does also depend on the legal & complaince requirements for each company. Should you wish to store chat messages it would be recommend to use the Content Export feature as mentioned above to back up to your internal systems.

Please let me know you have any additional questions.

Kind regards

Posted one year ago
Kaosar Ahmed
310 × 3 Administrator
1 Answer
one year ago
one year ago