导航
ListShortPlays - 获取短剧列表
最近更新时间：2025.01.21 17:11:28首次发布时间：2024.04.18 10:52:16
用于分页输出短剧详情列表。
注意事项
- 请求频率：该接口用于数据拉取，接口单客户限流50QPS。
- 前提条件：
- 请联系火山侧人员，开通接口访问权限，并配置短剧数据。
- 需要登陆控制台-访问控制，开通TorchlightApiFullAccess访问权限；
请求说明
- 请求方式：POST
- 请求地址：https://mercury.volcengineapi.com?Action=ListShortPlays&Version=2023-01-01
- 请求头：ServiceName：volc_torchlight_api
- Content-Type: application/json
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
Query
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ListShortPlays | 要执行的操作，取值：ListShortPlays。 |
Version | String | 是 | 2023-01-01 | API的版本，取值：2023-01-01。 |
Body
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
UtmSource | String | 是 | xxx_default_content | 渠道号。 |
NextToken | String | 否 | 7241775650057638798 | 分页获取下一页内容的游标；不传递则返回第一页的内容。 |
MaxResults | Integer | 否 | 10 | 返回每页的条数，默认值为10，最大值为20，不填或非法输入默认返回10条。 |
返回参数
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
NextToken | String | 7216526606989265972 | 下一页内容的分页游标，返回空则代表遍历结束。 |
ShortPlays | Array of Object | 短剧列表。 |
请求示例
{
"UtmSource": "xxxx_default_content",
"NextToken": "7241775650057638798",
"MaxResults":10
}
json返回示例
{
"ResponseMetadata": {
"RequestId": "202306211106236***C29742C741A10485",
"Action": "ListShortPlays",
"Version": "2023-01-01",
"Service": "volc_torchlight_api",
"Region": "cn-north-1"
},
"Result": {
"NextToken": "7216526606989265972",
"ShortPlays": [
{
"Id": "7241775650057638798",
"Name": "短剧名称",
"Brief": "短剧简介",
"CoverImageUrl":"http://p3-novel.byteimg.com/origin/novel-pic/b62f43e9b***1e3451483867748c0400",
"Categories":["男生","逆袭","反转"],
"EpisodeCount": 67,
"PublishTime": 1680163553,
"CopyrightType": "exclusive"
},...
]
}
}
json错误码
您可访问公共错误码，获取更多错误码信息。