Room Types
This article describes the different types of rooms which can be used for different purposes.
🔒 Private Room
A Private Room is a restricted chat space where only invited users can join. It ensures confidentiality and is ideal for secure discussions. Private rooms require authentication, and only authorized users can access them.
To enable a private room, you need to enable the ON VERIFICATION REQUEST webhook.
Use this prefix : pri-test-room
🌍 Public Room
A Public Room is an open chat space where anyone can join without restrictions. It is ideal for general discussions, community engagement, and public conversations.
Public rooms do not require authentication, and any user can enter freely using the Client API Key.
Use this prefix : pub-general-room
🗄️ Cache Room
A Cache Room is a temporary chat space that stores only the last sent message in the room.
The cached message can be accessed via the API.
You can also have Private Cache Rooms and Public Cache Rooms.
Prefix examples : cache-temp-room, pri-cache-room, pub-cache-room
📢 State Room
A State Room is a dynamic chat space where participants receive real-time notifications when someone joins or leaves.
Variants include : pri-state, pub-state, pri-state-cache, pub-state-cache
- 🔒
pri-state- - 🌍
pub-state- - 🔒🗄️
pri-state-cache- - 🌍🗄️
pub-state-cache-
Example : pri-state-team-chat, pub-state-community-chat, pri-state-cache-meeting, pub-state-cache-announcement