User Overview
App users need to access RC services to use the IM Service. For RC, a user is an App user who holds a valid Token issued by RC and accesses and uses the IM Service.
Register Users
The App Server should provide the user ID (userId) of the App user to the RC server to obtain a unique user Token. For RC, this step of obtaining a Token using userId is referred to as Register Users, and it must be completed by calling the Server API.
The App client must hold a valid Token to successfully connect to the RC server and use the RC IM Service. When an App client user sends a login request to the server, the server will query the database to check if the connection request matches.
User Registration Limit
- The maximum number of registered users in the Development environment? is 100.
- In the Production environment?, there is no limit to the number of registered users after upgrading to the Chat Premium Plan or Chat Ultimate Plan.
Delete Users
Deleting users refers to removing registered test users in the Development environment through the Console to control the total number of test users in the development environment. This operation is not supported in the Production environment.
Deactivate Users
Deactivating users refers to deleting user data in the RC service. Apps can use this capability to implement their own user deactivation functionality to meet App store or compliance requirements.
After RC returns a successful deactivation result, the data related to the user ID is deleted. You can query RC for all deactivated user IDs. If needed, you can reactivate a deactivated user ID (note that user personal data cannot be restored).
Only the IM Server API provides this capability.
User Information
User information generally refers to data such as user nicknames, avatars, group nicknames, and group avatars. By default, RC does not store or maintain your App's user information data, and you need to maintain user data on the App side. If you need to store your App's user profile information on RC, you can enable and use RC's User Profile Hosting service to store and maintain user profile information on RC.
Friend Relationship
By default, the RC IM Service does not synchronize or save friend relationship data from the App side, and it needs to be maintained by the App Server.
If you need to restrict message sending and receiving behavior between client users (for example, if all userIds of the app are leaked, allowing a malicious user to bypass the friend relationship and send messages to any user), you can consider using the User allowlist service. Once a user enables and sets a allowlist, they can only receive messages from users in that allowlist.
User Management APIs
| Feature Category | Feature Description | Client API | Server API |
|---|---|---|---|
| Register Users | Use the App user's user ID to obtain a Token from RC. | Not provided | Register Users |
| Delete Users | See above Delete Users. | Not provided | Not provided |
| Expire Token | Expire Tokens obtained before a specific point in time. | Not provided | Expire Token |
| Deactivate Users | Deactivate users refers to disabling user IDs in the RC service and deleting user personal data. | Not provided | Deactivate Users |
| Query Deactivated Users | Get a list of deactivated user IDs. | Not provided | Query Deactivated Users |
| Reactivate User ID | Reactivate a deactivated user ID in the RC service. | Not provided | Reactivate User ID |
| Set User Info on RC Server | Set the user name and avatar used in RC's push service. | Not provided | Not provided as a separate interface. User info must be provided during Register Users. |
| Get User Info on RC Server | Get the user's registration info on RC, including user creation time and the user name and avatar URL used by the server's push service. | Not provided | Get Info |
| Modify User Info on RC Server | Modify the user name and avatar used in RC's push service. | Not provided | Modify Info |
| Block Users | Prevent users from connecting to the RC IM Service and immediately disconnect them. Can be unblocked by time or manually. Query blocked user IDs and block end times. | Not provided | Add Blocked User, Unblock User, Query Blocked Users |
| Query User Online Status | Query the online status of a user. | Not provided | Query Online Status |
| Add to Blocklist | Add a user to the blocklist of another user. Users in A's blocklist cannot send messages to A. | Add to Blocklist | Add to Blocklist |
| Remove from Blocklist | Remove a user from the blocklist. | Remove from Blocklist | Remove from Blocklist |
| Check Blocklist | Check if a user (userId) has been added to the current user's blocklist. | Check if User is in Blocklist | Not provided |
| Get Blocklist | Get the blocklist of a user. | Get Blocklist | Query Blocklist |
| User Whitelist | Once a user enables and sets a whitelist, they can only receive messages from users in that whitelist. | Not provided | Enable user allowlist, Query allowlist status, Add to allowlist, Remove from allowlist, Query allowlist |