# 获取剧目列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:listDramas
该接口用于获取已提交的剧目列表
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/sec/vod/listdramas?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:153
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| limit | number | 否 | 分页拉取的最大返回结果数。最大值:100。 |
| offset | number | 否 | 分页拉取的起始偏移量。 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| drama_info_list | objarray | 媒体文件id |
# Res.drama_info_list(Array) Object Payload
媒体文件id
| 参数名 | 类型 | 说明 |
|---|---|---|
| drama_id | number | 剧目id。 |
| create_time | number | 创建时间,时间戳。 |
| name | string | 剧名。 |
| cover_url | string | 剧目海报链接,根据提审时提交的cover_material_id转存得到。 |
| media_count | number | 剧集数目。 |
| producer | string | 制作方 。 |
| playwright | string | 编剧。 |
| description | string | 剧目简介。 |
| production_license | string | 广播电视节目制作经营许可证。 |
| audit_detail | object | 审核状态。 |
| media_list | objarray | 剧集信息列表。 |
| expedited | number | 1表示审核加急,0或空为非加急审核 |
| recommendations | string | 剧目推荐语。 |
| promotion_poster | string | 推广海报。 |
| actor_list | object | 演员信息。 |
| status | number | 剧目状态。0为正常可播;1为审核中;2为审核失败;3为平台下架 |
# Res.drama_info_list(Array).audit_detail Object Payload
审核状态。
| 参数名 | 类型 | 说明 |
|---|---|---|
| status | number | 0为无效值;1为审核中;2为最终失败;3为审核通过;4为驳回重填 |
| audit_type | number | 事件通知接口才返回:0为首次提审;1为再次提审;2为替换剧集提审;3为修改剧目基本信息审核。 |
| create_time | number | 提审时间戳。 |
| audit_time | number | 审核时间戳。 |
# Res.drama_info_list(Array).media_listObject Payload
Object Payload剧集信息列表。
| 参数名 | 类型 | 说明 |
|---|---|---|
| media_id | number | 媒资文件id。 |
# Res.drama_info_list(Array).actor_list Object Payload
演员信息。
| 参数名 | 类型 | 说明 |
|---|---|---|
| actor | objarray | 演员列表 |
# Res.drama_info_list(Array).actor_list.actorObject Payload
Object Payload演员列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| name | string | 演员姓名,格式要求:可填写30个字符,支持输入中文、英文和· |
| photo_material_id | string | 演员照片临时material_id |
| role | string | 饰演角色,格式要求:可填写30个字符,支持输入中文、英文及,。;”“?、—《》!()-· |
| profile | string | 演员简介,填写内容可参考:生日、星座、籍贯、身高、毕业院校、历史/代表作品、获奖信息、成就等(以上要素需至少满足3项或涵盖任一要素且不少于20字)。 格式要求:可填写100个字符,支持输入中文、英文、阿拉伯数字及,。:;“”?、—《》!()-· |
# 4. 注意事项
Content-Type需要指定为application/json。- 本接口返回的图片链接均为临时链接,不应将其保存下来。
- 如果剧目审核结果为失败或驳回,则具体每一集的具体驳回理由及证据截图可通过“获取媒资列表”或者“获取媒资详细信息”接口来获取
# 5. 代码示例
请求示例
{
"offset": 0,
"limit": 10
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"drama_info_list": [
{
"drama_id": 28918028,
"create_time": 1682214878,
"name": "我的演艺",
"playwright": "编剧名",
"producer": "制作方名",
"production_license": "abd123",
"cover_url": "https://developers.weixin.qq.com/test.jpg",
"media_count": 2,
"media_list":[
{"media_id": 10001},
{"media_id": 10002}
],
"audit_detail": {
"status": 3,
"create_time": 1682215878,
"audit_time": 1682235878
}
}
]
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| -2 | 初始化未完成,请稍后再试 |
| -1 | 系统错误 |
| 43002 | HTTP请求必须使用POST方法 |
| 44002 | POST内容为空 |
| 47001 | 输入格式错误 |
| 47003 | 参数不符合要求 |
| 10090001 | 视频类型不支持 |
| 10090002 | 图片类型不支持 |
| 10090003 | 图片URL无效 |
| 10090005 | resource_type无效 |
| 10090038 | 被授权账号没有【文娱-微短剧】类目 |
| 10090039 | 已经被解除授权 |
| 10090040 | 剧集已经被占用 |
| 10090041 | 剧目名称不符合规范 |
| 10090042 | 剧集名称不符合规范 |
| 10090043 | 不存在授权关系 |
| 10093011 | 操作失败 |
| 10093014 | 参数错误(包括参数格式、类型等错误) |
| 10093023 | 操作过于频繁 |
| 10093030 | 资源不存在 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。