跳到主要内容

RESTful

Android

iOS

Web

RESTful

API 概述

Endpoints

生成 Token

房间管理

获取房间列表

获取房间信息

场景管理

截图管理

文档转换

旧版文档转换

Schemas

currentScenePath

region-screenshot

webhookEndpoint

imageCompressionLevel

convertedPercentage

powered by Stoplight

获取房间信息

get

https://api.netless.link

/v5/rooms/{uuid}

获取指定房间的信息。

Request

Path Parameters

uuid

string

required

房间的 UUID, 即房间的全局唯一标识符，可通过调用创建房间 API 或获取房间信息 API 获取。

Headers

region

required

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

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

us-sv：美国硅谷，服务区覆盖北美洲、南美洲。

sg：新加坡，服务区覆盖新加坡、东亚、东南亚。

in-mum：印度孟买，服务区覆盖印度。

eu：欧洲（法兰克福），服务区覆盖欧洲。

Allowed values:

cn-hzus-svsgin-mumeu

token

string

required

SDK Token，可以通过以下方式获取：

在声网控制台生成用于测试的 SDK Token，详见获取互动白板项目的安全密钥。

调用服务端 RESTful API，详见生成 SDK Token。

在 app 服务端用代码生成，详见在 app 服务端生成 Token。

Example:

NETLESSSDK_YWs9xxxxxxM2MjRi

Responses

200

若返回的状态码为 200 则表示请求成功。响应包体中包含本次请求的结果。
若返回的状态码不为 200 则表示请求失败。你可以参考响应状态码了解可能的原因。

Body

responses

/

200

uuid

string

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

teamUUID

string

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

appUUID

string

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

isRecord

boolean

房间是否开启录制：

true：开启。

false: 不开启。

isBan

boolean

房间是否被封禁：

true：已封禁。

false: 未封禁。

createdAt

string

创建房间的 UTC 时间。

Example:

2021-01-18T06:56:29.432Z

limit

integer

房间内可写人数（拥有 writer 或 admin 权限的用户）的上限。如果值为 0，则表示无限制。

Parameters

:

:

:

curl --request GET \
  --url https://api.netless.link/v5/rooms/uuid \
  --header 'Accept: application/json' \
  --header 'region: cn-hz' \
  --header 'token: '

Response Example

1
{
2
  "uuid": "4axxxxx96b",
3
  "teamUUID": "RMmxxxxx5aw",
4
  "appUUID": "i5xxxxx1AQ",
5
  "isRecord": true,
6
  "isBan": false,
7
  "createdAt": "2021-01-18T06:56:29.432Z",
8
  "limit": 0
9
}