Home
API
Website
Plans and pricing
Contact sales
Demo request
Login
Ask Eddy AI
Contents
x
Getting Started
Contribute to Rocket.Chat
Customize and Embed
Open-Source Projects
Apps-Engine
Omnichannel
Bots
API
Fuselage Design System
Powered by
Rooms
23 Articles
in this category
Print
Dark
Light
Contents
Rooms
23 Articles
in this category
Dark
Light
Get Rooms
Get all rooms a user belongs to. Payload parameters Example call { "msg": "method", "method": "rooms/get", "id": "42", "params": [ { "$date": 1480377601 } ] } Example response The result is an object with two fields: up...
Get Room By ID
Get room details by room ID. Payload parameters Example call { "msg": "method", "method": "getRoomById", "id": "2", "params":[ "siyr2oWQJBjQjhLwr" ] } Example response { "msg": "result", "id"...
Get Room Name By ID
Get room name by room ID. Payload parameters Example call { "msg": "method", "method": "getRoomNameById", "id": "2", "params":[ "siyr2oWQJBjQjhLwr" ] } Example response { "msg": "result", "id": "2"...
Archive Rooms
When a room is archived, it is designated as read-only and removed from the channel list on the left sidebar. Payload parameters Example call { "msg": "method", "method": "archiveRoom", "id": "3", "params": [ "64a...
Unarchive Rooms
Unarchiving a room reverses its read-only status and returns it to the channel list on the left sidebar. Payload parameters Example call { "msg": "method", "method": "unarchiveRoom", "id": "5", "params": [ "64a1f5...
Favorite/Unfavourite a Room
Mark or unmark a room as favorite. Payload parameters Example call { "msg": "method", "method": "toggleFavorite", "id": "16", "params": [ "64a1f540376181965ab77f5b", false ] } Example response { ...
Hide Rooms
When a room is hidden, it no longer appears in the channel list, and the "open" property is set to false in the user's subscription for that room. Payload parameters Example call { "msg": "method", "method": "hideRoom", "id...
Open Rooms
When a room is opened, it becomes visible in the channel list on the sidebar, and the "open" property in the user's subscription for that room is set to true . Payload parameters Example call { "msg": "method", "method": "openRo...
Leave Rooms
You can leave any room except for direct messages, and you cannot leave rooms where you are the last owner. Payload parameters Example call { "msg": "method", "method": "leaveRoom", "id": "11", "params": [ "64a1f5...
Delete Rooms
Delete a public or private room. Payload parameters Example call { "msg": "method", "method": "eraseRoom", "id": "92", "params": [ "64a1f540376181965ab77f5b" ] } Example response { "msg": "result", ...
Create Direct Message
Create a direct message . Payload parameters Example call { "msg": "method", "method": "createDirectMessage", "id": "472", "params": ["testrc"] } Example response { "msg": "result", "id": "472", "result":...
Create Private Group
Create a private group . Payload parameters Example call { "msg": "method", "method": "createPrivateGroup", "id": "44728", "params": [ "testrc7", ["test.queue"], true ] } Example response { "msg": "result", ...
Notify Room Stream
Notify a room about some specific events. Events Typing user-activity Example call { "msg": "method", "method": "stream-notify-room", "id": "42", "params": [ ... // params varies ] } Typing You can notify a...
Load History
Load room history. After the initial load, you can stream room messages . Payload Parameters Example call Request of the latest 50 messages: { "msg": "method", "method": "loadHistory", "id": "42", "params": [ "64e37db1fed...
Add Room Leader
Set a user as room leader. Payload parameters Example call { "msg": "method", "method": "addRoomLeader", "id": "2", "params": [ "WDuJLFkjwk6L7LdFC", "5fRTXMt7DMJbpPJfh" ] } Example response Succe...
Add Room Moderator
Set a user as room moderator. Payload parameters Example call { "msg": "method", "method": "addRoomModerator", "id": "2", "params": [ "64adb09baa5ad4273bfc0cbf", "rbAXPnMktTFbNpwtJ" ] } Example resp...
Add Room Owner
Set a user as room owner. Payload parameters Example call { "msg": "method", "method": "addRoomOwner", "id": "2", "params": [ "siyr2oWQJBjQjhLwr", "5fRTXMt7DMJbpPJfh" ] } Example response Success {...
Mute User In a Room
Mute a user in a room. Payload parameters Example call { "msg": "method", "method": "muteUserInRoom", "id": "2", "params": [ { "rid": "siyr2oWQJBjQjhLwr", "username": "test.fun" } ] } ...
Unmute User In a Room
Unmute a user in a room. Payload parameters Example call { "msg": "method", "method": "unmuteUserInRoom", "id": "2", "params": [ { "rid": "siyr2oWQJBjQjhLwr", "username": "test.funke" } ...
Add a User to a Room
Add a user to a room. Payload parameters Example call { "msg": "method", "method": "addUserToRoom", "id": "2", "params": [ { "rid":"64f0f82c2c26843a68c1f7ba", "username":"rodriq" } ] } Example res...
Check if Room Name Exists
This method is planned to be removed by 7.0.0. Use the /rooms.roomNameExists endpoint instead. Check if a room name exists in a workspace. Payload parameters Example call { "msg": "method", "method": "roomNameExists", "i...
Save Room Settings
Payload parameters Available settings Example call { "msg": "method", "method": "saveRoomSettings", "id": "1639", "params": [ "64a1f373376181965ab77f54", "systemMessages", "false" ] } Ex...
Get Room Roles
Get a collection of users and their roles per room. You can send a collection of room IDs (at least one). The user roles per room object is defined as: rid : The room ID this user and role belong to. u : A simple user object with the user I...
Change password!
Changing your password will log you out immediately. Use the new password to log back in.
Current password
Current password is required
New password
New password must be at least 8 characters long. It should contain at least one upper and lower case letter, number, and a special character.
Confirm password
Confirm password must be at least 8 characters long. It should contain at least one upper and lower case letter, number, and a special character.
Confirm password should be same as new password
Update
Change profile
Success!
First Name
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last Name
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
New email
Enter a valid email
Re-enter your password
Enter a valid password
Your profile has been successfully updated.
Update
Logout
ENTER
ESC
Eddy AI, facilitating knowledge discovery through conversational intelligence
Search Limit Exceeded. Please upgrade the plan.
Answer copied!
No results found
Provide more context or information so that I can better understand and assist you