tencent cloud

All product documents
APIs
DocumentationAPIsVideo on DemandCarousel-Related APIsCreateRoundPlay
CreateRoundPlay
Last updated: 2025-02-14 17:29:03
CreateRoundPlay
Last updated: 2025-02-14 17:29:03

1. API Description

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

This API is used to create a playlist. You can create at most 100 playlists.
For each video on the list, you can either use the original file or a transcoding file.
The files must be in HLS format. Preferably, they should have 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 The playback start time, in iso 8601 date format.
RoundPlaylist.N Yes Array of RoundPlayListItemInfo The program list.
  • Array length limit: 100.
    • .
    SubAppId No Integer VOD subapplication id. starting from december 25, 2023, if you want to access resources in the vod application (whether it is the default application or a newly created application), you must enter the application id in this field..
    Name No String The playlist name (not longer than 64 characters).
    Desc No String The playlist description, length limit: 256 characters.
    PlayBackMode No String Play mode, optional values:.
  • Loop: loop the playlist;
    • .
  • Linear: single play, stop playback after the single play finishes.
    • .
    Default value: loop.
    RoundPlayId No String Playlist unique identifier id, with a length limit of 64 characters, only allowing uppercase and lowercase english letters (a-za-z), digits (0-9) and hyphens (-). if there is a playlist with the same roundplayid, return the error invalidparametervalue.roundplayalreadyexists. the default value is empty, which means it is system-assigned.
    ExpiredTime No String Expiration time, in iso 8601 format. for details, see iso date format. the playlist will stop playing after expiration. "9999-12-31t23:59:59+08:00" means it does not expire. default value: 9999-12-31t23:59:59+08:00.

    3. Output Parameters

    Parameter Name Type Description
    RoundPlayId String The unique identifier of the playlist.
    Url String The playlist playback url.
    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 and 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 Invalid parameter.
    InvalidParameterValue.ExpiredTime Incorrect expiretime.
    InvalidParameterValue.RoundPlayAlreadyExists A playlist with the same id already exists.
    InvalidParameterValue.RoundPlaylist RoundPlaylist parameter length error.
    InvalidParameterValue.StartTime Incorrect parameter value: invalid StartTime.
    LimitExceeded.PlayList Playlist length too large.
    LimitExceeded.RoundPlays Exceeds broadcast playlist total limit.
    LimitExceeded.RunningRoundPlays Running broadcast playlists exceed maximum quantity.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Hong Kong, China
    +852 800 906 020 (Toll Free)
    United States
    +1 844 606 0804 (Toll Free)
    United Kingdom
    +44 808 196 4551 (Toll Free)
    Canada
    +1 888 605 7930 (Toll Free)
    Australia
    +61 1300 986 386 (Toll Free)
    EdgeOne hotline
    +852 300 80699
    More local hotlines coming soon