Skip to main content

Deactivate Users

Deactivate users in the IM Service. Once a user is deactivated, all personal data stored in the IM Service will be permanently deleted and cannot be recovered. Please proceed with caution.

Use Cases​

  • User Account Deletion in App: Implement the account deletion feature in your app. When a user initiates the deletion, they will be logged out immediately and will no longer be able to log in. All related data will be deleted and cannot be recovered.
  • Employee Account Deletion: Manage account deletion for employees who leave the company in office applications. When an administrator initiates the deletion, the employee will no longer be able to log in, and all related data will be transferred or deleted.

Data Deletion Scope​

The IM Service will only delete the personal data of the deactivated user stored on the IM server:

  • Personal Information: Deletes the user's avatar and nickname stored on the IM server.
  • Message Data: Deletes historical messages, offline messages, message compensation, and offline message duration settings stored on the IM server.
  • Conversation Information: Deletes conversations, conversation lists, conversation tags, and conversation settings (e.g., pinning, Do Not Disturb) stored on the IM server.
  • Push Information: Disables push notifications and deletes the user's push device information.
  • User Settings: Deletes the user's one-to-one chat blocklist/allowlist, push notification language preferences, and whether to show push notification details.

The IM Service will not delete non-personal data stored on the IM server, such as group relationships and ultra group relationships.

tip

The deactivation operation does not delete the user's group relationships or ultra group relationships. If your app requires it, you can call the relevant IM Server API to remove the user from groups or ultra groups.

Impact and Results of Deactivation​

After initiating deactivation, the following impacts occur on the client and server:

  • Client: The connection to the IM Service is immediately terminated. If the user is logged in on multiple devices, all devices will be disconnected. The user will no longer be able to obtain a Token or send/receive messages via the SDK.
  • Client: The SDK's connection status listener will return a disconnected status code.
  • Server: When sending messages via the Server API, the IM Service will not check if the sender's user ID has been deactivated. The app needs to handle this independently.
  • Server Callback: If the User Online Status Update Callback feature is enabled for the App Key, the server will synchronize the user's online status (user logout) after the client disconnects.

If the User Deactivation and Activation Status Callback feature is enabled for the App Key, the server will synchronize the deactivation completion status to your specified server.

Request Method​

POST: https://data center domain/user/deactivate.json

Signature Rule: All server API requests must be validated according to the signature rules. For details, see API Request Signature.

Rate Limit: 100 users per second

Body Parameters​

The HTTP request body is in application/x-www-form-urlencoded format and supports the following HTTP form parameters:

ParameterTypeRequiredDescription
userIdStringYesThe user ID(s) to be deactivated. Up to 100 IDs at a time.

Request Example​

POST /user/deactivate.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX(最大长度36)

userId=uid1,uid2

Response​

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

Return ValueTypeDescription
codeNumberReturn code, 200 indicates success. The operation result for each user ID is passed via the User Deactivation and Activation Status Callback.
operateIdStringOperation ID, a unique identifier for the current operation. If the User Deactivation and Activation Status Callback is enabled, this parameter will be included in the callback request body.

Response Example​

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

{"code":200,"operateId":"C70B-B1D6-82E7-5SBO"}
Last updated on