User Overview
App users need to connect to RC services to use the instant messaging (IM) service. For RC, a user is an App user who holds a valid Token issued by RC and connects to and uses the IM service.
Register User
The application server (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 [registering a user], and it must be completed by calling the Server API.
The application 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 User
Deleting a user refers to removing a registered test user 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 User
Deactivating a user refers to deleting user data in the RC service. Apps can use this capability to implement their own user account deletion functionality, meeting App store or compliance requirements.
After RC returns a successful deactivation result, the data associated with 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 the user's nickname, avatar, as well as group nicknames and group avatars. By default, RC does not store or maintain your application's user information data, and you need to maintain user data on the application side.
Friend Relationship
By default, RC's IM service does not synchronize or save App-side friend relationship data, which needs to be maintained by the application server (App Server).
If you are not using RC's friend relationship management service and need to restrict message sending and receiving behavior between client users (for example, if all userIds of an 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 an allowlist, they can only receive messages from users in that allowlist.
User Management APIs
| Function Category | Description | Client API | Server API |
|---|---|---|---|
| Register User | Use the App user's user ID to obtain a Token from RC. | Not provided | Register User |
| Delete User | See above Delete User. | Not provided | Not provided |
| Expire Token | Expire Tokens obtained before a specific time. | Not provided | Expire Token |
| Deactivate User | Deactivate a user by disabling the user ID in the RC service and deleting user personal data. | Not provided | Deactivate User |
| 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 Information on RC Server | Set the user name and avatar used in RC's push service. | Not provided | Not provided as a separate API. User information must be provided when [registering a user]. |
| Get User Information on RC Server | Get the user's registered information on RC, including the user creation time and the user name and avatar URL used by the server's push service. | Not provided | Get Information |
| Modify User Information on RC Server | Modify the user name and avatar used in RC's push service. | Not provided | Modify Information |
| Ban User | Prevent a user from connecting to the RC IM service and immediately disconnect them. Can be unblocked by time or actively unblocked. Query the user ID and ban end time of banned users. | Not provided | Add Banned User, Unblock User, Query Banned 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 (currently only supports Electron) | Add to Blocklist |
| Remove from Blocklist | Remove a user from the blocklist of another user. | Remove from Blocklist (currently only supports Electron) | Remove from Blocklist |
| Query Blocklist | Query whether a user (userId) has been added to the current user's blocklist. | Check if User is in Blocklist (currently only supports Electron) | Not provided |
| Get Blocklist | Get the blocklist of a user. | Get Blocklist (currently only supports Electron) | Query Blocklist |
| User Allowlist | Once a user enables and sets an allowlist, they can only receive messages from users in that allowlist. | Not provided | Enable User Allowlist, Query User Allowlist Status, Add to Allowlist, Remove from Allowlist, Query Allowlist |