# 增加剧目授权
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:authorizedRama
该接口用于授权方给被授权方授权一些剧目的播放权限。
# 1. 调用方式
# HTTPS 调用
GET https://api.weixin.qq.com/wxa/sec/vod/authorizedrama?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
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| drama_id | numarray | 是 | 授权的剧目ID |
| authorized | string | 是 | 被授权方小程序id。 |
| authz_expire_time | number | 否 | 不传或者传0,表示永久有效;否则表示授权到期的时间戳 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 示例 | 说明 |
|---|---|---|---|
| errcode | number | - | 错误码 |
| errmsg | string | ok | 错误信息 |
| result | objarray | - | 剧目的授权结果。 |
# Res.result(Array) Object Payload
剧目的授权结果。
| 参数名 | 类型 | 说明 |
|---|---|---|
| drama_id | number | 剧目ID。 |
| errcode | number | 错误码。 |
| errmsg | string | 错误原因。 |
# 4. 注意事项
- 授权方与被授权方都需申请【文娱-微短剧】类目;
- 被授权的剧目必须已经审核通过;
- 如果指定授权到期时间,授权时长不能小于7天(从当前时间算起)
# 5. 代码示例
请求示例
{
"authorized_appid": "wx*************",
"drama_id": [100200, 100205],
"authz_expire_time": 0
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"result": [
{
"drama_id": 100200,
"errcode": 0
},
{
"drama_id": 100205,
"errcode": 1,
"errmsg": "获取剧目100205失败!"
}
]
}
# 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. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。