Chatroom Overview
Chatroom provides a business model that supports high-concurrency message processing, suitable for scenarios such as live streaming, communities, gaming, social networking, and interest discussions. 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.
Service Configuration
Chatrooms do not require activation. Some basic features and value-added services of chatrooms can be enabled and configured on the Basic features and Chat pricing plans pages in the Console.
Chatroom Auto-Destruction Mechanism
Chatrooms have an auto-destruction mechanism. By default, all chatrooms will automatically destroy and kick out all members after being inactive (no member activity or new messages) for 1 hour. The duration can be modified, and it can also be configured to auto-destroy at a scheduled time.
The chatroom business supports flexible control over the survival conditions and duration of each chatroom. For more details, see Chatroom Auto-Destruction Mechanism.
Chatroom Auto-Exit Mechanism for Offline Members
Chatrooms have an auto-exit mechanism for offline members. After a user goes offline, if the following default conditions are met, the IM server will automatically kick the user out of the chatroom:
- If the 31st message is generated in the chatroom within 30 seconds of the user going offline, an auto-kick is triggered.
- Or, if a new message is generated in the chatroom after the user has been offline for 30 seconds, an auto-kick is triggered.
- The default conditions require that new messages must be generated in the chatroom; otherwise, the kick action cannot be triggered. If no messages are generated in the chatroom, abnormal users cannot be kicked out.
- To modify the default behavior's dependency on new messages, submit a ticket to activate Real-time Kick for Abnormal Chatroom Members. After this service is activated, the server will determine the user's abnormal status through SDK behavior (requires Android/iOS IMLib SDK version ≧ 5.1.6, Web IMLib version ≧ 5.3.2), and abnormal users can be kicked out within 5 minutes.
- To protect specific users (i.e., prevent them from being automatically kicked out, as some scenarios may require users to remain in the chatroom), use the Chatroom User Whitelist feature provided by the Server API.
Chatroom Message Capabilities
- Chatrooms do not support offline message push notifications; only online chatroom members can receive chatroom messages.
- Local chatroom messages are deleted when the chatroom is exited. Chat Premium Plan and Chat Ultimate Plan customers can choose to enable the Cloud Storage for Chatroom Messages feature. Specific features and fees are subject to the billing documentation.
Chatroom Management Interfaces
Chatroom session relationships are established and maintained by the IM server. The SDK provides some chatroom management interfaces such as join and exit. More chatroom management features require the use of the IM server API. The table below describes the main functional interfaces of chatrooms.
| Functional Category | Description | IM Server API |
|---|---|---|
| Create Chatroom | Manually create a chatroom. When creating a chatroom, you can specify the auto-destruction type (scheduled destruction or destruction after inactivity), configure whether to mute all members, and set custom chatroom attributes (KV). | Create Chatroom |
| Destroy Chatroom | Manually destroy a chatroom. | Destroy Chatroom |
| Join Chatroom | Join a chatroom. | Not provided |
| Exit Chatroom | Online users can actively exit a chatroom. Offline users can be automatically kicked out of the chatroom, requiring no additional handling. | Not provided |
| Query Chatroom Room and User Information | Query basic information about a chatroom, including chatroom ID, creation time, number of members, auto-destruction type, etc. | [Query Room Info][get-chatroom-info-server] |
| Chatroom Keepalive | Add one or more chatrooms to the chatroom keepalive list. Chatrooms in the keepalive list will not be automatically destroyed by the IM server. | Keepalive Chatroom |
| Chatroom Attribute Management | Set custom attributes in a specified chatroom. For example, in a voice live chatroom scenario, use this feature to record the attributes of each mic position; or in a card game scenario like Werewolf, record the user's role and game state. Chatroom attributes are stored in Key-Value format, supporting set, delete, and query operations, as well as batch and forced operations. | [Attribute Management (KV)][chatroom-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. | Member Ban |
| Chatroom User Whitelist | Requires activation under Basic Services on the Chat pricing plans page. Chat Premium Plan or Chat Ultimate Plan can activate this service. Specific features and fees are subject to the billing documentation. Users added to a chatroom's whitelist will not have their messages discarded when the chatroom has a high message volume; they will also not be automatically kicked out by the IM server. | Chatroom Whitelist Service |
| Send Chatroom Message | Send a chatroom message. | [Send Chatroom Message][send-chatroom-msg-server] |
| Recall Chatroom Message | Recall a chatroom message. | [Message Recall][recall-msg-server] |
| Get Chatroom History Messages | Get chatroom history messages. | [History Message Log][get-chatroom-history-msg-server] |
| Chatroom Low-Priority Messages | Requires activation under Basic Services on the Chat pricing plans page. Chat Premium Plan or Chat Ultimate Plan can activate this service. Specific features and fees are subject to the billing documentation. 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. | Chatroom Message Priority Service |
| Chatroom Message Whitelist | Requires activation under Basic Services on the Chat pricing plans page. Chat Premium Plan or Chat Ultimate Plan can activate this service. Specific features and fees are subject to the billing documentation. If a message type is in the chatroom message whitelist, all messages of that type are protected and will not be discarded even when the chatroom has a high message volume. | Chatroom Whitelist Service |
| Chatroom Member Mute | Mute one or more members in a specified chatroom. Muted chatroom members can receive and view chatroom messages but cannot send messages to the chatroom. | 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 muting all group members, all members of the chatroom cannot send messages to the group via the client SDK. | Mute All |
| Mute Exceptions | Add one or more group members to the chatroom mute exceptions list. Members added to the exceptions list can still send messages to the chatroom via the client SDK even if the chatroom is in a mute-all state. | Mute All |
| Global Mute for Chatroom Members | Requires activation under Basic Services on the Chat pricing plans page. Chat Premium Plan or Chat Ultimate Plan can activate this service. Specific features and fees are subject to the billing documentation. Add one or more users to the global mute list for chatrooms. Users in the list cannot send messages in any chatroom under the application. | Global Mute |