公众号
取消
中文
中文
EN
取消
  • 服务端 API

    • # 获取关注用户列表

    调试工具

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

    接口英文名：getFans

    本接口用来获取账号的关注者列表，关注者列表由一串OpenID（加密后的微信号，每个用户对每个公众号的OpenID是唯一的）组成。

    # 1. 调用方式

    # HTTPS 调用

    GET https://api.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&next_openid=NEXT_OPENID

    # 云调用

    • 调用方法：officialAccount.user.getList

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

    # 第三方调用

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

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

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

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填示例说明
    access_tokenstring是ACCESS_TOKEN接口调用凭证，可使用 access_token、authorizer_access_token
    next_openidstring否OPENID上一批列表的最后一个OPENID，不填默认从头开始拉取

    # 请求体 Request Payload

    无

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    totalnumber关注该公众账号的总用户数
    countnumber拉取的OPENID个数，最大值为10000
    dataobject列表数据，OPENID的列表
    next_openidstring拉取列表后一个用户的OPENID

    # Res.data Object Payload

    列表数据，OPENID的列表

    参数名类型说明
    openidarray用户唯一ID

    # 4. 注意事项

    1. 一次拉取调用最多拉取10000个关注者的OpenID，可以通过多次拉取的方式来满足需求。
    2. 最后一次返回时next_openid可能为空表示列表结束。

    # 5. 代码示例

    # 5.1 首次拉取关注者列表

    请求示例

    https://api.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN

    返回示例

    {
  "total":23000,
  "count":10000,
  "data":{"
     openid":[
        "OPENID1",
        "OPENID2",
        ...,
        "OPENID10000"
     ]
   },
   "next_openid":"OPENID10000"
}

    # 5.2 分页拉取中间批次

    请求示例

    https://api.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&next_openid=NEXT_OPENID1

    返回示例

    {
   "total":23000,
   "count":10000,
   "data":{
     "openid":[
       "OPENID10001",
       "OPENID10002",
       ...,
       "OPENID20000"
     ]
   },
   "next_openid":"OPENID20000"
}

    # 5.3 最后一次分页拉取

    请求示例

    https://api.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&next_openid=NEXT_OPENID2

    返回示例

    {
   "total":23000,
   "count":3000,
   "data":{"
       "openid":[
         "OPENID20001",
         "OPENID20002",
         "...",
         "OPENID23000"
       ]
   },
   "next_openid":""
}

    # 6. 错误码

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

    错误码错误描述解决方案
    -1system error系统繁忙，此时请开发者稍候再试
    40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
    40003invalid openid不合法的 OpenID ，请开发者确认 OpenID （该用户）是否已关注公众号，或是否是其他公众号的 OpenID
    40013invalid appid无效的AppID

    # 7. 适用范围

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