# 设置屏蔽的广告主
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:SetBlackList
该 API 用于设置小程序广告屏蔽的广告主。使用过程中如遇到问题,可在开放平台服务商专区交流专区 | 微信开放社区发帖交流。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/operationams?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| op | number | 是 | 1:设置屏蔽 2:删除屏蔽 |
| list | string | 是 | 为json序列化格式,包含屏蔽类型type及标识ID。其中,type枚举值:1:公众号,id代表公众号微信号 2:IOS应用,id代表IOS应用APPID 3:安卓应用,id代表安卓应用的应用宝包名 4:小程序/小游戏,id代表原始ID。
注:屏蔽数量有上限,超过将超时报错。公众号,最多可屏蔽20个,iOS应用,最多可屏蔽10个,安卓应用,最多可屏蔽10个,小程序/小游戏,最多可屏蔽20个 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| ret | number | 错误码 |
| err_msg | string | 错误信息 |
# 4. 注意事项
其中access_token为authorizer_access_token
# 5. 代码示例
请求示例
POST https://api.weixin.qq.com/wxa/operationams?action=agency_set_black_list&access_token=xxxxxxxxxxxxxxx
{
"op": 1,
"list": "[{\"type\":1,\"id\":\"gh_f23fc177abe4\"}]"
}
返回示例
{
"ret": 0,
"err_msg": "" // 仅在接口调用失败返回
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 0 | ok | ok |
| 1700 | 参数错误 | 检验输入参数是否符合文档说明 |
| 1701 | 参数错误 | 检验输入参数是否符合文档说明 |
| 1735 | 商户未完成协议签署流程 | 完成签约操作 |
| 1737 | 操作过快 | 等待一分钟后重新操作 |
| 1807 | 无效流量主 | 通过开通流量主接口为该appid开通流量主 |
| 2009 | 无效流量主 | 通过开通流量主接口为该appid开通流量主 |
| 2035 | 超过某类型广告主屏蔽上限 | 移除不需再屏蔽的广告主 |
| 2056 | 服务商未在变现专区开通账户 | 在第三方平台页面的变现专区开通服务 |
| 3004 | 公众号广告主屏蔽输入微信号错误 | 检查输入微信号是否正确 |
| 3005 | 小程序小游戏广告主输入原始ID错误 | 检查输入原始ID是否正确 |
| 3006 | 屏蔽IOS应用输入APPID错误 | 检查输入APPID是否正确 |
| 3007 | 屏蔽安卓应用输入应用宝包名错误 | 检查输入应用宝包名是否正确 |
# 7. 适用范围
本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。