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 accesses and uses the IM service.
Register Users
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 with 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.
Limits on Registered Users
- The maximum number of registered users in the development environment? is 100.
- In the production environment?, there is no limit on the number of registered users after upgrading to the Chat Premium Plan or Chat Ultimate Plan.
Delete Users
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 Users
Deactivating a user refers to deleting user data in the RC service. Apps can use this capability to implement their own user account closure 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 the user's nickname, avatar, group nickname, and group avatar. RC does not store or maintain your app's user information data by default, and you need to maintain user data on the app side.
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 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 the App are leaked, allowing a malicious user to bypass the friend relationship and send messages to any user), you can consider using the allowlist service. Once a user enables and sets an allowlist, they can only receive messages from users in that allowlist.
User Management APIs
| Feature 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 Delete Users above. | Not provided | Not provided |
| Invalidate Token | Invalidate Tokens obtained before a specific point in time. | Not provided | Invalidate Token |
| Deactivate User | Deactivate a user ID in the RC service and delete 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 Info on RC Server | Set the user name and avatar used in RC's push service. | Not provided | No separate API is provided. User information must be provided during Register User. |
| Get User Info on RC Server | Get the user's registered information on RC, including the user creation time, user name, and avatar URL used by the server's push service. | Not provided | Get User Info |
| Modify User Info on RC Server | Modify the user name and avatar used in RC's push service. | Not provided | Modify User Info |
| Block User | Prevent a user from connecting to the RC IM service and immediately disconnect them. Can be unblocked by time or manually. Query the blocked user's ID and block end time. | Not provided | Block 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. 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 |
| Query Blocklist | Query whether a user (userId) has been added to the current user's blocklist. | Check if User is in Blocklist | Not provided |
| Get Blocklist | Get the user's blocklist. | Get Blocklist | Query Blocklist |
| Allowlist | Once a user enables and sets an allowlist, they can only receive messages from users in that allowlist. | Not provided | Enable Allowlist, Query Allowlist Status, Add to Allowlist, Remove from Allowlist, Query Allowlist |