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 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 with userId is referred to as [registering a 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 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 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 the above capabilities.
User Information
User information generally refers to the user's nickname, avatar, as well as the group nickname, group avatar, and other data. The RC server does not provide user profile hosting and maintenance services.
In the Global IM UIKit SDK UI, if you need to display user and group avatars, nicknames, and other information in the chat UI, friend list, etc., the application layer needs to provide the relevant data. To facilitate 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 relationship between App users needs to be maintained by the App Server itself. RC does not synchronize or save the friend relationship data on the App side.
If you need to restrict the 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 | Refer to the above Delete User. | Not provided | Not provided |
| Expire Token | Expire Tokens obtained before a specific time point. | Not provided | Expire Token |
| Deactivate User | Deactivating a user refers to deactivating the user ID in the RC service and deleting the user's personal data. | Not provided | Deactivate User |
| Query Deactivated Users | Get the 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 Client-Side User Information | Set the user information provider, and the application layer is responsible for providing the data. | Set User Info Provider | Not provided |
| Set RC Server-Side User Information | Set the user name and avatar used in the RC push service. | Not provided | No separate setting interface is provided. User information must be provided when [registering a user]. |
| Get Client-Side User Information | Get the user avatar, nickname, and other information displayed in the chat UI, friend list, etc. | Get User Info | Not provided |
| Get RC Server-Side User Information | Get the user information registered in RC, including the user creation time and the user name and avatar URL used by the server-side push service. | Not provided | Get Info |
| Modify Client-Side User Information | Modify the user nickname, avatar, and other information saved in the client-side local database. | Refresh User Info | Not provided |
| Modify RC Server-Side User Information | Modify the user name and avatar used in the RC push service. | Not provided | Modify Info |
| Ban User | Prohibit a user from connecting to the RC IM service and immediately disconnect them. The ban can be lifted by time or manually. 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 |
| Blocklist Management | Add or remove users from a user's blocklist. Users in User A's blocklist cannot send messages to User A. Global IM UIKit has already handled the error after being blocked by default, and the page will display "Your message has been sent but was rejected by the recipient." 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 |
| 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 |