tencent cloud

All product documents
APIs
DocumentationAPIsVideo on DemandCarousel-Related APIsDescribeCurrentPlaylist
DescribeCurrentPlaylist
Last updated: 2025-02-14 17:29:46
DescribeCurrentPlaylist
Last updated: 2025-02-14 17:29:46

1. API Description

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

Query current playlist of the round play.

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: DescribeCurrentPlaylist.
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.
Limit No Integer The length of the returned playlist. maximum is 10, default value is 5.

3. Output Parameters

Parameter Name Type Description
CurrentPlaylist Array of RoundPlayFilePlayInfo Current playlist information.
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

Example1 Query Current Playlist Of the Round Play

Input Example

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

{
    "RoundPlayId": "1323",
    "SubAppId": 123
}

Output Example

{
    "Response": {
        "CurrentPlaylist": [
            {
                "ItemId": "a001",
                "FileId": "528xxx5487985271487",
                "StartPlayTime": "2024-07-25T10:12:00+08:00",
                "Duration": 100
            }
        ],
        "RequestId": "abc"
    }
}

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
InvalidParameterValue.RoundPlayId RoundPlayId parameter error.
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