# 播放原始视频-推荐位控制接口
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:setPlayerDramaRecmdSwitch
开发者可通过后台接口选择播放上传未经转码的原始视频。
开发者可通过后台接口控制推荐位的开启与关闭。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxadrama/setplayerdramarecmdswitch?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 | 是 | 2002 | 此处填2002(当需要控制推荐位时,可选值为:1-剧结束 2-选集最右侧推荐 3-剧集profile页相关推荐) |
| switch_status | boolean | 是 | true | true-打开 false-关闭,没有打开过的都默认为关闭(当需要控制推荐位时:true-打开 false-关闭,1-剧结束&3-剧集profile页默认打开) |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
# 5.1 播放原始视频
请求示例
{
"entry_type": 2002,
"switch_status": "true"
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 5.2 推荐位控制
请求示例
{
"entry_type":1,
"switch_status": true
}
返回示例
{
"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. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。