# 批量获取用户基本信息

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：batchUserinfo

本接口用于批量获取用户基本信息。最多支持一次拉取100条。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/cgi-bin/user/info/batchget?access_token=ACCESS_TOKEN
```

### 云调用

- 调用方法：officialAccount.user.batchGetInfo

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

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

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

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/doc/service/api/base/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "user_list",
    "类型": "objarray",
    "必填": "是",
    "说明": "用户列表"
  }
]
```

">

### Body.user_list(Array) `Object Payload`

用户列表

```json
[
  {
    "参数名": "openid",
    "类型": "string",
    "必填": "是",
    "示例": "otvxTs4dckWG7imySrJd6jSi0CWE",
    "说明": "用户的标识，对当前公众号唯一；必须是已关注的用户的 openid"
  },
  {
    "参数名": "lang",
    "类型": "string",
    "必填": "否",
    "示例": "zh_CN",
    "说明": "国家地区语言版本，zh_CN 简体，zh_TW 繁体，en 英语，默认为zh-CN"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "user_info_list",
    "类型": "objarray",
    "说明": "用户列表"
  }
]
```

">

### Res.user_info_list(Array) `Object Payload`

用户列表

```json
[
  {
    "参数名": "subscribe",
    "类型": "number",
    "说明": "用户是否订阅该公众号标识，值为0时，代表此用户没有关注该公众号，拉取不到其余信息。"
  },
  {
    "参数名": "openid",
    "类型": "string",
    "说明": "用户的标识，对当前公众号唯一"
  },
  {
    "参数名": "nickname",
    "类型": "string",
    "说明": "【注意：该字段不再提供】用户昵称"
  },
  {
    "参数名": "sex",
    "类型": "number",
    "说明": "【注意：该字段不再提供】用户的性别，值为 1 时是男性，值为 2 时是女性，值为 0 时是未知"
  },
  {
    "参数名": "language",
    "类型": "string",
    "说明": "【注意：该字段不再提供】用户的语言，简体中文为zh_CN"
  },
  {
    "参数名": "city",
    "类型": "string",
    "说明": "【注意：该字段不再提供】普通用户个人资料填写的城市"
  },
  {
    "参数名": "province",
    "类型": "string",
    "说明": "【注意：该字段不再提供】用户个人资料填写的省份"
  },
  {
    "参数名": "country",
    "类型": "string",
    "说明": "【注意：该字段不再提供】国家，如中国为 CN"
  },
  {
    "参数名": "headimgurl",
    "类型": "string",
    "说明": "【注意：该字段不再提供】用户头像，最后一个数值代表正方形头像大小（有 0、46、64、96、132 数值可选，0 代表 640*640 正方形头像），用户没有头像时该项为空。若用户更换头像，原有头像 URL 将失效。"
  },
  {
    "参数名": "subscribe_time",
    "类型": "number",
    "说明": "用户关注时间，为时间戳。如果用户曾多次关注，则取最后关注时间"
  },
  {
    "参数名": "unionid",
    "类型": "string",
    "说明": "只有在用户将公众号绑定到微信开放平台帐号后，才会出现该字段。详见： 获取用户个人信息（UnionID 机制）"
  },
  {
    "参数名": "remark",
    "类型": "string",
    "说明": "公众号运营者对粉丝的备注，公众号运营者可在微信公众平台用户管理界面对粉丝添加备注"
  },
  {
    "参数名": "groupid",
    "类型": "number",
    "说明": "用户所在的分组ID（暂时兼容用户分组旧接口）"
  },
  {
    "参数名": "tagid_list",
    "类型": "-",
    "说明": "用户被打上的标签ID列表"
  },
  {
    "参数名": "subscribe_scene",
    "类型": "number",
    "说明": "返回用户关注的渠道来源，ADD_SCENE_SEARCH 公众号搜索，ADD_SCENE_ACCOUNT_MIGRATION 公众号迁移，ADD_SCENE_PROFILE_CARD 名片分享，ADD_SCENE_QR_CODE 扫描二维码，ADD_SCENE_PROFILE_LINK 图文页内名称点击，ADD_SCENE_PROFILE_ITEM 图文页右上角菜单，ADD_SCENE_PAID 支付后关注，ADD_SCENE_WECHAT_ADVERTISEMENT 微信广告，ADD_SCENE_REPRINT 他人转载 ，ADD_SCENE_LIVESTREAM 视频号直播， ADD_SCENE_CHANNELS 视频号，ADD_SCENE_WXA 小程序关注，ADD_SCENE_OTHERS 其他"
  },
  {
    "参数名": "qr_scene",
    "类型": "number",
    "说明": "二维码扫码场景（开发者自定义）"
  },
  {
    "参数名": "qr_scene_str",
    "类型": "string",
    "说明": "二维码扫码场景描述（开发者自定义）"
  }
]
```

## 4. 注意事项

所有openid必须是已关注的用户

## 5. 代码示例

### 5.1 正常请求

请求示例

``` json
{
  "user_list": [
    {
      "openid": "otvxTs4dckWG7imySrJd6jSi0CWE",
      "lang": "zh_CN"
    },
    {
      "openid": "otvxTs_JZ6SEiP0imdhpi50fuSZg",
      "lang": "zh_CN"
    }
  ]
}
```

返回示例

``` json
{
  "user_info_list": [
    {
      "subscribe": 1,
      "openid": "otvxTs4dckWG7imySrJd6jSi0CWE",
      "language": "zh_CN",
      "subscribe_time": 1434093047,
      "unionid": "oR5GjjgEhCMJFyzaVZdrxZ2zRRF4",
      "remark": "",
      "groupid": 0,
      "tagid_list": [
        128,
        2
      ],
      "subscribe_scene": "ADD_SCENE_QR_CODE",
      "qr_scene": 98765,
      "qr_scene_str": ""
    }
  ]
}
```

### 5.2 错误请求

请求示例

``` json
{
  "user_list": [
    {
      "openid": "otvxTs4dckWG7imySrJd6jSi0CWE",
      "lang": "zh_CN"
    },
    {
      "openid": "otvxTs_JZ6SEiP0imdhpi50fuSZg",
      "lang": "zh_CN"
    }
  ]
}
```

返回示例

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

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-1",
    "错误描述": "system error",
    "解决方案": "系统繁忙，此时请开发者稍候再试"
  },
  {
    "错误码": "40001",
    "错误描述": "invalid credential  access_token isinvalid or not latest",
    "解决方案": "获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口"
  },
  {
    "错误码": "40003",
    "错误描述": "invalid openid",
    "解决方案": "用户未关注或openid错误"
  },
  {
    "错误码": "40013",
    "错误描述": "invalid appid",
    "解决方案": "AppID无效错误"
  },
  {
    "错误码": "40032",
    "错误描述": "invalid openid list size",
    "解决方案": "不合法的 openid 列表长度"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "公众号": "仅认证",
    "服务号": "仅认证"
  }
]
```

- 仅认证：表示仅允许企业主体已认证账号调用，未认证或不支持认证的账号无法调用。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。