Release Notes
Announcements
Domain name for API request: vod.intl.tencentcloudapi.com.
Operate the current play list . Supported operations include:
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: HandleCurrentPlaylist. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | Yes | Integer | VOD subapplication id.. |
| RoundPlayId | Yes | String | The unique identifier of the playlist. |
| Operation | Yes | String | Operation type, available options: |
| ItemId | No | String | Playlist program id. required when operation is insert, indicating the program list will be inserted after this program. the insertion position must be after the currently playing program. |
| RoundPlaylist.N | No | Array of RoundPlayListItemInfo | Program list. required when operation is insert, inserttemporary, delete, indicating the list of programs to be operated on. the list length can be up to a maximum of 10. |
| Parameter Name | Type | Description |
|---|---|---|
| RoundPlaylist | Array of RoundPlayListItemInfo | List of successfully operated programs. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: HandleCurrentPlaylist
<Common request parameters>
{
"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"
}
}POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: HandleCurrentPlaylist
<Common request parameters>
{
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue.FileId | The FileId does not exist. |
| InvalidParameterValue.Index | Index parameter error. |
| InvalidParameterValue.ItemId | ItemId error. |
| InvalidParameterValue.RoundPlayId | RoundPlayId parameter error. |
| InvalidParameterValue.RoundPlaylist | RoundPlaylist parameter length error. |
| InvalidParameterValue.SubAppId | Incorrect parameter value: application id. |
| LimitExceeded.PlayList | Playlist length too large. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback