接口调用说明
- 本接口只支持获取员工的userId和name两个字段信息,如需获取部门下员工详情信息,请参考获取部门用户详情。
- 本接口只支持获取当前部门内的员工基础信息,子部门内员工信息获取不到。
请求
| 基本信息 | |
|---|---|
| HTTP URL | https://oapi.dingtalk.io/topapi/user/listsimple |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用appType-第三方企业应用 |
| 权限要求 | permission-qyapi_get_department_member-通讯录部门成员读权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | bE74xxxx | 调用该API的应用凭证。 - 企业内部应用,通过获取企业内部应用的access_token接口获取。 - 第三方企业应用,通过获取第三方企业的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| dept_id | Number | 是 | 10 | 部门ID,如果是根部门,该参数传1,可调用获取部门列表获取dept_id参数值。 |
| cursor | Number | 是 | 0 | 分页查询的游标,最开始传0,后续传返回参数中的next_cursor值。 |
| size | Number | 是 | 10 | 分页长度,最大值100。 |
| order_field | String | 否 | modify_desc | 部门成员的排序规则。默认值,custom。 - entry_asc:代表按照进入部门的时间升序。 - entry_desc:代表按照进入部门的时间降序。 - modify_asc:代表按照部门信息修改时间升序。 - modify_desc:代表按照部门信息修改时间降序。 - custom:代表用户定义(未定义时按照拼音)排序。 |
| contain_access_limit | Boolean | 否 | false | 是否返回访问受限的员工。 - true:是 - false:否 |
| language | String | 否 | zh_CN | 通讯录语言,取值。 - zh_CN:中文(默认值)。 - en_US:英文。 |
请求示例
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| request_id | String | 4f9md9obopn2 | 请求ID。 |
| errcode | Number | 0 | 返回码,0代表成功。 |
| errmsg | String | ok | 返回码描述。 |
| result | PageResult | 返回结果。 | |
| has_more | Boolean | true | 是否还有更多的数据。 - true:是 - false:否 |
| next_cursor | Number | 10 | 下一次分页的游标,如果has_more为false,表示没有更多的分页数据。 |
| list | ListUserSimpleResponse[] | 用户信息列表。 | |
| userid | String | zxxxxx | 用户的userid。 |
| name | String | 张三 | 用户姓名。 |
响应体示例
错误码
若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。| 错误码(errcode) | 错误码描述(errmsg) | 解决方案 |
|---|---|---|
| 400002 | 无效的参数 | 请确认参数按上述要求填写 |
| 60003 | 未找到对应部门 | 请确认部门id是否正确 |
| 40069 | 无效的size | 请调整分页的大小 |
| 40068 | 无效的偏移量 | 请调整偏移量 |
| -1 | 系统繁忙 | 请稍后再试 |