Skip to main content
Rooms are used to organize and logically separate your users and chat messages into ‘rooms’. They are the entry object into using chat and provide access to all other chat features, such as messages, online status and typing indicators. A room can represent a 1:1 chat between an agent and a customer, a private message between two users in a chat application, a large group conversation, or the chat section of a livestream with thousands of users.

​
Use a Room

Users send messages to a room and subscribe to the room in order to receive messages.

​
Attach to a Room

To start receiving messages and events from a room, you need to attach to it:

​
Room Status

A room can have any of the following statuses:
StatusDescription
initializingThe library is initializing the room.
initializedThe room has been initialized, but no attach has been attempted yet.
attachingAn attach has been initiated.
attachedAn attach has succeeded. In the attached status a client can publish and subscribe to messages.
detachingA detach has been initiated.
detachedThe room has been detached by the client.
suspendedThe room, having previously been attached, has lost continuity.
failedAn indefinite failure condition.
Use the status property to check which status a room is currently in:

​
Next Steps

Build docs developers (and LLMs) love

Get started for freeTalk to us