API 概述
Overview
Endpoints
生成 Token
房间管理
创建房间
post
获取房间列表
get
获取房间信息
get
封禁房间
patch
场景管理
截图管理
文档转换
旧版文档转换
Schemas
ak
sk
lifespan
role
isRecord
limit
uuid
teamUUID
appUUID
R-isRecord
isBan
createdAt
R-limit
P-isBan
scenes
ppt
path-scene
scenePath
currentScenePath
width
height
path
url
key
bucket
region-screenshot
resource
type
preview
scale
outputFormat
webhookEndpoint
webhookRetry
imageCompressionLevel
uuid
status
taskId
prefix
pageCount
previews
note
images
convertedPercentage
errorCode
errorMessage
powered by Stoplight
获取房间信息
get
https://api.netless.link
/v5/rooms/{uuid}
获取指定房间的信息。
uuid
string房间的 UUID, 即房间的全局唯一标识符,可通过调用创建房间 API 或获取房间信息 API 获取。
region
指定处理该请求的数据中心,取值如下:
cn-hz
:中国杭州,服务区覆盖中国大陆地区及其他数据中心未覆盖的区域。us-sv
:美国硅谷,服务区覆盖北美洲、南美洲。sg
:新加坡,服务区覆盖新加坡、东亚、东南亚。in-mum
:印度孟买,服务区覆盖印度。eu
:欧洲(法兰克福),服务区覆盖欧洲。 Allowed values:
cn-hzus-svsgin-mumeu
token
stringSDK Token,可以通过以下方式获取:
Example:
NETLESSSDK_YWs9xxxxxxM2MjRi
Responses
200
若返回的状态码为 200
则表示请求成功。响应包体中包含本次请求的结果。
若返回的状态码不为 200
则表示请求失败。你可以参考响应状态码了解可能的原因。
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
,则表示无限制。
:::
curl --request GET \--url https://api.netless.link/v5/rooms/uuid \--header 'Accept: application/json' \--header 'region: cn-hz' \--header 'token: '
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": 09}