User Overview
App users need to integrate with 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 the IM service.
Register User
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 process of obtaining a Token using userId is referred to as Register User, 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 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 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 User
Deactivating a user refers to deleting user data in RC services. Apps can use this capability to implement their own user account closure functionality, meeting 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 the above capabilities.
User Information
User information generally refers to the user's nickname, avatar, as well as group nicknames, group avatars, and other data. The RC server does not provide user profile hosting and maintenance services.
The IMLib SDK does not provide client-side interfaces related to user information.
Friend Relationship
The friend relationship between App users needs to be maintained by the App Server. RC does not synchronize or save friend relationship data from the App side.
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 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 | Refer to Delete User. | Not provided | Not provided |
| Invalidate Token | Invalidate Tokens obtained before a specific time. | Not provided | Invalidate Token |
| Deactivate User | Deactivate a user in RC services, disabling the user ID 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 RC services. | Not provided | Reactivate User ID |
| Set User Information on RC Server | Set the user name and avatar used in RC push services. | Not provided | No separate setting interface is provided. User information must be provided during Register User. |
| Get User Information on RC Server | Get the user's registration information on RC, including user creation time and the user name and avatar URL used by the server's push services. | Not provided | Get Information |
| Modify User Information on RC Server | Modify the user name and avatar used in RC push services. | Not provided | Modify Information |
| Ban User | Prohibit a user from connecting to RC IM services 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, Unban 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 | 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. | Query if User is in Blocklist | Not provided |
| Get Blocklist | Get the blocklist of a user. | Get Blocklist | 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 |