场景跳转

更新时间不可用

当房间内存在多个场景或场景组,可调用该 API 切换场景。

PATCH
https://api.netless.link/v5/rooms/{uuid}/scene-state

路径参数

uuidstring
必填

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

请求 Header

regionstring
必填

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

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

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

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

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

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

tokenstring
必填

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

请求 Body

string
必填

要切换到的场景的地址。

响应

若返回的状态码为 201 则表示请求成功。响应 Body 中包含本次请求的结果。

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

响应 Body

currentScenePatharray<string>

当前的场景地址,由场景组和场景名组成的数组。

请求示例

Example Request
curl --request PATCH \
  --url "https://api.netless.link/v5/rooms/:uuid/scene-state" \
  --header 'region: cn-hz' \
  --header 'token: <string>' \
  --header 'Content-Type: application/json'

响应示例

{
  "currentScenePath": [
    "test",
    "page1"
  ]
}