Skip to main content

Chatroom Service Configuration

The chatroom service itself does not require separate activation, but certain chatroom services need to be enabled and configured in the Console, such as Chatroom Broadcast, Cloud Storage for Chatroom Messages, and callback URLs related to chatrooms.

Chatroom service configurations are primarily managed in the Basic features and Chat pricing plans pages.

Basic Features​

The following are the basic features provided for chatroom services:

  • Single User Joins Multiple Chatrooms: By default, a user can only join one chatroom. When enabled, a user can join multiple chatrooms simultaneously.
  • Chatroom Status Update Callback: This is a server-side callback service provided by RC. A valid callback URL must be provided. Once configured, any status changes in the chatroom under the application will be synchronized in real-time to the developer's application server. Currently supported statuses include: creation, destruction, member join, and member exit. For details, refer to the Chatroom Status Update Callback section in the IM server documentation under "Chatroom Management."
  • Specify Message Types When Joining a Chatroom: By default, up to 50 recent messages of all types can be retrieved when joining a chatroom. When enabled, specific message types can be configured for retrieval.
  • Chatroom Destruction Wait Time:
    1. Supports configuring the wait time for destroying inactive chatrooms. The default wait time is 1 hour, meaning that if a chatroom remains inactive for more than 1 hour, it will be destroyed. Customers can adjust this time as needed, up to a maximum of 24 hours.
    2. When a chatroom is destroyed, a chatroom destruction notification will be sent to its members, allowing customers to customize some operations on the client side after the chatroom is destroyed (requires version 5.1.1 or later).
    3. A session ID is added to the chatroom, which remains unchanged during the chatroom's lifecycle and is regenerated after the chatroom is recreated. This allows clients to distinguish between multiple broadcasts using the same chatroom ID.
  • Chatroom Custom Attributes: Custom attributes can be set in specified chatrooms for scenarios like voice live streaming chatrooms for venue attribute synchronization or card games like Werewolf to record user roles and game states. For details, refer to the Chatroom Attribute Management (KV) documentation under "Chatroom Business." If the App's business server requires RC to provide chatroom attribute change data synchronization, a valid callback URL must be provided. Once configured, RC's server-side callback service will be automatically enabled. For details, refer to the Chatroom Attribute Synchronization section in the IM server documentation under "Chatroom Management."
  • SDK Users Cannot Send Messages Outside the Chatroom: By default, users can send messages to a chatroom without joining it. When enabled, users not in the chatroom cannot send messages to it via the client SDK. Note: Server-side chatroom message sending APIs are not affected by this configuration.
  • Multi-End Simultaneous Online: Exit Chatroom on One End, Exit on All Ends: When a user is online on multiple devices and has joined the same chatroom, by default, exiting the chatroom on one device does not affect other devices. When this feature is enabled, if one device exits the chatroom, all other devices will also exit.

Modifying Service Configuration​

Visit the Basic features page in the Console to adjust the basic feature configurations related to chatroom services.

IM Premium/Ultimate Features​

The following figure shows the General Services configurations related to chatroom services on the Chat pricing plans page in the Console.

These services are available for free in the development environment. In the production environment, IM Premium or IM Ultimate is required to use these services.

  • Chatroom Broadcast: Send a message to all chatrooms in the application, with a maximum message size of 128k. For details, refer to the Send Broadcast to All Chatrooms section in the IM server documentation under "Message Management."
  • Global Chatroom Mute: When you want to prevent a user from speaking in all chatrooms, you can add the user to the global chatroom mute list. Muted users can receive and view chat messages but cannot send messages. For details, refer to the Global Mute User section in the IM server documentation under "Chatroom User Management."
  • Chatroom Message Priority Service: Set specific message types as low-priority messages in a specified chatroom. When the server is under high load, low-priority messages are discarded first, ensuring that important messages are not dropped. For details, refer to the Add Low-Priority Message Type section in the IM server documentation under "Chatroom Message Priority Service."
  • Chatroom Allowlist Service: Once enabled, the following Server APIs can be used:
    • Chatroom User Allowlist: Can be used to protect important users in specified chatrooms, supporting allowlist settings by chatroom. For example, administrators, hosts, or other key roles in specific chatrooms within the App.
    • Chatroom Message Allowlist: Can be used to protect specific message types in all chatrooms within the App. For example, custom red packet messages in the App.
  • Chatroom Keepalive Service: If no one speaks in a chatroom for 1 hour and no one joins the chatroom, RC's server will automatically kick all members out of the chatroom and destroy it. Keepalive chatrooms will not be automatically destroyed and can be destroyed via API. For details, refer to the Keepalive Chatroom section in the IM server documentation under "Chatroom Management."
  • Cloud Storage for Chatroom Messages: Chat messages are stored in the cloud, allowing users to view previous messages when they join a chatroom. Historical messages are stored by default for 2 months.
  • Specify Message Types When Joining a Chatroom: When joining a chatroom, only specified message types are returned, and other types are excluded.

Modifying Service Configuration​

Visit the Chat pricing plans page in the development backend, switch to the General Services tab, and enable the chatroom service configuration switches. You can also adjust specific configurations for some services under the Extended Services tab.

Last updated on