ListShortPlayEpisodes - 获取短剧剧集列表--内容定制-火山引擎

文档中心

立即注册

导航

ListShortPlayEpisodes - 获取短剧剧集列表

最近更新时间：2024.04.24 15:03:44首次发布时间：2023.11.21 17:01:08

通过短剧ID，分页获取指定短剧下的剧集详情列表。

注意事项

前提条件：已联系火山侧人员，开通接口访问权限并配置短剧数据。

注意

接口调通后，请预留一周左右时间进行短剧的埋点对接和校验：

用于保障后续资源的稳定供给和更新；
用于数据分析，提升短剧推荐效果；

请求说明

请求方式：POST
请求地址：https://mercury.volcengineapi.com?Action=ListShortPlayEpisodes&Version=2023-01-01
请求头：ServiceName：volc_torchlight_api

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	ListShortPlayEpisodes	要执行的操作，取值：ListShortPlayEpisodes。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。

Body

参数	类型	是否必填	示例值	描述
UtmSource	String	是	xxx_default_content	渠道号。
ShortPlayId	String	是	7216247515908148259	指定短剧ID。
NextToken	String	否	7241775650057638658	分页获取下一页内容的游标；不传递则返回第一页的内容。
MaxResults	Integer	否	20	返回每页的条数，默认值为10，最大值为30，不填或非法输入默认返回10条。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
NextToken	String	7241775650057638658	下一页内容的分页游标，返回空则代表遍历结束。
ShortPlayEpisodes	Array of ShortPlayEpisode		剧集列表。

请求示例

{
"UtmSource":"xxx_default_content",
"ShortPlayId":"7216247515908148259"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240417150***2C24953F0CB09293A50E",
        "Action": "ListShortPlayEpisodes",
        "Version": "2023-01-01",
        "Service": "volc_torchlight_api",
        "Region": "cn-north-1"
    },
    "Result": {
        "NextToken": "7216247869617998882",
        "ShortPlayEpisodes": [
            {
                "Id": "7216248752309275682",
                "ShortPlayId": "7216247515908148259",
                "Name": "第1集",
                "Videos": [
                    {
                        "VideoUrl": "https://open.toutiao.com/video/url/?param=6w3hFzAwMcLzPExW2WZ2G591yBowsiW***GZkfeTR4ShRXS79cWS6fNpV8SN7fpMGRG5qYLxNCkxDnAzVryAPC3mhNueLwuadvM8ThUn7ptrRYd7cznLiR64wUwPBof8PrgRVXgA15KD5QQ5PpBUtggPKA9HmVESfkzkYML4EpJJrPUqmoBAdPhHdSZUTqNijANt4dp78Xvk1ScCmJ5DJxbF8Hu6G&partner=xxx_default_content&version=3",
                        "Definition": "540p",
                        "Size": 6108352,
                        "Width": 540,
                        "Height": 960
                    }
                ],
                "Duration": 78,
                "Order": 1,
                "CoverImages": [
                    {
                        "Width": 360,
                        "Height": 640,
                        "Url": "http://p9-open-sign.onewsimg.com/tos-cn-v-6fcc8e/ocFf9nfE2teQC1ebvAdlp0QAR***lOuJDIlEAA~tplv-obj.jpeg?scene=core&x-expires=1776409638&x-signature=8NnGfnlZPkO9ZZsdj0a1NjZd7IY%3D"
                    }
                ]
            },
            {
                "Id": "7216247808263719970",
                "ShortPlayId": "7216247515908148259",
                "Name": "第2集",
                "Videos": [
                    {
                        "VideoUrl": "https://open.toutiao.com/video/url/?param=6w3hFzAwMcLzPExW2WZ2G591y***siWCtUGZkfeTR4ShRXS79cWS6fNpV8SN7fpMGRG5qYLxNCkxDnAzVryAPC3mhNueLwuadvM8ThUn7ptrRYd7cznLiT3amzo9DA2mAH4SxU8BcrPExXFAxXkA9i9UzJ2zg3MG9KXJxdPtwN3twgqAkVqxhTvSTHbYpCyPNZPWZKYunp9MgkWGQvT6fwJXyrJ8G&partner=xxx_default_content&version=3",
                        "Definition": "540p",
                        "Size": 7086100,
                        "Width": 540,
                        "Height": 960
                    }
                ],
                "Duration": 69,
                "Order": 2,
                "CoverImages": [
                    {
                        "Width": 360,
                        "Height": 640,
                        "Url": "http://p3-open-sign.onewsimg.com/tos-cn-v-6fcc8e/oALnAotzhEPE8cy1RQFIQE***AyBBhG9fAtPIQ~tplv-obj.jpeg?scene=core&x-expires=1776409774&x-signature=bSwSq%2FGlOV2KfSh7XOdaqhHcgxg%3D"
                    }
                ]
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。