调用 ListPrograms 接口获取节目单的 ID、名称及所包含的视频列表等信息。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListPrograms | 接口名称。当前 API 的名称为 ListPrograms。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| PageNo | Integer | 否 | 1 | 分页查询页码，默认值为 1。取值大于等于 1。 |
| PageItemCount | Integer | 否 | 10 | 分页查询数量。默认值为 10。取值范围为 [1,500]。 |
| ProgramName | String | 否 | 节目单 | 节目单名称。支持模糊搜索。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PageNo | Integer | 1 | 分页查询页码。 |
| PageItemCount | Integer | 10 | 分页查询数量。 |
| TotalCount | Integer | 1 | 查询结果总数。 |
| Programs | Array of Programs | - | 节目单信息列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Id | Integer | 3489 | 节目单 ID。 |
| ProgramName | String | 节目单 | 节目单名称。 |
| LoopVideos | Array of LoopVideos | - | 节目单中视频的信息列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Index | Integer | 1 | 视频序号。序号越小，位置越靠前。 |
| VideoCoverImage | String | https://www.example.com.image | 视频封面图。包含协议头。 |
| VideoName | String | 视频.mp4 | 视频名称。 |
| VideoVid | String | v0c251g70cp7****og65i97kr43jg | 视频 Vid。 |
| Offset | Integer | 5 | 伪直播启动时刻，即视频将从该时刻开始播放。单位为秒。 |
| MediaSize | Integer | 8589490 | 视频大小。单位为字节。 |
| MediaDuration | Integer | 60 | 视频时长。单位为秒。 |
ReviewStatus | Integer |
| 视频的审核状态。取值如下：
|
GET https://livesaas.volcengineapi.com/?Action=ListPrograms&Version=2023-08-01&PageNo=1&PageItemCount=10&ProgramName=节目单
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListPrograms", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "PageNo": 1, "PageItemCount": 10, "TotalCount": 1, "Programs": [ { "Id": 3489, "ProgramName": "节目单", "LoopVideos": [ { "Index": 1, "VideoCoverImage": "https://www.example.com.image", "VideoName": "视频.mp4", "VideoVid": "v0c251g70cp7****og65i97kr43jg", "Offset": 5, "MediaSize": 8589490, "MediaDuration": 60, "ReviewStatus": 2 } ] } ] } }