https://api.netless.link/v5/rooms
| Key |
是否必填 |
类型 |
备注 |
| token |
required |
string |
SDK Token |
| region |
required |
string |
数据中心 ID |
¶ Body Parameters
| Key |
是否必填 |
类型 |
备注 |
| isRecord |
optional |
boolean |
是否开启录制 |
创建成功、返回房间描述对象。
{
"uuid": "d07bcaf0a17911ea9d7e23232cddf42d",
"name": "my first room",
"teamUUID": "177",
"isRecord": false,
"isBan": false,
"createdAt": "2020-05-29T06:58:35.085Z"
}
https://api.netless.link/v5/rooms/{uuid}
| Key |
是否必填 |
类型 |
备注 |
| token |
required |
string |
SDK Token 或 Room Token（只读以上的权限） |
| region |
required |
string |
数据中心 ID |
| Key |
是否必填 |
类型 |
备注 |
| uuid |
required |
string |
房间的 UUID |
返回房间描述对象。
{
"uuid": "d07bcaf0a17911ea9d7e23232cddf42d",
"name": "my first room",
"teamUUID": "177",
"isRecord": false,
"isBan": false,
"createdAt": "2020-05-29T06:58:35.085Z"
}
https://api.netless.link/v5/rooms
| Key |
是否必填 |
类型 |
备注 |
| token |
required |
string |
SDK Token |
| region |
required |
string |
数据中心 ID |
| Key |
是否必填 |
类型 |
备注 |
| beginUUID |
optional |
string |
列表从哪个房间开始（指定 UUID） |
| limit |
optional |
interger |
回列表的最大长度 |
返回房间描述对象列表。
[
{
"uuid": "37875f5089c611eaa629dbb375b5adfc",
"name": "",
"teamUUID": "177",
"isRecord": true,
"isBan": false,
"createdAt": "2020-04-29T03:05:01.716Z"
},
{
"uuid": "3787fb9089c611eaa629dbb375b5adfc",
"name": "",
"teamUUID": "177",
"isRecord": true,
"isBan": false,
"createdAt": "2020-04-29T03:05:01.717Z"
}
]
https://api.netless.link/v5/rooms/{uuid}
| Key |
是否必填 |
类型 |
备注 |
| token |
required |
string |
SDK Token、Room Token（admin 以上的权限） |
| region |
required |
string |
数据中心 ID |
| Key |
是否必填 |
类型 |
备注 |
| uuid |
required |
string |
房间的 UUID |
¶ Body Parameters
| Key |
是否必填 |
类型 |
备注 |
| isRecord |
required |
boolean |
设置 true 表示打开录制开关 |
返回房间描述对象。
{
"uuid": "d07bcaf0a17911ea9d7e23232cddf42d",
"name": "my first room",
"teamUUID": "177",
"isRecord": true,
"isBan": false,
"createdAt": "2020-05-29T06:58:35.085Z"
}
https://api.netless.link/v5/rooms/{uuid}
| Key |
是否必填 |
类型 |
备注 |
| token |
required |
string |
SDK Token、Room Token（admin 以上的权限） |
| region |
required |
string |
数据中心 ID |
| Key |
是否必填 |
类型 |
备注 |
| uuid |
required |
string |
房间的 UUID |
¶ Body Parameters
| Key |
是否必填 |
类型 |
备注 |
| isBan |
required |
boolean |
设置 true 表示封禁，设置 false 表示取消封禁 |
返回房间描述对象。
{
"uuid": "d07bcaf0a17911ea9d7e23232cddf42d",
"name": "my first room",
"teamUUID": "177",
"isRecord": false,
"isBan": true,
"createdAt": "2020-05-29T06:58:35.085Z"
}
https://api.netless.link/v5/rooms/{uuid}/events
| Key |
是否必填 |
类型 |
备注 |
| token |
required |
string |
SDK Token、Room Token（admin 以上的权限） |
| region |
required |
string |
数据中心 ID |
| Key |
是否必填 |
类型 |
备注 |
| uuid |
required |
string |
房间的 UUID |
¶ Body Parameters
| Key |
是否必填 |
类型 |
备注 |
| event |
required |
string |
自定义事件名称 |
| payload |
required |
string |
负载，可以是是任意 JSON 结构 |
返回你发送的自定义事件对象
{
"event": "my-event",
"payload": "my-payload"
}