获取房间列表
更新时间不可用
获取房间列表。
GET
https://api.netless.link/v5/roomsbeginUUIDstring查询的起始房间的 UUID。
limitstring返回的房间列表的最大长度,取值范围为 (0,1000]。如果不填,则最多返回 100 条房间信息。
regionstring必填
指定处理该请求的数据中心,取值如下:
-
cn-hz:中国杭州,服务区覆盖中国大陆地区及其他数据中心未覆盖的区域。 -
us-sv:美国硅谷,服务区覆盖北美洲、南美洲。 -
sg:新加坡,服务区覆盖新加坡、东亚、东南亚。 -
in-mum:印度孟买,服务区覆盖印度。 -
eu:欧洲(法兰克福),服务区覆盖欧洲。
tokenstring必填
SDK Token,可以通过以下方式获取:
-
在声网控制台生成用于测试的 SDK Token,详见获取互动白板项目的安全密钥。
-
调用服务端 RESTful API, 详见生成 SDK Token。
-
在 App 服务端用代码生成,详见在 App 服务端生成 Token。
响应
若返回的状态码为 200 则表示请求成功。响应 Body 中包含本次请求的结果。
若返回的状态码不为 200 则表示请求失败。你可以参考响应状态码了解可能的原因。
响应 Body
uuidstring房间的 UUID,即房间的全局唯一标识符。
teamUUIDstring互动白板控制台账号的唯一标识符。
appUUIDstring互动白板项目的唯一标识符。
isRecordboolean房间是否开启录制:
-
true:开启。 -
false: 不开启。
isBanboolean房间是否被封禁:
-
true:已封禁。 -
false: 未封禁。
createdAtstring创建房间的 UTC 时间。
limitinteger已废弃,值固定为 0。
请求示例
curl --request GET \
--url "https://api.netless.link/v5/rooms" \
--header 'region: cn-hz' \
--header 'token: <string>'响应示例
{
"uuid": "房间的 UUID,即房间的全局唯一标识符。 ",
"teamUUID": "互动白板控制台账号的唯一标识符。 ",
"appUUID": "互动白板项目的唯一标识符。",
"isRecord": true,
"isBan": true,
"createdAt": "创建房间的 UTC 时间。 ",
"limit": null
}