tencent cloud

APIs

DocumentationAPIsVideo on DemandLoop Banner APIsCreateRoundPlay

CreateRoundPlay

Download
Focus Mode
Font Size
Last updated: 2026-09-22 22:25:21

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to create a carousel playlist. Maximum quantity: 100.
Each file in the carousel playlist can specify a source file or a transcoded file.
The designated file must be in hls format. All playlist files should preferably maintain the same bitrate and resolution.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: CreateRoundPlay.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
StartTime Yes String Playback start time in ISO 8601 format. See ISO date format description.
RoundPlaylist.N Yes Array of RoundPlayListItemInfo Carousel list.
  • Array length limit: 100.
    		•
    SubAppId No Integer VOD application ID. For customers who activate VOD services from December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications, whether in the default application or a newly created application.
    Name No String Carousel playbill name. Length limit: 64 characters.
    Desc No String Carousel playlist description, with a length limit of 256 characters.
    PlayBackMode No String Playback mode. Optional values:
  • Loop: loop playback playlist;
  • Linear: single play, stop playback after playlist finishes.

    • Default value: Loop.
    RoundPlayId No String Unique identification ID of the playlist. Length limit: 64 characters. Only allow uppercase and lowercase letters (a-zA-Z), digits (0-9), and hyphens (-). If a playlist with the same RoundPlayId exists, the InvalidParameterValue.RoundPlayAlreadyExists error is returned. The default value is empty, which means it is assigned by the system.
    ExpiredTime No String Expiration time in ISO 8601 format. For details, see ISO date format description. The playlist will stop playback after expiry. "9999-12-31T23:59:59+08:00" means never expire. Default value: 9999-12-31T23:59:59+08:00.

    3. Output Parameters

    Parameter Name Type Description
    RoundPlayId String Carousel playlist unique identifier.
    Url String Carousel playback address.
    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.

    4. Example

    Create a new carousel playlist. You can specify the carousel list.

    Input Example

    POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRoundPlay
<Common request parameters>

{
    "StartTime": "2022-06-01T00:00:00+08:00",
    "RoundPlaylist": [
        {
            "FileId": "528xxx5487985271487",
            "AudioVideoType": "Transcode",
            "Definition": 100210
        }
    ]
}

    Output Example

    {
    "Response": {
        "RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
        "Url": "http://domain/round-play/bffb15f07530b57bc1aabb01fac74bca/playlist.m3u8",
        "RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

    Create a new carousel playlist that expires after 2024-12-10T20:00:00+08:00.

    Input Example

    POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRoundPlay
<Common request parameters>

{
    "StartTime": "2022-06-01T00:00:00+08:00",
    "RoundPlaylist": [
        {
            "FileId": "528xxx5487985271487",
            "AudioVideoType": "Transcode",
            "Definition": 100210
        }
    ],
    "RoundPlayId": "bffb15f07530b57bc1aabb01fac74bcb",
    "ExpiredTime": "2024-12-10T20:00:00+08:00"
}

    Output Example

    {
    "Response": {
        "RoundPlayId": "bffb15f07530b57bc1aabb01fac74bcb",
        "Url": "http://domain/round-play/bffb15f07530b57bc1aabb01fac74bcb/playlist.m3u8",
        "RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    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.ExpiredTime ExpiredTime error.
    InvalidParameterValue.RoundPlayAlreadyExists A playlist with the same ID already exists.
    InvalidParameterValue.RoundPlaylist Invalid RoundPlaylist parameter length.
    InvalidParameterValue.StartTime Invalid parameter value: StartTime is invalid.
    LimitExceeded.PlayList Playlist length is too large.
    LimitExceeded.RoundPlays The total number of playlists limit is exceeded.
    LimitExceeded.RunningRoundPlays The number of running playlists exceeds the maximum limit.
    Previous Topic: DescribeCDNStatDetailsNext Topic: DeleteRoundPlay

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback

    Search
      Enter keywords to search documentation