Documentation Index

Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt

Use this file to discover all available pages before exploring further.

Join Channels (Realtime)

Prev Next

You can only join yourself to public channels, private groups are not joinable. Some public channels require you to enter a joinCode.

Method

Requires Auth

Permission

joinRoom

Yes

view-c-room

Payload parameters

Argument

Example

Required

Description

roomId

jfs9sjcoiown

Required

The room ID to join.

joinCode

4456

Required, if the room requires a code to join.

The code to join the room.

Example call

{
    "msg": "method",
    "method": "joinRoom",
    "id": "99",
    "params": [
        "roomId",
        "joinCode"
    ]
}

Example response

The response from calling the method will return a result of whether the user joined the channel or not.

{
    "msg": "result",
    "id": "99",
    "result": true/false
}