Create Private Groups (Realtime)

Create a private channel.

Method	Requires Auth	Permission
`createPrivateGroup`	Yes	`create-p`

Payload parameters

Argument	Example	Required	Description
`name`	`channelname`	Required	The name of the channel.
`members`	`["test.rc"]`	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.

Argument

Example

Required

Description

name

channelname

Required

The name of the channel.

members

["test.rc"]

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.

Example call

{
    "msg": "method",
    "method": "createPrivateGroup",
    "id": "8d89",
    "params": [
         "test-private-websockset",
        ["rocket.cat"]
    ]
}

Example response

{
    "msg": "result",
    "id": "8d89",
    "result": {
        "rid": "64a37803730ef04d3db2556f",
        "inserted": true,
        "fname": "test-private-websockset",
        "_updatedAt": {
            "$date": 1688434691876
        },
        "customFields": {},
        "name": "test-privadte-websockset",
        "t": "p",
        "msgs": 0,
        "usersCount": 0,
        "u": {
            "_id": "LFdhbcNHx5zsMA7T4",
            "username": "test.rc",
            "name": "Test RC"
        },
        "ts": {
            "$date": 1688434691876
        },
        "ro": false,
        "default": false,
        "sysMes": true,
        "_id": "64a37803730ef04d3db2556f"
    }
}