生成场景截图
更新时间不可用
对指定场景进行截图。
POST
https://api.netless.link/v5/rooms/{uuid}/screenshots注意
后端截图相关 API 已废弃，请改用前端截图 API：screenshotToCanvasAsync。
uuidstring必填
房间的 UUID, 即房间的全局唯一标识符，可通过调用创建房间 API 或获取房间信息 API 获取。
regionstring必填
指定处理该请求的数据中心，取值如下：
-
cn-hz：中国杭州，服务区覆盖中国大陆地区及其他数据中心未覆盖的区域。 -
us-sv：美国硅谷，服务区覆盖北美洲、南美洲。 -
sg：新加坡，服务区覆盖新加坡、东亚、东南亚。 -
in-mum：印度孟买，服务区覆盖印度。 -
eu：欧洲（法兰克福），服务区覆盖欧洲。
tokenstring必填
SDK Token，可以通过以下方式获取：
-
在声网控制台生成用于测试的 SDK Token，详见获取互动白板项目的安全密钥。
-
调用服务端 RESTful API， 详见生成 SDK Token。
-
在 App 服务端用代码生成，详见在 App 服务端生成 Token。
widthnumber必填
截图的宽度，单位为像素。
heightnumber必填
截图的高度，单位为像素。
pathstring需要截图的场景路径，以 / 开头。如果不传，默认获取 /init 场景的截图。
响应
若返回的状态码为 201 则表示请求成功。响应 Body 中包含本次请求的结果。
若返回的状态码不为 201 则表示请求失败。你可以参考响应状态码了解可能的原因。
响应 Body
urlstring截图的 URL。
keystring截图在存储空间内的文件名。
bucketstring截图存放的存储空间名称。
regionstring截图存放的存储空间所属地域。
请求示例
curl --request POST \
--url "https://api.netless.link/v5/rooms/:uuid/screenshots" \
--header 'region: cn-hz' \
--header 'token: <string>' \
--header 'Content-Type: application/json'响应示例
{
"url": "https://white-cover.oss-cn-hangzhou.aliyuncs.com/room_cover/2811/a7exxxxca69undefined.png",
"key": "room_cover/2811/a7exxxxxca69undefined.png",
"bucket": "white-cover",
"region": "oss-cn-hangzhou"
}