# 获取屏蔽的广告主

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:GetBlackList

该 API 用于查询当前小程序广告屏蔽的广告主。使用过程中如遇到问题,可在开放平台服务商专区交流专区 | 微信开放社区发帖交流。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/operationams?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台调用。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 authorizer_access_token

# 请求体 Request Payload

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
retnumber错误码
err_msgstring返回错误信息
blacklist_bizobjarrayblacklist_biz
blacklist_weappobjarrayblacklist_weapp
blacklist_iosobjarrayblacklist_ios
blacklist_androidobjarrayblacklist_android

# Res.blacklist_biz(Array) Object Payload

blacklist_biz

参数名类型说明
itemobjarrayitem

# Res.blacklist_weapp(Array) Object Payload

blacklist_weapp

参数名类型说明
itemobjarrayitem

# Res.blacklist_ios(Array) Object Payload

blacklist_ios

参数名类型说明
itemobjarrayitem

# Res.blacklist_android(Array) Object Payload

blacklist_android

参数名类型说明
itemobjarrayitem

# Res.blacklist_biz(Array).itemObject Payload

item

参数名类型说明
idstring屏蔽公众号微信号
namestring屏蔽公众号名称
urlstring屏蔽公众号头像URL

# Res.blacklist_weapp(Array).itemObject Payload

item

参数名类型说明
idstring屏蔽小程序/小游戏原始ID
namestring屏蔽小程序/小游戏名称
urlstring屏蔽小程序/小游戏头像URL

# Res.blacklist_ios(Array).itemObject Payload

item

参数名类型说明
idstring屏蔽IOS应用的APPID
namestring屏蔽IOS应用名称
urlstring屏蔽IOS应用标识图片

# Res.blacklist_android(Array).itemObject Payload

item

参数名类型说明
idstring屏蔽安卓应用的应用宝包名
namestring屏蔽安卓应用的名称
urlstring屏蔽安卓应用标识图片

# 4. 注意事项

其中access_token为authorizer_access_token

# 5. 代码示例

请求示例

POST https://api.weixin.qq.com/wxa/operationams?action=agency_get_black_list&access_token=xxxxxxxxxxxxxxx 
{}

返回示例

{
    "ret": 0, // 仅在接口调用失败返回
    "err_msg": "", // 仅在接口调用失败返回
    "blacklist_biz": [
        {
            "id": "id1",
            "name": "name1",
            "icon": "png_url1"
        },
        {
            "id": "id2",
            "name": "name2",
            "icon": "png_url2"
        }
    ],
    "blacklist_weapp": [
        {
            "id": "id3",
            "name": "name3",
            "icon": "png_url3"
        }
    ],
    "blacklist_ios": [
        {
            "id": "id4",
            "name": "name4",
            "icon": "png_url4"
        }
    ],
    "blacklist_android": [
        {
            "id": "id5",
            "name": "name5",
            "icon": "png_url5"
        }
    ]
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
-202内部错误可在一段时间后重试
0okok
1700参数错误检验输入参数是否符合文档说明
1701参数错误检验输入参数是否符合文档说明
1735商户未完成协议签署流程完成签约操作
1737操作过快等待一分钟后重新操作
1807无效流量主通过开通流量主接口为该appid开通流量主
2009无效流量主通过开通流量主接口为该appid开通流量主
2056服务商未在变现专区开通账户在第三方平台页面的变现专区开通服务

# 7. 适用范围

本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。