RESTful

Android

iOS

Web

RESTful

API 概述

Overview

Endpoints

生成 Token

房间管理

场景管理

截图管理

文档转换

旧版文档转换

Schemas

imageCompressionLevel

生成场景截图

post

https://api.netless.link

/v5/rooms/{uuid}/screenshots

对指定场景进行截图。

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

Body

width

number

required

截图的宽度，单位为像素。

Example:

640

height

number

required

截图的高度，单位为像素。

Example:

480

path

string

需要截图的场景路径，以 / 开头。如果不传，默认获取 /init 场景的截图。

Default:

/init

Responses

201

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

Body

responses

201

url

string

截图的 URL。

Example:

https://white-cover.oss-cn-hangzhou.aliyuncs.com/room_cover/2811/a7exxxxca69undefined.png

key

string

截图在存储空间内的文件名。

Example:

room_cover/2811/a7exxxxxca69undefined.png

bucket

string

截图存放的存储空间名称。

Example:

white-cover

region

string

截图存放的存储空间所属地域。

Example:

oss-cn-hangzhou

Parameters

Body

{
  "width": 640,
  "height": 480,
  "path": "/init"
}

1
{
2
  "width": 640,
3
  "height": 480,
4
  "path": "/init"
5
}

curl --request POST \
  --url https://api.netless.link/v5/rooms/uuid/screenshots \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'region: cn-hz' \
  --header 'token: ' \
  --data '{
  "width": 640,
  "height": 480,
  "path": "/init"
}'

Response Example

1
{
2
  "url": "https://white-cover.oss-cn-hangzhou.aliyuncs.com/room_cover/2811/a7exxxxca69undefined.png",
3
  "key": "room_cover/2811/a7exxxxxca69undefined.png",
4
  "bucket": "white-cover",
5
  "region": "oss-cn-hangzhou"
6
}