插入新场景

更新时间不可用

插入新场景。

POST
https://api.netless.link/v5/rooms/{uuid}/scenes

路径参数

uuidstring
必填

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

请求 Header

regionstring
必填

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

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

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

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

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

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

tokenstring
必填

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

请求 Body

字段

由场景组成的数组。

namestring
必填

场景名称,不能与所属场景组下的其他场景重名,不能包含 /。

场景背景图的属性。

pathstring
必填

场景组的地址。

说明

如果传入的场景组地址已经存在,则在已有的场景组下插入指定的新场景;如果传入的场景组地址不存在,则自动新建一个场景组并在该场景组下插入指定的新场景。

响应

若返回的状态码为 201 则表示请求成功。响应 Body 为空对象。

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

响应 Body

Schema 中没有字段

请求示例

Example Request
curl --request POST \
  --url "https://api.netless.link/v5/rooms/:uuid/scenes" \
  --header 'region: cn-hz' \
  --header 'token: <string>' \
  -H 'Content-Type: application/json' \
  -d '{
  "scenes": [
    {
      "name": "page1",
      "ppt": {
        "src": "xxxx",
        "width": 640,
        "height": 360
      }
    },
    {
      "name": "page2",
      "ppt": {
        "src": "xxxx",
        "width": 640,
        "height": 360
      }
    }
  ],
  "path": "/test"
}'

响应示例

{}