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 step 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 Chat Premium Plan or Chat Ultimate Plan.
Delete User
Deleting a user refers to removing a registered test user from the Development environment via 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 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 data such as the user's nickname, avatar, and the group's nickname and avatar. The RC server does not provide user profile hosting services.
In the Global IM UIKit UI, if you need to display user and group avatars, nicknames, etc., on the chat UI or friend list, the application layer must provide the relevant data. For the convenience of App developers, Global IM UIKit has designed and provided multiple information provider interfaces for the SDK to obtain user information from the application layer.
Friend Relationship
The friend relationships between App users need 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 friend relationships 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 above. | Not provided | Not provided |
| Expire Token | Expire Tokens obtained before a specific time. | Not provided | Expire Token |
| Deactivate User | Deactivating a user refers to disabling the user ID in the RC service and deleting the user's 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 Local User Information | Set the user information provider, with the application layer responsible for providing data. | Set User Information Provider | Not provided |
| Set RC Server User Information | Set the user name and avatar used in RC push services. | Not provided | No separate interface provided. User information must be provided during Register User. |
| Get Local User Information | Get user avatars, nicknames, etc., displayed on the chat UI or friend list. | Get User Information | Not provided |
| Get RC Server User Information | Get user information registered with RC, including user creation time and the user name and avatar URL used by the server's push services. | Not provided | Get Information |
| Modify Local User Information | Modify the user nickname, avatar, etc., saved in the local database. | Refresh User Information | Not provided |
| Modify RC Server User Information | Modify the user name and avatar used in RC push services. | 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. 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 |
| User Blocklist | Add or remove users from a user's blocklist. Users in User A's blocklist cannot send messages to User A. Query blocklist-related information. Global IM UIKit does not provide this API interface. The client API here is the IMLib API interface. | Add to Blocklist, Remove from Blocklist, Check if User is in Blocklist, Get Blocklist | Add to Blocklist, [Remove from Blocklist][server-api-remove-from-blacklist], 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 |