logo
实时音视频
服务端 API
场景服务接口
当前页

SetSceneTemplate

GET

https://metaworld-api.zego.im/

Express 支持自定义场景模版配置,用于登录到对应配置的场景。 当系统预置的配置模板无法满足您的业务需求时,您可以通过该服务端 API 创建自定义模板,设置相关参数。

注意

自定义模板上限为 50,如果您需要更多的模板数量,请联系 ZEGO 技术支持。

调用频率限制
同一个 AppID 下所有房间:50 次/秒
说明

测试环境下(详见 IsTest 公共参数说明),流 ID 需要加上 “zegotest-AppId-” 前缀。例如,流 ID 为 “test”,在 AppId 为 “123456789” 的测试环境下,流 ID 应为 “zegotest-123456789-test”。

-------------------------------------------(RightUpX, RightUpZ)
|	                                                            |
|	                                                            |
|	                                                            |
|	                                                            |
(LeftBottomX, LeftBottomZ)-------------------------------------
注意

模板配置更改后,正在使用该模板的场景不会立刻生效,需等待场景销毁后(场景中全部用户退出 10 分钟后,该场景会被自动销毁),重新创建才可生效。

Request

Query Parameters

    Action string必填

    可选值: [SetSceneTemplate]

    接口原型参数

    https://metaworld-api.zego.im/?Action=SetSceneTemplate

    SignatureNonce string必填

    💡公共参数。随机字符串。

    Timestamp int64必填

    💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。

    Signature string必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

    💡公共参数。签名版本号。

    IsTest string

    可选值: [false, true]

    默认值: false

    💡公共参数。是否为测试环境。设为 true 表示使用测试环境。 2021-11-16 及之前在 ZEGO 控制台 创建的项目默认是测试环境,可根据业务需求设置此参数;而之后创建的项目默认是正式环境。

    ⚠️注意:测试环境跟正式环境是隔离的,请不要在操作正式环境 appid 时误把该参数标记为 true。2021-11-16 及之后创建的项目建议不要填写该参数

    📌是否必填参数:2021-11-16 及之前在 ZEGO 控制台创建的项目为必填,之后创建的则不是必填。

    AppId number必填

    应用 AppID。

    TemplateId number必填

    模板 ID。

    LeftBottomX float

    地图左下角横坐标(见上图)。

    LeftBottomZ float

    地图左下角纵坐标(见上图)。

    RightUpX float

    地图右上角横坐标(见上图)。

    RightUpZ float

    地图右上角纵坐标(见上图)。

    MaxUserNum int32必填

    场景人数上限。

    ViewRadius int32必填

    AOI 半径(用户视野半径)。

    MaxVisibleNum int32必填

    AOI 人数上限

    本端用户的AOI范围内,可视远端用户数的上限,人数上限最多 100。

Responses

成功
Schema
    Code int32

    错误码。 以下仅列出了接口业务逻辑相关的部分返回码,完整返回码请参考 全局返回码

    返回码说明处理建议
    340004003模版已存在。设置其他模版 ID。
    340006003参数错误。根据错误提示设置正确的请求参数。
    Message string

    错误信息描述

    RequestId string

    请求 ID

    Data objectnullable

    返回数据内容


Request
折叠所有
Base URL
https://metaworld-api.zego.im
Parameters
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query
query
query
query
query
RESPONSE清除

点击上方 “发送” 按钮,在此处查看响应。

Previous

音视频流审核鉴权 Token

Next

回调配置说明

当前页

返回到顶部