# 获取短剧合作推广活动
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:getFinderEvent
该接口可获取当前小程序短剧所关联的短剧合作推广活动。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxadrama/getfinderevent?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
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event_id_list | array | 否 | 筛选短剧合作推广活动 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| finder_event_list | objarray | 推广计划数组 |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
# Res.finder_event_list(Array) Object Payload
推广计划数组
| 参数名 | 类型 | 说明 |
|---|---|---|
| encrypted_event_id | string | 活动id |
| event_name | string | 活动名 |
| event_url | string | 活动链接 |
| src_appid | string | 提审小程序id |
| drama_id | string | 提审剧目id |
# 4. 注意事项
- 批量获取小程序提交审核的所有关联小程序短剧的推广活动
- 批量获取小程序可播放短剧的推广活动,无法获取该短剧其他可播放小程序的推广活动
- 传入event_id_list用于筛选指定event_id的推广活动,最大数量限制为50
# 5. 代码示例
请求示例
{
"event_id_list": [] //为空时全量读取
}
返回示例
{
"finder_event_list": [
{
"encrypted_event_id": "event/id",
"event_name": "《示例短剧》示例小程序",
"event_url": "https://channels.weixin.qq.com/mobile/toNativeActivity.html?title=&topicType=&eventEncryptedTopicId=&authorNickname=",
"src_appid": "wx",
"drama_id": "10000"
}
],
"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. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。