新增或更新节目单配置信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

新增或更新节目单配置信息

最近更新时间：2024.06.19 11:42:27首次发布时间：2024.06.19 11:42:27

您可通过此接口新增节目单，或更新已有节目单的视频列表、节目单名称等配置信息。

使用说明

接口行为

通过本接口的 Id 参数，您可以新增和更新节目单。

新增节目单：在请求参数中不传 Id（节目单 ID）或传入 Id 且参数取值为 0 ，即可新增节目单。
更新节目单信息：在请求参数中传入待更新信息的节目单的 ID 作为 Id 参数值，即可更新该节目单。您可以通过 ListPrograms 接口查询 ID。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateProgram`	接口名称。当前 API 的名称为 `UpdateProgram`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

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

LoopVideos Array of LoopVideos 否 - 节目单中视频的信息列表。

ProgramName String 否 节目单 节目单名称。

参数	类型	是否必选	示例值	描述
LoopVideos	Array of LoopVideos	否	`-`	节目单中视频的信息列表。
ProgramName	String	否	`节目单`	节目单名称。
Id	Long	是	`0`	节目单 ID。新增节目单：不传该参数或传入该参数且取值为 `0`。更新节目单信息：传入待更新信息的节目单 ID。您可以通过 ListPrograms 接口查询 ID。

Long

是

0

节目单 ID。

新增节目单：不传该参数或传入该参数且取值为 0。
更新节目单信息：传入待更新信息的节目单 ID。您可以通过 ListPrograms 接口查询 ID。

LoopVideos

参数	类型	是否必选	示例值	描述
Index	Integer	是	`1`	视频序号。该参数取值为从 `1` 开始的连续且不重复的整数，如 `1`、`2`、`3`。取值范围为 [1,50]。取值越小，位置越靠前。
VideoName	String	是	`视频.mp4`	视频名称。
VideoVid	String	是	`v0c251g7007acp7jhnvog65i97kr43jg`	视频 Vid。
Offset	Integer	否	`0`	轮播启动时刻，即视频将从该时刻开始播放。单位为秒。

返回参数

参数	类型	示例值	描述
Id	Long	`34681`	新增或更新节目单的 ID。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateProgram&Version=2023-08-01
{
    "LoopVideos": [
        {
            "Index": 1,
            "VideoName": "视频.mp4",
            "VideoVid": "v0c251g7007acp7jhnvog65i97kr43jg",
            "Offset": 0
        }
    ],
    "ProgramName": "节目单",
    "Id": 0
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateProgram",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1717399429
    },
    "Result": {
        "Id": 34681
    }
}

错误码

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