# Get a blacklist list for Official Account
Interface should be called on the server side, not in the front end (Weixin Mini Program, web pages, APP, etc.) directly called, specific reference interface call guide
Interface English name: getBlacklist
This interface is used to obtain a blacklist of accounts consisting of a string of OpenIDs (encrypted WeChat numbers, each user unique to each Official Account OpenID).
# 1. How to call
# HTTPS calls
POST https://api.weixin.qq.com/cgi-bin/tags/members/getblacklist?access_token=ACCESS_TOKEN
# Cloud Calls
Call method: officialAccount.user.getBlacklist
The input and exit parameters are the same as the HTTPS call, which can be called in the cloud call documentation
# Third party invocation
This interface supports Third Party Platform generation business call.
The permission set id to which the interface belongs is: 2,100
When a service provider is authorized by one of the permissions set, it can call on behalf of the merchant by using authorizer_access_token , which can be viewed in the third-party call documentation.
# 2. Request parameters
# Query parametersQuery String parameters
Parameter Name | type | Required to fill in | Introductions |
---|---|---|---|
access_token | string | yes | Interface invocation credentials, using access_token , authorizer_access_token |
# Request BodyRequest Payload
Parameter Name | type | Required to fill in | Example | Introductions |
---|---|---|---|---|
begin_openid | string | no | OPENID | Start OpenID, pull from the beginning when empty |
# 3. Return Parameters
# Response Payload
Parameter Name | type | Introductions |
---|---|---|
total | number | Total number of users |
count | number | Number of users returned this time |
data | object | User data |
next_openid | string | The last one in this list is openid |
# Res.dataObject Payload
User data
Parameter Name | type | Introductions |
---|---|---|
openid | array | Openid List |
# 4. Note
- Pull up to 1000 OpenIDs at a time
- Meet demand through multiple pullouts
- Start from the beginning by default when begin_openid is empty
# 5. Code examples
# 5.1 Get a blacklist
Example Requests
{
"begin_openid": "OPENID1"
}
Return an example
{
"total": 23000,
"count": 1000,
"data": {
"openid": [
"OPENID1",
"OPENID2"
]
},
"next_openid": "OPENID1000"
}
# 5.2 Examples of Errors
Example Requests
{
"begin_openid": ""
}
Return an example
{
"errcode": 40013,
"errmsg": "invalid appid"
}
# 6. Error code
The following is a list of error codes for this interface, other error codes can refer to General error codes
Error code | Error Description | Solutions |
---|---|---|
-1 | system error | The system is busy, so the developer is asked to try again in a few minutes. |
0 | ok | success |
40001 | invalid credential access_token isinvalid or not latest | AppSecret error while getting access_token, or access_token is invalid.Developers should check that AppSecret is correct, or that they are calling interfaces for the appropriate Official Account |
40003 | Passing in an illegal openid | Check openid |
49003 | The incoming openid does not belong to this AppID | Check openid |
# 7. Scope of application
Official Account | Service Account |
---|---|
Certification only | Certification only |
- Authentication only: means that only authenticated accounts are allowed to be invoked by the enterprise entity, and accounts that are not authenticated or do not support authentication cannot be invoked.
- Other account types that are not expressly stated may not be called on this interface without special instructions;