List changelogs of messages
Each message changelog has distinct properties such as the timestamp of an updated message or the unique ID of a deleted message. Based on these two properties, you can retrieve message changelogs using either the timestamp or the token. The getMessageChangeLogs()
method require a MessageChangeLogsParams
object as their parameter to determine which messages to return.
MessageChangeLogsParams
Property name | Type | Description |
---|---|---|
includePollDetails | boolean | Determines whether to include a poll resource representation in the results. (Default: |
includeMetaArray | boolean | Determines whether to include the message's meta-array information in the results. (Default: |
includeReactions | boolean | Determines whether to include the message reactions in the results. (Default: |
includeParentMessageInfo | boolean | Determines whether to include the information of the parent messages in the result. (Default: |
replyType | string | Specifies the type of message to include in the results. |
includeThreadInfo | boolean | Determines whether to include the thread information of the messages in the result. (Default: |
| boolean | (Deprecated) Determines whether to include message replies in the result. Use |
| boolean | (Deprecated) Determines whether to include the parent message text in the results when the messages are replies in a thread. If the type of the parent message is |
By timestamp
You can retrieve the message changelogs by specifying a timestamp. The results only include changelogs that were created after the specified timestamp.
List of parameters
Parameter name | Type | Description |
---|---|---|
timestamp | long | Specifies a timestamp to be the reference point for the changelogs to be retrieved, in Unix milliseconds format. |
params | Contains a set of parameters you can use when retrieving changelogs. |
By token
You can also retrieve message changelogs by specifying a token. The token is an opaque string that marks the starting point of the next page in the result set and it's included in the callback of the previous call. Based on the token, the next page starts with changelogs that were created after the specified token.
List of parameters
Parameter name | Type | Description |
---|---|---|
token | string | Specifies a token to be the reference point for the changelogs to be retrieved. |
params | Contains a set of parameters you can use when retrieving changelogs. |