WeChat 공개 플랫폼 개발자 문서
/ 黑名单管理
黑名单管理
黑名单管理
公众号可登录微信公众平台,对粉丝进行拉黑的操作。同时,我们也提供了一套黑名单管理API,以便开发者直接利用接口进行操作。
1. 获取公众号的黑名单列表
公众号可通过该接口来获取帐号的黑名单列表,黑名单列表由一串 OpenID(加密后的微信号,每个用户对每个公众号的OpenID是唯一的)组成。
该接口每次调用最多可拉取 10000 个OpenID,当列表数较多时,可以通过多次拉取的方式来满足需求。
接口调用请求说明
http请求方式:POST(请使用https协议) https://api.weixin.qq.com/cgi-bin/tags/members/getblacklist?access_token=ACCESS_TOKEN
JSON 数据说明
{ "begin_openid":"OPENID1" }
当 begin_openid 为空时,默认从开头拉取。
返回说明
正确时返回 JSON数据包
{ "total":23000, "count":10000, "data":{" openid":[ "OPENID1", "OPENID2", ..., "OPENID10000" ] }, "next_openid":"OPENID10000" }
错误时返回 JSON数据包(示例为无效AppID错误)
{"errcode":40013,"errmsg":"invalid appid"}
返回码说明
返回码 | 说明 |
-1 | 系统繁忙 |
40003 | 传入非法的openid |
49003 | 传入的openid不属于此AppID |
同时,请注意:
当公众号黑名单列表数量超过 10000 时,可通过填写 next_openid 的值,从而多次拉取列表的方式来满足需求。
具体而言,就是在调用接口时,将上一次调用得到的返回中的 next_openid 的值,作为下一次调用中的 next_openid 值。
2. 拉黑用户
公众号可通过该接口来拉黑一批用户,黑名单列表由一串 OpenID (加密后的微信号,每个用户对每个公众号的OpenID是唯一的)组成。
接口调用请求说明
http请求方式:POST(请使用https协议) https://api.weixin.qq.com/cgi-bin/tags/members/batchblacklist?access_token=ACCESS_TOKEN
参数说明
参数 | 是否必须 | 说明 |
access_token | 是 | 调用接口凭证 |
openid_list | 是 | 需要拉入黑名单的用户的openid,一次拉黑最多允许20个 |
JSON 数据说明
{ "opened_list":["OPENID1”,” OPENID2”] }
返回说明
正确时返回 JSON数据包
{ "errcode": 0, "errmsg": "ok" }
错误时返回 JSON数据包(示例为无效AppID错误)
{"errcode":40013,"errmsg":"invalid appid"}
返回码说明
返回码 | 说明 |
-1 | 系统繁忙 |
40003 | 传入非法的openid |
49003 | 传入的openid不属于此AppID |
40032 | 一次只能拉黑20个用户 |
3. 取消拉黑用户
公众号可通过该接口来取消拉黑一批用户,黑名单列表由一串OpenID(加密后的微信号,每个用户对每个公众号的OpenID是唯一的)组成。
接口调用请求说明
http请求方式:POST(请使用https协议) https://api.weixin.qq.com/cgi-bin/tags/members/batchunblacklist?access_token=ACCESS_TOKEN
参数说明
参数 | 是否必须 | 说明 |
access_token | 是 | 调用接口凭证 |
openid_list | 是 | 需要拉入黑名单的用户的openid,一次拉黑最多允许20个 |
JSON 数据说明
{ "opened_list":["OPENID1”,” OPENID2”] }
返回说明
正确时返回 JSON数据包
{ "errcode": 0, "errmsg": "ok" }
错误时返回 JSON数据包(示例为无效AppID错误)
{"errcode":40013,"errmsg":"invalid appid"}
返回码说明
返回码 | 说明 |
-1 | 系统繁忙 |
40003 | 传入非法的openid |
49003 | 传入的openid不属于此AppID |
40032 | 一次只能拉黑20个用户 |