You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/录播直播/UpdateLoopVideos - 更新录播直播配置信息
UpdateLoopVideos - 更新录播直播配置信息
最近更新时间：2025.08.27 16:38:29首次发布时间：2024.06.19 11:42:26
复制全文
我的收藏
有用
有用
无用
无用

调用 UpdateLoopVideos接口，更新指定直播间中录播直播的配置信息，包括录播直播类型、录播直播视频名称、Vid、启动时刻，以及绑定的互动脚本 ID 等。

注意事项

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

请求说明

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

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

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

Body

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

ActivityId

Long

是

1776****89138

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

说明

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

LineId

Long

是

123

直播频道 ID。您可通过调用 GetStreamsAPI接口获取 ID。

说明

确保直播间内仅存在一个直播频道。

PlayType

Integer

否

0

录播直播类型。默认值为 0。取值如下：

  • 0：按次数录播直播
  • 1：按时间段录播直播

说明

如果您在控制台的观看页管理 > 基础信息页面打开自动开播开关并选择开始录播直播，或者调用 UpdateActivityBasicConfigAPI 接口并将 IsAutoStartEnable 和 AutoStartType 的参数值均设置为 1，则：

  • 当 PlayType 取值为 0 时，将按照基础信息页面设置的直播时间或 UpdateActivityBasicConfigAPI 接口中的 LiveTime（直播开始时间）自动开始录播直播。
  • 当 PlayType 取值为 1 时，将根据以下规则进行处理：
    • 如果基础信息页面设置的直播时间或 UpdateActivityBasicConfigAPI 接口中的 LiveTime（直播开始时间）小于等于当前接口的 AutoStartTime（录播直播自动开始时间），则根据直播时间或 LiveTime 自动开始录播直播，并在到达 AutoEndTime（录播直播自动结束时间）时自动结束录播直播。
    • 如果基础信息页面设置的直播时间或 UpdateActivityBasicConfigAPI 接口中的 LiveTime（直播开始时间）大于当前接口的 AutoStartTime（录播直播自动开始时间）且小于 AutoEndTime（录播直播自动结束时间），则根据 AutoStartTime 和 AutoEndTime 开始和结束录播直播。
    • 如果基础信息页面设置的直播时间或 UpdateActivityBasicConfigAPI 接口中的 LiveTime（直播开始时间）大于等于当前接口的 AutoEndTime（录播直播自动结束时间），则不进行录播直播。

LoopNumber

Integer

否

3

录播直播次数。默认值为 1。取值范围为 [1,50]。例如，参数取值为 3，则录播直播开始后，录播直播视频列表会循环播放 3 次。

说明

当 PlayType 取值为 0 时，该参数必选且生效。

AutoStartTime

Long

否

1736823565

录播直播自动开始时间。Unix 时间戳，单位为秒。支持精确到分钟级开播。
在录播直播自动开始和结束的时间段内，录播直播视频列表会循环播放。
该参数取值需同时满足以下条件：

  • 大于等于当前时间 + 300，即当前时间 5 分钟及之后的某个时间点。
  • 小于 AutoEndTime 的取值，且与 AutoEndTime 的差值最大为 259,200，即 72 小时。

说明

当 PlayType 取值为 1 时，该参数必选且生效。

AutoEndTime

Long

否

1736923565

录播直播自动结束时间。Unix 时间戳，单位为秒。支持精确到分钟级开播。
在录播直播自动开始和结束的时间段内，录播直播视频列表会循环播放。
该参数取值需大于 AutoStartTime 的取值，且与 AutoStartTime 的差值最大为 259,200，即 72 小时。

说明

当 PlayType 取值为 1 时，该参数必选且生效。

LoopVideosArray of LoopVideos否-录播直播视频信息。视频总大小需小于等于 200 GB。

LoopVideos

参数类型是否必选示例值描述
IndexLong是1录播直播视频序号。取值固定为 1 。
VideoNameString是视频.mp4录播直播视频名称。

VideoVid

String

是

v02a49370000br****vm75gbiokkno91

录播直播视频 Vid。您可通过调用 ListActivityMediaAPI 接口获取 Vid。

说明

使用子账号调用接口时，确保视频对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。

OffsetInteger是10录播直播视频的启动时刻。单位为秒。例如参数取值为 10，则从视频的第 10 秒开始播放。

InteractionScriptEnabled

Boolean

否

true

是否开启互动脚本。默认值为 false。取值如下：

  • true：开启
  • false：关闭

InteractionScriptId

Long

否

1

