# 获取公众号的黑名单列表

调试工具

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

接口英文名:getBlacklist

本接口用来获取账号的黑名单列表,黑名单列表由一串 OpenID(加密后的微信号,每个用户对每个公众号的OpenID是唯一的)组成。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/cgi-bin/tags/members/getblacklist?access_token=ACCESS_TOKEN

# 云调用

  • 调用方法:officialAccount.user.getBlacklist

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

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

  • 该接口所属的权限集 id 为:2、100

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

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

# 请求体 Request Payload

参数名类型必填示例说明
begin_openidstringOPENID起始OpenID,为空时从开头拉取

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
totalnumber用户总数
countnumber本次返回的用户数
dataobject用户数据
next_openidstring本次列表后一位openid

# Res.data Object Payload

用户数据

参数名类型说明
openidarrayopenid 列表

# 4. 注意事项

  1. 每次最多拉取1000个OpenID
  2. 通过多次拉取满足需求
  3. begin_openid为空时默认从头开始

# 5. 代码示例

# 5.1 获取黑名单

请求示例

{
  "begin_openid": "OPENID1"
}

返回示例

{
  "total": 23000,
  "count": 1000,
  "data": {
    "openid": [
      "OPENID1",
      "OPENID2"
    ]
  },
  "next_openid": "OPENID1000"
}

# 5.2 错误示例

请求示例

{
  "begin_openid": ""
}

返回示例

{
  "errcode": 40013,
  "errmsg": "invalid appid"
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试
0ok成功
40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口
40003传入非法的openid检查openid
49003传入的openid不属于此AppID检查openid

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
公众号服务号
仅认证 仅认证
  • 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;