Clear Messages

If the App (App Key/environment) has enabled the Cloud Storage for One-to-One and Group Messages or Cloud Storage for Chatroom Messages service, you can use this API to delete historical messages from the IM server.

• For one-to-one chat, group chat, and system conversation, this API will clear the historical messages stored on the server for the specified user (fromUserId) before the specified time. After the deletion, the user will no longer be able to retrieve historical messages from the conversation that are earlier than the specified time through the historical message service.
• For chatroom conversation, this API will clear the historical messages stored on the server for all users before the specified time. After the deletion, all users will no longer be able to retrieve historical messages from the conversation that are earlier than the specified time. Please proceed with caution.

tip

• Clearing historical messages does not affect the receipt of offline messages. If the historical messages cleared through this API include messages during the client's offline period (i.e., messages that the client has not received), the client will automatically receive these offline messages upon reconnecting.
• Clearing historical messages does not affect the offline message compensation mechanism (this mechanism only takes effect after enabling Multi-Device Message Synchronization). If an App user reinstalls the app or logs in from a different device, the offline message compensation mechanism will be triggered, and messages within 1 natural day (including the current day) will be retrieved by default. To completely delete message compensation, please submit a ticket to apply for enabling deleting offline messages from multi-device compensation when deleting historical messages from the server.

Request Method

POST: https://Data Center Domain/conversation/message/history/clean.json

Rate Limit: 100 requests per second

Signature Rule: All server API requests require rule validation. For details, see API Request Signature.

Body Parameters

The HTTP request body data format is application/x-www-form-urlencoded, and the following HTTP form parameters are supported:

Parameter	Type	Required	Description
conversationType	String	Yes	Conversation type. Supported conversation types include: 1 (one-to-one chat), 3 (group chat), 4 (chatroom), 6 (system notification)
fromUserId	String	Yes	One-to-one chat, group chat, system conversation: Represents the user whose historical messages on the server will be deleted. After deletion, the user will no longer be able to retrieve the cleared historical messages from the server. Chatroom conversation: Represents the user ID of the operator performing the deletion. After deletion, all users will no longer be able to retrieve the cleared historical messages from the server.
targetId	String	Yes	The target conversation ID to be cleared.
msgTimestamp	String	No	Clears all historical messages before this timestamp, accurate to milliseconds. If empty, all historical messages in the conversation will be cleared.

Request Example

POST /conversation/message/history/clean.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

fromUserId=1&targetId=8888&conversationType=3&msgTimestamp=1566281295943

Response

The HTTP response body contains a JSON object with the following structure:

Return Value	Type	Description
code	Number	Return code, 200 indicates success.

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}