录播直播视频绑定的互动脚本 ID。您可通过调用 CreateInteractionScript 接口创建空白互动脚本并将其绑定至该录播直播视频。
绑定互动脚本后，在录播直播视频播放到指定时间节点时，会按照脚本中配置的上下架时间、讲解起止时间和商品信息展示商品，从而降低运营人力成本、提高商品曝光率、丰富直播带货场景。

注意

  • 当 InteractionScriptEnabled 取值为 true 时，参数 InteractionScriptId、Index、VideoName、VideoVid 和 Offset 必选且生效。
  • 一个互动脚本仅支持绑定一个录播直播视频或媒资库视频。
  • 如果 InteractionScriptEnabled 取值为 true 且当前参数取值为 0，则会复制对应视频库视频的互动脚本，并将其绑定到该录播直播视频。 如果对应视频库视频未绑定互动脚本，则该录播直播视频也不会绑定互动脚本。

返回参数

参数类型示例值描述
ActivityIdLong1776****89138直播间 ID。
LineIdLong123直播频道 ID。

PlayType

Integer

0

录播直播类型。取值如下：

  • 0：按次数录播直播
  • 1：按时间录播直播

LoopNumber

Integer

3

录播直播次数。例如，参数取值为 3，则录播直播开始后，录播直播视频列表会循环播放 3 次。

说明

该参数仅在 PlayType 取值为 0 时生效。

AutoStartTime

Long

1736823565

录播直播自动开始时间。Unix 时间戳，单位为秒。支持精确到分钟级开播。
在录播直播自动开始和结束的时间段内，录播直播视频列表会循环播放。

说明

该参数仅在 PlayType 取值为 1 时生效。

AutoEndTime

Long

1736923565

录播直播自动结束时间。Unix 时间戳，单位为秒。支持精确到分钟级开播。
在录播直播自动开始和结束的时间段内，录播直播视频列表会循环播放。

说明

该参数仅在 PlayType 取值为 1 时生效。

IsShowProgramInteger0已废弃。
ProgramNameString节目单已废弃。
LoopVideosArray of LoopVideos-录播直播视频信息。

LoopVideos

参数类型示例值描述
IndexInteger1录播直播视频序号。取值固定为 1。
VideoCoverImageStringhttps://www.example.com/a.png录播直播视频封面图，包含协议头。
VideoNameString视频.mp4录播直播视频名称。
VideoVidStringv02a49370000br****vm75gbiokkno91录播直播视频 Vid。
OffsetInteger10录播直播视频的启动时刻。单位为秒。例如参数取值为 10，则从视频的第 10 秒开始播放。

ReviewStatus

Integer

2

录播直播视频的审核状态。取值如下：

  • 1：审核中
  • 2：审核成功
  • 3：审核失败

InteractionScriptEnabled

Boolean

true

是否开启互动脚本。取值如下：

  • true：开启
  • false：不开启
InteractionScriptIdLong1录播直播视频绑定的互动脚本 ID。取值为 0表示该录播直播视频未绑定互动脚本。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateLoopVideos&Version=2023-08-01
{
    "ActivityId": 1776****89138,
    "LineId": 123,
    "LoopVideos": [
        {
            "Index": 1,
            "VideoName": "视频.mp4",
            "VideoVid": "v02a49370000br****vm75gbiokkno91",
            "Offset": 10,
            "InteractionScriptEnabled": true,
            "InteractionScriptId": 1
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateLoopVideos",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "ActivityId": 1776****89138,
        "LineId": 123,
        "LoopNumber": 1,
        "LoopVideos": [
            {
                "Index": 1,
                "VideoCoverImage": "https://www.example.com/a.png",
                "VideoName": "视频.mp4",
                "VideoVid": "v02a49370000br****vm75gbiokkno91",
                "ReviewStatus": 2,
                "Offset": 10,
                "InteractionScriptEnabled": true,
                "InteractionScriptId": 1
            }
        ],
        "IsShowProgram": 0,
        "ProgramName": "节目单",
        "AutoStartTime": 1736823565,
        "AutoEndTime": 1736923565,
        "PlayType": 0
    }
}

错误码

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

状态码错误码错误信息说明
403OperationDenied.EditLivingConfigOperation is denied because the live has started and cannot be edited.直播期间无法更新录播直播配置信息。请等待直播结束后重试。
403OperationDenied.ActivityLineExceedLimitOperation is denied because the number of activity line exceeds the limit.录播直播仅支持单频道。当前直播间的直播频道数已超出上限 1。请删除部分直播频道，确保直播间中仅保留一个直播频道。
403OperationDenied.VideoDurationInvalidOperation is denied because video duration is too short.录播直播视频时长过短。请确保视频时长大于等于 1 秒。