1. 接口描述
接口请求域名： vod.tencentcloudapi.com 。
操作轮播当前播放列表。支持的操作有：
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：HandleCurrentPlaylist。 |
| Version | 是 | String | 公共参数，本接口取值：2018-07-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| SubAppId | 是 | Integer | 点播应用 ID。 示例值：12345 |
| RoundPlayId | 是 | String | 轮播播单唯一标识。 示例值：a12 |
| Operation | 是 | String | 操作类型，取值有： 示例值：Insert |
| ItemId | 否 | String | 播单节目 ID。当 Operation 为 Insert 时必填，表示插入的节目列表位于该播放节目之后。插入的位置必须在当前正在播放的节目之后。 |
| RoundPlaylist.N | 否 | Array of RoundPlayListItemInfo | 节目列表。当 Operation 为 Insert、InsertTemporary、Delete 时必填，表示要操作的节目列表。列表长度最大为10。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RoundPlaylist | Array of RoundPlayListItemInfo | 操作成功的节目列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 插入一个节目到当前播放列表 a003 节目之后
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: HandleCurrentPlaylist
<公共请求参数>
{
"SubAppId": 123,
"RoundPlayId": "130",
"Operation": "Insert",
"ItemId": "a003",
"RoundPlaylist": [
{
"FileId": "528xxx5487985271487",
"AudioVideoType": "Transcode",
"Definition": 100210
}
]
}输出示例
{
"Response": {
"RoundPlaylist": [
{
"ItemId": "a01",
"AudioVideoType": "Transcode",
"Definition": 100,
"FileId": "528xxx5487985271487"
}
],
"RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3"
}
}示例2 删除播放列表中的节目
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: HandleCurrentPlaylist
<公共请求参数>
{
"SubAppId": 123,
"RoundPlayId": "130",
"Operation": "Delete",
"RoundPlaylist": [
{
"ItemId": "a004",
"FileId": "",
"AudioVideoType": ""
}
]
}输出示例
{
"Response": {
"RoundPlaylist": [
{
"ItemId": "a004",
"AudioVideoType": "",
"Definition": 100,
"FileId": ""
}
],
"RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.FileId | FileId 不存在。 |
| InvalidParameterValue.Index | Index 参数错误。 |
| InvalidParameterValue.RoundPlayId | RoundPlayId 参数错误。 |
| InvalidParameterValue.RoundPlaylist | RoundPlaylist 参数长度错误。 |
| InvalidParameterValue.SubAppId | 参数值错误：子应用 ID。 |
| LimitExceeded.PlayList | 播放列表长度太大。 |
