Create Channels (Realtime)

Prev Next

Create a public channel.

Method

Requires Auth

Permission

createChannel

Yes

create-c

Payload parameters

Argument

Example

Required

Description

name

channelname

Required

The name of the channel.

members

["rocket.cat"]

Optional; Default: []

An array of usernames, represented as strings, for the users designated to be included in the channel. If the array is empty, only the user making the request to this method will be added to the channel.

readOnly

true

Optional; Default: false

Set if the channel is read-only or not. The value must be boolean.

Example call

{
    "msg": "method",
    "method": "createChannel",
    "id": "2",
    "params": [
        "test-websocket",
        ["doe.john"],
        false
    ]
}

Example response

{
    "msg": "result",
    "id": "2",
    "result": [
        { "rid": "BBkfgYT2azf7RPTTg" }
    ]
}