Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 2.04 KB

File metadata and controls

44 lines (34 loc) · 2.04 KB

Create Channels

Create a public channel.

Name Requires Auth Permission Setting
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",
        ["funke.olasupo"],
        false
    ]
}

Example Response

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