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

调用 UpdateInteractionScriptRecordConfig 接口,更新指定直播间的互动脚本录制配置。

使用说明

接口行为

  • 在直播开始前,将 EnableComment 取值设置为 true:直播开始后,直播期间的聊天会作为脚本被录制到回放视频中。直播结束后,您可以将回放视频添加为录播直播视频。在播放录播直播视频时,将按照脚本中的用户身份和昵称发送预设的评论内容。详见聊天脚本
  • 在直播开始前,将 EnableProductCard 取值设置为 true:直播开始后,直播期间的商品信息会作为脚本被录制到回放视频中。直播结束后,您可以将回放视频添加为录播直播视频。在播放录播直播视频时,将按照脚本中的上下架时间、讲解起止时间和商品信息展示商品。详见商品脚本

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述

ActivityId

Long

18444****164258

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

说明

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

Config

Object of Config

-

互动脚本录制配置。

注意

直播期间无法更新互动脚本录制配置,请在直播开始前完成配置。

Config

参数类型是否必选示例值描述

EnableComment

Boolean

true

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

  • true:录制
  • false:不录制

EnableProductCard

Boolean

false

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

  • true:录制
  • false:不录制

返回参数

本接口无特有的返回参数。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateInteractionScriptRecordConfig&Version=2023-08-01
{
    "Config": {
        "EnableComment": true,
        "EnableProductCard": false
    },
    "ActivityId": 18444****164258
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateInteractionScriptRecordConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    }
}

错误码

下表提供了该接口特有的错误码,公共错误码请参见公共错误码错误码文档。

状态码错误码错误信息说明
403OperationDenied.LiveIsLivingOperation is denied because the live room status is live.直播期间无法更新互动脚本录制配置。请结束直播后重试。