# Get a list of subscribers
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: getFans
This interface is used to obtain an account's followers list, which consists of a string of OpenIDs (encrypted WeChat numbers, each user unique to each Official Account OpenID).
# 1. How to call
# HTTPS calls
GET https://api.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&next_openid=NEXT_OPENID
# Cloud Calls
Call method: officialAccount.user.getList
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 | Example | Introductions |
---|---|---|---|---|
access_token | string | yes | ACCESS_TOKEN | Interface invocation credentials, using access_token , authorizer_access_token |
next_openid | string | no | OPENID | The last OPENID of the previous batch list, without filling the default to pull from the beginning |
# Request BodyRequest Payload
nothing
# 3. Return Parameters
# Response Payload
Parameter Name | type | Introductions |
---|---|---|
total | number | Total number of users who follow this public account |
count | number | Number of OPENIDs pulled, with a maximum value of 10000 |
data | object | List data, the list of OPENID |
next_openid | string | Pull the OPENID of a user after the list |
# Res.dataObject Payload
List data, the list of OPENID
Parameter Name | type | Introductions |
---|---|---|
openid | array | Unique user ID |
# 4. Note
- OpenID with up to 10,000 followers in a single pull call, which can be met by multiple pull calls.
- Next_openid may be empty on the last return indicating the end of the list.
# 5. Code examples
# 5.1 Pull up a list of followers for the first time
Example Requests
https://api.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN
Return an example
{
"total":23000,
"count":10000,
"data":{"
openid":[
"OPENID1",
"OPENID2",
...,
"OPENID10000"
]
},
"next_openid":"OPENID10000"
}
# 5.2 Split the page to pull out the middle batch
Example Requests
https://api.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&next_openid=NEXT_OPENID1
Return an example
{
"total":23000,
"count":10000,
"data":{
"openid":[
"OPENID10001",
"OPENID10002",
...,
"OPENID20000"
]
},
"next_openid":"OPENID20000"
}
# 5.3 Last page pullback
Example Requests
https://api.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&next_openid=NEXT_OPENID2
Return an example
{
"total":23000,
"count":3000,
"data":{"
"openid":[
"OPENID20001",
"OPENID20002",
"...",
"OPENID23000"
]
},
"next_openid":""
}
# 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. |
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 | invalid openid | Invalid OpenID. Please confirm if the OpenID is following Official Account, or if it is another OpenID from the Official Account message template. |
40013 | invalid appid | Invalid AppID |
# 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;