批量查询用户信息
调用该接口批量查询用户信息,仅支持单一租户查询,批量条件仅允许一个(不支持组合条件),默认只返回处于正常状态的用户数据。
注意事项
- 仅返回处于正常状态的用户数据;
- 单次请求上限为100条用户记录;
- 批量条件仅支持一种(如通过
union_ids数组查询),不支持多条件组合; - 仅支持查询单一租户数据。
请求
| 基本 | |
|---|---|
| 请求方式 | POST |
| 请求地址 | /openapi/v3/contacts/users/batch_query_condition |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | 值格式:Bearer {{access_token}}调用 API 时,需要通过访问凭证(access_token)进行身份鉴权,不同类型的访问凭证可获取的数据范围不同,参考 获取访问凭证 。 支持鉴权类型: • 应用级token:以应用身份调用 API,校验应用的数据访问范围。参考 获取企业内部应用access_token。• 用户级token:以登录用户身份调用 API,校验用户的可见数据范围。参考 获取登录用户access_token。 |
| Content-Type | string | 是 | 固定值:application/json; charset=utf-8 |
请求参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| union_ids | array[string] | 是 | 用户唯一ID(union_id)数组,单次请求上限100条;批量条件仅支持此单一参数,接口仅支持查询1个租户数据 |
请求体示例
1{2 "union_ids": ["523983079131807737"] // 用户唯一id数组,单次最多100个3}
响应
响应体
1{2 "code": 0, // 错误码,非0表示失败3 "msg": "success", // 错误信息,成功时为"success"4 "data": {5 "users": [6 {7 "union_id": "", // 用户OneID企业用户id8 "name": "", // 用户名9 "join_time": "", // 加入时间10 "avatar": "头像", // 用户头像URL11 "status": "", // 用户状态(正常状态返回具体值,默认只返回正常状态)12 "alias_id": "", // 用户自定义ID13 "employee_number": "", // 工号14 "position": "架构师", // 职位15 "username": "", // SSO登录名16 "departments": [ // 部门信息17 {18 "department_id": "2312312", // 部门ID19 "department_name": "dept", // 部门名称20 "department_parent_id": "parent" // 父部门ID21 }22 ]23 }24 ]25 }26}
