# 推荐剧目
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:developerSetRecmdDrama
开启推荐位之后,推荐剧目范围默认为播放小程序所有已授权的剧目。
同时支持开发者设置推荐库,在设置推荐库之后,推荐剧目将从开发者设置的推荐剧目中产生。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxadrama/developersetrecmddrama?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:157
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| entry_type | number | 是 | 1-剧结束 2-选集最右侧推荐 3-剧集profile页相关推荐 |
| src_appid | string | 否 | 提审方小程序的appid |
| drama_id | string | 否 | 提审的剧目id |
| list | objarray | 否 | list |
# Body.list(Array) Object Payload
list
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| src_appid | string | 是 | 提审方小程序的appid |
| drama_id | string | 是 | 提审的剧目id |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 示例 | 说明 |
|---|---|---|---|
| errcode | number | 错误码 | |
| errmsg | string | ok | 错误信息 |
# 4. 注意事项
- src_appid 和 drama_id 同时为空,代表小程序维度。展示优先级低于剧粒度的设置。
- 每次设置都会覆盖之前的设置,需要把所有要设置的推荐剧一次加上;list不传或者传空数组,则将记录清空。
- 所有appid需要合法,不然报错。另外存在所传剧目没有授权给该调用账号的,也会失败报错。
- list当前的上限是200个。
# 5. 代码示例
请求示例
{
"entry_type":1, //1-剧结束 2-选集最右侧推荐 3-剧集profile页相关推荐
"src_appid":"wx94a6522b1d640c3b",
"drama_id":"666666",
"list":[
{"src_appid":"wx4f3ca6d4c2407ccc","drama_id":"266946"},
{"src_appid":"wx5cefe18a7902141d","drama_id":"236424"}
]
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| -1 | 系统错误,请重试 |
| 0 | 成功 |
| 1 | 不存在 |
| 2 | 参数错误 |
| 21000 | 该剧未授权播放,请通过后台api进行授权 |
| 21001 | 用户加密的sessionkey不存在 |
| 21002 | 商家的加密包未进行base64编码 |
| 21003 | 解密商家加密包失败,请确认是否按接入文档中给出的加密方案加密或sessionkey要使用当前用户最新的 |
| 21004 | 商家加密前的明文不是合法的json格式或者字段类型不对,请按接入文档排查 |
| 21005 | 商家加密中的必填参数值(openid、src_appid及drama_id)为空 |
| 21006 | 播放器的入参与商家加密包中的参数值不匹配 |
| 21007 | 加密包中的openid无效 |
| 21008 | 21008 开发者未开启预拉取 |
| 21009 | 21009 商家流量不足 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。