Create a private group.
Method | Requires Auth | Permission |
---|---|---|
| Yes |
|
Payload parameters
Argument | Example | Required | Description |
---|---|---|---|
|
| Required | The name of the channel/group. |
|
| Optional | An array containing the usernames of users to be included in the channel. |
|
| Optional | A Boolean to indicate if the room is read-only or not. |
|
| Optional | Custom fields for the channel. |
| Optional | Any extra data to associate with the channel. |
Example call
{
"msg": "method",
"method": "createPrivateGroup",
"id": "44728",
"params": [
"testrc7",
["test.queue"],
true
]
}
Example response
{
"msg": "result",
"id": "44728",
"result": {
"rid": "64e543ff5fb08444f3a71f94",
"inserted": true,
"_id": "64e543ff5fb08444f3a71f94",
"_updatedAt": {
"$date": 1692746751431
},
"fname": "testrc7",
"customFields": {},
"name": "testrc7",
"t": "p",
"msgs": 0,
"usersCount": 0,
"u": {
"_id": "4SebuZCHhQKvTt23o",
"username": "funke.olasupo",
"name": "Funke Olasupo"
},
"ts": {
"$date": 1692746751431
},
"ro": true,
"default": false,
"sysMes": true
}
}
Changelog
Version | Description |
---|---|
0.38.0 | Added |