Retrieve Historical Message Logs
The IM service can save historical message records of all conversations within the APP. These historical message records are provided as compressed log files. You can use the server API to retrieve the historical message logs for a specified App.
The server API interface only returns the download URL of the message record file. After obtaining the URL, please download it yourself.
Enable the Service
Before using the Retrieve Historical Message Logs feature, please ensure that the service has been enabled for the current App Key. For details, see Message Management Service Configuration.
If the service is not enabled, the Server API will return a 1009 error. Note that if the service is not enabled and the API request frequency exceeds the limit due to continuous requests, the Server API will return an HTTP 429 Too Many Requests error (error code 1008).
Time Range for Retrievable Logs
The historical message logs include message data from the following conversation types: one-to-one chat, discussion group, group, ultra group, chatroom, customer service, and system notification.
After enabling the Historical Message Log Download service in the Console, the server will start saving the message log data for the current hour. For example, if you enable the service between 10:00 and 11:00, the IM server can provide historical message logs starting from 10:00.
- The IM server packages historical message log data hourly, and only supports retrieving data by the hour. For details, see the description of the
dateparameter in the API interface. - There is a certain delay in retrieving data. First, the data file for 10:00–11:00 will not be generated until after 11:00. Additionally, due to the time required for file compression and packaging, the download URL can generally be obtained within 1 hour (i.e., before 12:00).
- The retrieved historical message logs are the full logs of all conversation historical messages for the specified time period; the server API interface does not support retrieval by user or by conversation.
Log Retention Period
The message record log files saved on the server are retained for only 3 days. After 3 days, the server automatically deletes these log files.
If you need to retrieve information such as images or videos, you can download them via the URLs in the messages. If the files are stored on the IM service, the file storage validity period is 6 months.
You can actively delete historical message logs through the server API. After the deletion interface returns successfully, the log files will be permanently deleted within 10 minutes. For details, see Delete Historical Message Logs.
Log Format
| Name | Type | Description |
|---|---|---|
| appId | String | App Key. |
| fromUserId | String | Sender ID. |
| targetId | String | Receiver ID, which is toUserId in message routing. This field is empty when sending Chatroom Broadcast Messages or Broadcast to Users. |
| targetType | Int | Conversation type. 1 (one-to-one chat), 2 (discussion group), 3 (group), 4 (chatroom), 5 (customer service), 6 (system notification), 7 (application public service), 8 (public service), 10 (ultra group). targetType is ConversationType in the SDK. |
| GroupId | String | Depending on targetType, this may be the discussion group ID, group ID, ultra group ID, or chatroom ID. If targetType is 1, GroupId can be ignored. |
| busChannel | String | Ultra group channel ID. |
| classname | String | Message type, e.g., text message RC:TxtMsg, image message RC:ImgMsg. For details, see Message Type Overview. |
| content | String | Message content. For details, see the structure of various message types in Message Type Overview. |
| extraContent | Object | Extended content of the message, JSON-structured Key-Value pairs, e.g., {"type":"3"}. Key can be up to 32 characters, supporting uppercase and lowercase letters, numbers, and special characters + = - _. Chinese characters are not supported. Value can be up to 4096 characters. |
| dateTime | String | Message time. |
| source | String | Message source, including: iOS, Android, HarmonyOS, Websocket, MiniProgram (mini-program), PC, Server. |
| isDiscard | String | Whether the message was discarded, true for yes, false for no. This only exists for chatroom conversation types. |
| isSensitiveWord | String | Whether the message contains blocked sensitive words, true for yes, false for no. This only exists for chatroom conversation types. |
| isForbidden | String | Whether the message was sent after being muted. This only exists for chatroom conversation types. |
| isNotForward | String | Whether the message is not forwarded, true for yes, false for no. This only exists for chatroom conversation types. |
| msgUID | String | The msgUID can be used to uniquely identify the message. |
| groupUserIds | String[] | This parameter is valid when targetType is 3, displaying the user ID array of specified message recipients in the group. This message is a group targeted message. If it is not a targeted message, the content is empty. If the specified user is not in the group, the content is also empty. |
Request Method
POST: https://Data Center Domain/message/history.json
Rate Limit: 100 requests per second
Signature Rule: All server API requests require signature verification. For details, see API Request Signature.
Body Parameters
The HTTP request body data format is application/x-www-form-urlencoded, supporting the following HTTP form parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| date | String | Yes | Specifies the time, accurate to a specific day and hour, in the format YYYYMMDDHH. For example, 2014010101 indicates the data from 1:00 AM to 2:00 AM on January 1, 2014.Note: The value of date is related to the data center where the App is located. If your App business uses the Singapore data center, the time (date) used when retrieving message logs, and the message time (dateTime) in the logs, are both in UTC time. If you still need to download data based on Beijing time, please convert it yourself. For example, to download the log for Beijing time 2019120109, you need to input 2019120101. |
Return Parameters
| Return Value | Return Type | Description |
|---|---|---|
| code | Int | Return code, 200 indicates success. |
| url | String | Download URL for the historical records. If there is no message record data, the url value will be empty. |
| date | String | Time of the historical records. |
Request Example
POST /message/history.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
date=2014010101
Return Result Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code":200,
"url":"http://aa.com/1/c6720eea-452b-4f93-8159-7af3046611f1.gz",
"date":"2014010101"
}