You need to enable JavaScript to run this app.
导航
更新伪直播配置信息
最近更新时间:2025.02.20 21:04:57首次发布时间:2024.06.19 11:42:26

调用 UpdateLoopVideos 接口,更新指定直播间中指定直播频道的伪直播配置信息,包括伪直播类型、伪直播视频名称和 Vid、绑定的互动脚本 ID 等。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
ActivityIdLong1776****89138直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
LineIdLong123直播频道 ID。您可通过调用 GetStreamsAPI 接口获取 ID。

PlayType

Integer

0

伪直播类型。默认值为 0。取值如下:

  • 0:按次数伪直播
  • 1:按时间段伪直播

说明

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

  • PlayType 取值为 0 时,将按照基础信息页面设置的直播时间或 UpdateActivityBasicConfigAPI 接口中的 LiveTime(直播开始时间)自动开始伪直播。
  • PlayType 取值为 1 时,将根据以下规则进行处理:
    • 如果基础信息页面设置的直播时间或 UpdateActivityBasicConfigAPI 接口中的 LiveTime(直播开始时间)小于等于当前接口的 AutoStartTime(伪直播自动开始时间),则根据直播时间或 LiveTime 自动开始伪直播,并在到达 AutoEndTime(伪直播自动结束时间)时自动结束伪直播。
    • 如果基础信息页面设置的直播时间或 UpdateActivityBasicConfigAPI 接口中的 LiveTime(直播开始时间)大于当前接口的 AutoStartTime(伪直播自动开始时间)且小于 AutoEndTime(伪直播自动结束时间),则根据 AutoStartTimeAutoEndTime 开始和结束伪直播。
    • 如果基础信息页面设置的直播时间或 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 时,该参数必选且生效。

IsShowProgram

Integer

0

是否在观看页展示节目单,即伪直播视频列表。默认值为 0。取值如下:

  • 0:不展示
  • 1:展示。仅在视频列表中存在 2 个及以上视频时,支持展示节目单

ProgramName

String

节目单

节目单名称。长度为 1 到 8 个字符。

说明

IsShowProgram 取值为 1 时,该参数必选且生效。

LoopVideos

Array of LoopVideos

-

伪直播视频列表。

说明

  • 为避免已有伪直播视频被误删或配置信息被清空或替换为默认值,您必须将不需要删除和更新的伪直播视频信息传入该接口。您可调用 ListLoopVideos 接口,通过返回参数 LoopVideos 获取当前直播频道下的所有伪直播视频信息。
  • 最多支持配置 50 个伪直播视频且视频总大小需小于等于 200 GB。

LoopVideos

参数类型是否必选示例值描述
IndexLong1伪直播视频序号。该参数取值为从 1 开始的连续且不重复的整数,如 123。取值范围为 [1,50]。取值越小,在伪直播视频列表中的位置越靠前。
VideoNameString视频.mp4伪直播视频名称。
VideoVidStringv02a49370000br****vm75gbiokkno91伪直播视频 Vid。您可通过调用 ListActivityMediaAPI 接口获取 Vid。
OffsetInteger10伪直播启动时刻。单位为秒。例如参数取值为 10,则从视频的第 10 秒开始播放。

InteractionScriptEnabled

Boolean

true

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

  • true:开启
  • false:关闭

InteractionScriptId

Long

1

伪直播视频绑定的互动脚本 ID。您可通过调用 CreateInteractionScript 接口创建空白互动脚本并将其绑定至该伪直播视频。
绑定互动脚本后,在伪直播视频播放到指定时间节点时,会按照互动脚本配置的用户身份和昵称,发送预设的评论内容。

注意

  • InteractionScriptEnabled 取值为 true 时,参数 InteractionScriptIdIndexVideoNameVideoVidOffset 必选且生效。
  • 一个互动脚本仅支持绑定一个伪直播视频或媒资库视频。
  • 如果 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 时生效。

IsShowProgram

Integer

0

是否在观看页展示节目单,即伪直播视频列表。取值如下:

  • 0:不展示
  • 1:展示

ProgramName

String

节目单

节目单名称。

说明

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

LoopVideosArray of LoopVideos-伪直播视频列表。

LoopVideos

参数类型示例值描述
IndexInteger1伪直播视频序号。取值范围为 [1,50]。取值越小,在伪直播视频列表中的位置越靠前。
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,
    "LoopNumber": 3,
    "IsShowProgram": 0,
    "PlayType": 0,
    "AutoStartTime": 1736823565,
    "AutoEndTime": 1736923565,
    "ProgramName": "节目单",
    "LoopVideos": [
        {
            "Index": 1,
            "VideoName": "视频.mp4",
            "VideoVid": "v02a49370000br****vm75gbiokkno91",
            "Offset": 10,
            "InteractionScriptId": 1,
            "InteractionScriptEnabled": true
        }
    ]
}

返回示例

{
    "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": 3,
        "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
    }
}

错误码

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