创建房间

更新时间不可用

创建一个实时互动房间。

POST
https://api.netless.link/v5/rooms

请求 Header

tokenstring
必填

SDK Token,可以通过以下方式获取:

regionstring
必填

指定处理该请求的数据中心,取值如下:

  • cn-hz:中国杭州,服务区覆盖中国大陆地区及其他数据中心未覆盖的区域。

  • us-sv:美国硅谷,服务区覆盖北美洲、南美洲。

  • sg:新加坡,服务区覆盖新加坡、东亚、东南亚。

  • in-mum:印度孟买,服务区覆盖印度。

  • eu:欧洲(法兰克福),服务区覆盖欧洲。

请求 Body

isRecordboolean

是否开启录制:

  • true:开启。

  • false: 不开启。 仅 cn-hz 区域的 isRecord 字段默认值为 true。开启白板录制将产生费用,如果你没有录制需求,需手动传入 false。

响应

若返回的状态码为 201 则表示请求成功。响应 Body 中包含本次请求的结果。

若返回的状态码不为 201 则表示请求失败。你可以参考响应状态码了解可能的原因。

响应 Body

uuidstring

房间的 UUID,即房间的全局唯一标识符。

teamUUIDstring

互动白板控制台账号的唯一标识符。

appUUIDstring

互动白板项目的唯一标识符。

isRecordboolean

房间是否开启录制:

  • true:开启。

  • false: 不开启。

isBanboolean

房间是否被封禁:

  • true:已封禁。

  • false: 未封禁。

createdAtstring

创建房间的 UTC 时间。

limitinteger

已废弃,值固定为 0。

请求示例

Example Request
curl --request POST \
  --url "https://api.netless.link/v5/rooms" \
  --header 'token: <string>' \
  --header 'region: cn-hz' \
  --header 'Content-Type: application/json'

响应示例

{
  "uuid": "房间的 UUID,即房间的全局唯一标识符。     ",
  "teamUUID": "互动白板控制台账号的唯一标识符。     ",
  "appUUID": "互动白板项目的唯一标识符。",
  "isRecord": true,
  "isBan": true,
  "createdAt": "创建房间的 UTC 时间。   ",
  "limit": null
}