接口调用说明
调用本接口可以实现查询普通账号用户详情或查询企业账号用户详情。由于在调用时参数使用有较多区别,为便于开发者查看,按照新用户的账号类型进行拆分优化:- 查询普通账号用户详情,接口说明文档请查看本文介绍。
- 查询企业账号用户详情,接口说明文档请参见查询企业账号用户详情。
-
企业内部应用如需获取用户的手机号、邮箱信息,需要添加获取通讯录中手机号和邮箱的权限。添加方法如下:
登录钉钉开发者后台 > 企业内部开发 > 找到需添加权限的应用 > 权限管理 > 通讯录管理页面,勾选企业员工手机号信息和邮箱等个人信息,单击申请权限。
- 第三方企业应用如需获取用户手机号、邮箱信息,可以使用钉钉统一授权套件方式获取。
请求
| 基本信息 | |
|---|---|
| HTTP URL | https://oapi.dingtalk.io/topapi/v2/user/get |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用appType-第三方企业应用 |
| 权限要求 | permission-qyapi_get_member-成员信息读权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | bE74xxxx | 调用该API的应用凭证。 - 企业内部应用,通过获取企业内部应用的access_token接口获取。 - 第三方企业应用,通过获取第三方企业的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| userid | String | 是 | manager4220 | 用户的userId。 |
| language | String | 否 | zh_CN | 通讯录语言。 - zh_CN:中文(默认值) - en_US:英文 |
请求示例
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| request_id | String | 4e7exhl6pm0t | 请求ID。 |
| errcode | Number | 0 | 返回码。 |
| errmsg | String | ok | 返回码描述。 |
| result | Object | 返回结果。 | |
| userid | String | zhangsan | 员工的userId。 |
| unionid | String | z21HjQliSzpw0YWCNxmii6u2Os62cZ62iSZ | 员工在当前开发者企业账号范围内的唯一标识。 |
| name | String | 张三 | 员工姓名。 |
| avatar | String | xxx | 头像。 说明 员工使用默认头像,不返回该字段,手动设置头像会返回。 |
| state_code | String | 86 | 国际电话区号。 说明 第三方企业应用不返回该字段;如需获取state_code,可以使用钉钉统一授权套件方式获取。 |
| manager_userid | String | user01 | 员工的直属主管。 说明 员工在企业管理后台个人信息面板中,直属主管内有值,才会返回该字段。 |
| mobile | String | 13800138000 | 手机号码。 说明 - 企业内部应用,只有应用开通通讯录企业员工手机号信息权限,才会返回该字段。 image - 第三方企业应用不返回该字段,如需获取mobile,可以使用钉钉统一授权套件方式获取。 |
| hide_mobile | Boolean | false | 是否号码隐藏: - true:隐藏 - false:不隐藏 说明 隐藏手机号后,手机号在个人资料页隐藏,但仍可对其发DING、发起钉钉免费商务电话。 |
| telephone | String | 010-86123456-2345 | 分机号。 说明 第三方企业应用不返回该参数。 |
| job_number | String | 4 | 员工工号。 |
| title | String | 技术总监 | 职位。 |
| String | test@xxx.com | 员工邮箱。 说明 - 企业内部应用,只有应用开通通讯录邮箱等个人信息权限,才会返回该字段。 - 第三方企业应用,不返回该参数;如需获取email,可以使用钉钉统一授权套件方式获取。 | |
| work_place | String | 未来park | 办公地点。 说明 - 员工信息面板中该字段必须有值,才正常返回。如果无值,则不返回该字段。 - 企业内部应用,只有应用开通通讯录邮箱等个人信息权限,才会返回该字段。 - 第三方企业应用,不返回该参数。 |
| remark | String | 备注备注 | 备注。 说明 - 员工信息面板中该字段必须有值,才正常返回。如果无值,则不返回该字段。 - 企业内部应用,只有应用开通通讯录邮箱等个人信息权限,才会返回该字段。 - 第三方企业应用,不返回该参数。 |
| exclusive_account | Boolean | false | 是否为企业账号: - true:是 - false:不是 |
| org_email | String | test@xxx.com | 员工的企业邮箱。 如果员工的企业邮箱没有开通,返回信息中不包含该数据。 说明 第三方企业应用不返回该参数。 |
| dept_id_list | Number[] | [2,3,4] | 所属部门id列表。 |
| dept_order_list | Object[] | 员工在对应的部门中的排序。 | |
| dept_id | Number | 2 | 部门id。 |
| order | Number | 1 | 员工在部门中的排序。 |
| extension | String | {"爱好":"旅游","年龄":"24"} | 扩展属性,最大长度 2000 个字符。 说明 - 员工信息面板中添加的拓展字段内有值才返回。 - 企业内部应用,只有应用开通通讯录邮箱等个人信息权限,才会返回该字段。 - 第三方企业应用,不返回该字段。 - 重要提示:直接添加新属性会覆盖原有属性值,需要先获取现有属性,然后将新属性追加到已有属性上,再进行整体更新。 |
| hired_date | Number | 1597573616828 | 入职时间,Unix时间戳,单位毫秒。 说明 - 信息面板中入职时间字段内有值才返回。 - 第三方企业应用,不返回该参数。 |
| active | Boolean | true | 是否激活了钉钉: - true:已激活 - false:未激活 |
| real_authed | Boolean | true | 是否完成了实名认证: - true:已认证 - false:未认证 |
| senior | Boolean | true | 是否为企业的高管: - true:是 - false:不是 |
| admin | Boolean | true | 是否为企业的管理员: - true:是 - false:不是 |
| boss | Boolean | true | 是否为企业的老板: - true:是 - false:不是 |
| leader_in_dept | Object[] | 员工所在部门信息及是否是领导: - 员工所在部门的部门ID。 - 员工在对应的部门中是否是领导: - true:是 - false:不是 | |
| dept_id | Number | 2 | 部门ID。 |
| leader | Boolean | true | 是否是领导: - true:是 - false:不是 |
| role_list | Object[] | 角色列表。 | |
| id | Number | 100 | 角色ID。 |
| name | String | 总监 | 角色名称。 |
| group_name | String | 职务 | 角色组名称。 |
| union_emp_ext | Object | 当用户来自于关联组织时的关联信息。 说明 用户所在企业存在关联关系的企业,返回该字段。 | |
| userid | String | 500 | 员工id的userId。 |
| union_emp_map_list | Object[] | 关联映射关系。 | |
| userid | String | 5000 | 关联分支组织中的员工userId。 |
| corp_id | String | dingxxx | 关联分支组织的企业corpId。 |
| corp_id | String | dingxxx | 当前用户所属的组织的企业corpId。 |
| dept_position_list | DeptPosition[] | 部门内任职信息。 | |
| extension_i18n | Json | {"爱好": {"zh_CN": "旅游", "en_US": "travel", "aJP": "旅行"}} | 扩展属性的国际化值。 |
响应体示例
错误码
若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。| 错误码(errcode) | 错误码描述(errmsg) | 解决方案 |
|---|---|---|
| 33012 | 无效的 userId | 请检查 userId 是否正确 |
| 400002 | 无效的参数 | 请确认参数是否按要求输入 |
| -1 | 系统繁忙 | 请稍后再试 |