Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to modify a carousel playlist.
After modification, only new playback requests will take effect. Users already playing can still play the playlist before modification within seven days.
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: ModifyRoundPlay. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| RoundPlayId | Yes | String | Unique identifier of the carousel playlist. |
| SubAppId | No | Integer | VOD application ID. For customers who activate VOD from December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application). |
| StartTime | No | String | Playback start time, formatted according to the ISO 8601 standard. For details, see ISO date format description. |
| RoundPlaylist.N | No | Array of RoundPlayListItemInfo | Carousel list. |
| Name | No | String | Carousel playbill name. Length limit: 64 characters. |
| Desc | No | String | Carousel playlist description, with a length limit of 256 characters. |
| Status | No | String | Playback status. Available values: |
| PlayBackMode | No | String | Playback mode. Optional values: |
| ExpiredTime | No | String | Expiration time in ISO 8601 format. For details, see ISO date format description. Playback stops after expiry. "9999-12-31T23:59:59+08:00" means never expire. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
Modify loop banner information. The playlist file, playlist name, and description can be modified.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRoundPlay
<Common request parameters>
{
"RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
"RoundPlaylist": [
{
"FileId": "528xxx5487985271487",
"AudioVideoType": "Transcode",
"Definition": 100210
}
]
}{
"Response": {
"RequestId": "7b9d6abb-4ec1-4ef3-b904-2b11e24012f3"
}
}Modify the expiry date of playlist bffb15f07530b57bc1aabb01fac74bca to 2024-12-10T23:00:00+08:00
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRoundPlay
<Common request parameters>
{
"RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
"ExpiredTime": "2024-12-10T23:00:00+08:00"
}{
"Response": {
"RequestId": "7b9d6abb-4ec1-4ef3-b904-2b11e24012f5"
}
}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 |
|---|---|
| FailedOperation | Operation failed. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| LimitExceeded.PlayList | Playlist length is too large. |
| LimitExceeded.RoundPlays | Exceeds the total number of playlists limit. |
| LimitExceeded.RunningRoundPlays | The number of running playlists exceeds the maximum limit. |
| ResourceNotFound | The resource does not exist. |
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