You need to enable JavaScript to run this app.
导航
GetInteractionScriptRecordConfig - 获取直播间互动脚本录制配置
最近更新时间:2025.04.16 11:00:02首次发布时间:2025.04.16 11:00:02
我的收藏
有用
有用
无用
无用

调用 GetInteractionScriptRecordConfig 接口,获取指定直播间的互动脚本录制配置,即直播开始后,是否会将直播期间的聊天和商品信息作为脚本录制到回放视频中。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 前提条件:确保您拥有火山引擎主账号或具备直播间的观看页管理 > 仅查看可编辑权限的子账号。有关如何添加子账号,详见子账号管理

请求说明

  • 请求方式:GET
  • 请求地址:https://livesaas.volcengineapi.com/?Action=GetInteractionScriptRecordConfig&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数

Query

参数类型是否必选示例值描述
ActionStringGetInteractionScriptRecordConfig接口名称。当前 API 的名称为 GetInteractionScriptRecordConfig
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01

ActivityId

Long

181527****690451

直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

说明

使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理

返回参数

参数类型示例值描述
ConfigObject of Config-互动脚本录制配置。

Config

参数类型示例值描述

EnableComment

Boolean

true

直播开始后,是否会将直播期间的聊天作为脚本录制到回放视频中。取值如下:

  • true:录制
  • false:不录制

EnableProductCard

Boolean

false

直播开始后,是否会将直播期间的商品信息作为脚本录制到回放视频中。取值如下:

  • true:录制
  • false:不录制

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetInteractionScriptRecordConfig&Version=2023-08-01&ActivityId=181527****690451

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetInteractionScriptRecordConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Config": {
            "EnableComment": true,
            "EnableProductCard": false
        }
    }
}

错误码

访问公共错误码错误码获取详细信息。