Chatroom Overview
Chatroom provides a business model with no user limit and supports high-concurrency message processing, suitable for scenarios such as live streaming, communities, games, social networking, and interest discussions. The key points of the chatroom business are as follows:
- There is no limit to the number of chatrooms that can be created under an App Key, and there is no limit to the number of members in a single chatroom.
- Chatrooms have an auto-destruction mechanism. By default, all chatrooms will kick out all members and auto-destruct after being inactive (no members entering or leaving and no new messages) for 1 hour. This duration can be extended or configured for scheduled auto-destruction. For details, refer to the server documentation Chatroom Destruction Mechanism.
- Chatrooms have an automatic exit mechanism for offline members. When the default preset conditions are met, the RC server will kick out chatroom members. For details, refer to Exit Chatroom.
- Local messages in a chatroom will be deleted when the user exits the chatroom. Chat Premium Plan and Chat Ultimate Plan customers can choose to enable the Cloud Storage for Chatroom Messages feature to store messages on the RC server. Specific features and fees are subject to the Billing Instructions document.
- Chatrooms do not have the offline message-to-push feature. Only online chatroom members can receive chatroom messages.
Client UI Framework Reference Design
The chatroom product does not currently provide dedicated UI components for chatroom conversations. You can refer to the following UI framework design to understand the design approach for chatrooms.
- The Chatroom tab in the figure below shows the chatroom message list.
- The Chatroom Management window in the figure below demonstrates some of the capabilities supported by chatrooms, such as muting, banning, allowlist, etc.
Service Configuration
The client SDK supports chatrooms by default, and no application is required to enable it.
Some basic features and value-added services of chatrooms can be enabled and configured in the Console's Basic Features and Chat pricing plans pages.
Client SDK Usage Notes
Global IM Kit depends on IMLib, so global IM Kit has all the capabilities of IMLib, including chatrooms. However, please note that global IM Kit does not provide out-of-the-box chatroom conversation UI components.
Chatroom Function Interfaces
The chatroom session relationship is established and maintained by RC. The SDK provides some chatroom management interfaces such as join and exit. More chatroom management features require the use of the Instant Messaging Server API. The table below describes the main functional interfaces of RC chatrooms.
| Function Category | Description | Client API | RC Server API |
|---|---|---|---|
| Create & Destroy Chatroom | Manually create or destroy a chatroom. Note: The client SDK does not have a separate API for creating a chatroom. The client does not provide an API for manually destroying a chatroom. | Not provided | Create Room, Destroy Room |
| Join & Exit Chatroom | Join an existing chatroom, ensure the chatroom ID exists. Join and exit chatroom APIs are only provided by the client. Note: The client has deprecated APIs that support creating a chatroom if it does not exist and then joining, but this is no longer recommended. | Join Chatroom, Exit Chatroom | Not provided |
| Query Chatroom & User Info |
| Query Chatroom Info | Query Room Info |
| Chatroom Keepalive | Add one or more chatrooms to the chatroom keepalive list. Chatrooms in the keepalive list will not be auto-destroyed by the RC server. | Not provided | Keepalive Room |
| Chatroom Attribute Management | Set custom attributes in a specified chatroom. For example, in a voice live streaming chatroom scenario, use this feature to record the attributes of each microphone position; or in card game scenarios like Werewolf, record user roles and game status. Chatroom attributes are stored in Key-Value pairs, supporting setting, deleting, and querying attributes, as well as batch and forced operations. | Chatroom Attributes | Attribute Management (KV) |
| Ban/Unban Chatroom User | Ban one or more chatroom members. Banned members will be kicked out of the specified chatroom and cannot re-enter the chatroom during the ban period. | Not provided | Member Ban |
| Chatroom User Allowlist | This service needs to be enabled under General Services on the Chat pricing plans page. Chat Premium Plan or Chat Ultimate Plan can enable this service. Specific features and fees are subject to the Billing Instructions document. After a user is added to a chatroom's allowlist, their messages will not be discarded when the chatroom message volume is high; and the user will not be automatically kicked out of the chatroom by the RC server. | Not provided | Chatroom Allowlist Service |
| Send Chatroom Message | Send chatroom messages. | Send Message | Send Chatroom Message |
| Recall Chatroom Message | Recall chatroom messages. | Recall Message | Message Recall |
| Get Chatroom History Messages | Get chatroom history messages. | Get Chatroom History Messages | History Message Log |
| Chatroom Low-Priority Messages | This service needs to be enabled under General Services on the Chat pricing plans page. Chat Premium Plan or Chat Ultimate Plan can enable this service. Specific features and fees are subject to the Billing Instructions document. If a message type is in the low-priority message list, all messages of that type are considered low-priority. When the server is under high load, high-priority messages are retained first, and low-priority messages are discarded first. By default, all messages are high-priority. | Not provided | Chatroom Message Priority Service |
| Chatroom Message Allowlist | This service needs to be enabled under General Services on the Chat pricing plans page. Chat Premium Plan or Chat Ultimate Plan can enable this service. Specific features and fees are subject to the Billing Instructions document. If a message type is in the chatroom message allowlist, all messages of that type are protected and will not be discarded even when the chatroom message volume is high. | Not provided | Chatroom Allowlist Service |
| Chatroom Member Mute | Mute one or more members in a specified chatroom. Muted members can receive and view chatroom messages but cannot send messages to the chatroom. | Not provided | Mute a User |
| Mute All Members | Mute all members in a chatroom or cancel the mute status for all members in a specified chatroom. After setting mute for all members, all members of the chatroom cannot send messages to the group via the client SDK. | Not provided | Mute All |
| Mute Exceptions | Add one or more group members to the chatroom mute exceptions list. After a chatroom member is added to the allowlist, even if the chatroom is in a mute-all state, the member can still send messages to the chatroom via the client SDK. | Not provided | Mute All |
| Global Mute Chatroom Members | This service needs to be enabled under General Services on the Chat pricing plans page. Chat Premium Plan or Chat Ultimate Plan can enable this service. Specific features and fees are subject to the Billing Instructions document. Add one or more users to the global mute list for chatrooms. Users in the list cannot send messages in all chatrooms under the application. | Not provided | Global Mute |