查询企业账号用户详情

调用本接口获取指定企业账号用户的详细信息。

使用说明

获取部门企业用户详情接口,仅支持购买开通企业账号的组织使用。

权限

添加接口权限

服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。

应用类型

是否支持调用

权限申请方式

API Explorer调试

企业内部应用

开发者后台申请权限:

成员信息读权限111

调试

第三方企业应用

开发者后台申请权限:

成员信息读权限zszh6

调试

第三方个人应用

添加获取手机号和邮箱权限

如果需要获取手机号和邮箱等权限,不同的应用类型获取方式不同。

  • 企业内部应用

企业内部应用如需获取用户的手机号、邮箱信息,需要添加获取通讯录中手机号和邮箱的权限。添加方法如下:

登录钉钉开发者后台 > 企业内部开发 > 找到需添加权限的应用 > 权限管理 > 通讯录管理页面,勾选企业员工手机号信息邮箱等个人信息,单击申请权限。未标题-1

  • 第三方企业应用

第三方企业应用如需获取用户手机号、邮箱信息,可以使用钉钉统一授权套件方式获取。

基本信息

请求方式:POST

请求地址https://oapi.dingtalk.com/topapi/v2/user/get

Query参数

名称

类型

是否必填

示例值

描述

access_token

String

be3Fxxxx

调用该接口的应用凭证。

Body参数

名称

类型

是否必填

示例值

描述

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,可以使用钉钉统一授权套件方式获取。

mobile

String

18513027676

手机号码。

说明

  • 企业内部应用如果没有返回该字段,需要检查当前应用通讯录权限中企业员工手机号信息权限是否开启。

  • 第三方企业应用不返回该字段;如需获取mobile,可以使用钉钉统一授权套件方式获取。

hide_mobile

Boolean

false

是否号码隐藏:

  • true:隐藏

  • false:不隐藏

    说明

    隐藏手机号后,手机号在个人资料页隐藏,但仍可对其发DING、发起钉钉商务电话。

telephone

String

010-86123456-2345

分机号。

说明

第三方企业应用不返回该字段。

job_number

String

4

员工工号。

title

String

技术总监

职位。

email

String

test@xxx.com

员工邮箱。

说明

  • 企业内部应用如果没有返回该字段,需要检查当前应用通讯录权限中邮箱等个人信息权限是否开启。

  • 第三方企业应用不返回该字段;如需获取email,可以使用钉钉统一授权套件方式获取。

org_email

String

test@xxx.com

员工的企业邮箱。

如果员工的企业邮箱没有开通,返回信息中不包含该数据。

说明

第三方企业应用不返回该字段。

work_place

String

未来park

办公地点。

说明

  • 企业内部应用如果没有返回该字段,需要检查当前应用通讯录权限中邮箱等个人信息权限是否开启。

  • 员工信息面板中该字段内有值才返回å。

  • 第三方企业应用不返回该字段。

remark

String

备注备注

备注。

说明

  • 企业内部应用如果没有返回该字段,需要检查当前应用通讯录权限中邮箱等个人信息权限是否开启。

  • 员工信息面板中该字段内有值才返回。

  • 第三方企业应用不返回该字段。

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

职务

角色组名称。

exclusive_account

Boolean

true

是否为企业账号:

  • true:是

  • false:不是

union_emp_ext

Object

当用户来自于关联组织时的关联信息。

说明

用户所在企业存在关联关系的企业,返回该字段。

userid

String

500

员工的UserId。

union_emp_map_list

Object[]

关联映射关系。

userid

String

5000

关联分支组织中的员工UserId。

corp_id

String

dingxxx

关联分支组织的企业CorpId。

corp_id

String

dingxxx

当前用户所属的组织的企业CorpId。

exclusive_account_type

String

dingtalk

企业账号类型:

  • sso:企业自建企业账号

  • dingtalk:钉钉自建企业账号

    说明

    仅企业账号返回该字段。

login_id

String

login_id3

钉钉自建企业账号的登录名。

说明

仅归属于本企业的钉钉企业账号号返回该字段。

manager_userid

String

manager240

员工的直属主管。

说明

员工在企业管理后台个人信息面板中,直属主管内有值,才会返回该字段。

org_email_type

String

profession

员工的企业邮箱类型:

  • profession:标准版

  • base:基础版

nickname

String

昵称

员工昵称。

说明

仅归属于本企业的钉钉企业账号返回该字段。

exclusive_account_corp_name

String

组织名称

企业账号归属组织的组织名称。

说明

仅适用于企业账号,返回创建该企业账号的组织。

exclusive_account_corp_id

String

dingxxx

企业账号归属组织的组织CorpId。

说明

仅适用于企业账号,返回创建该企业账号的组织。

disable_status

Boolean

false

本组织企业账号的停用状态:

  • true:停用

  • false:启用

说明

仅归属于本企业的钉钉企业账号返回该字段。

示例

请求示例(HTTP)

POST https://oapi.dingtalk.com/topapi/v2/user/get?access_token=ACCESS_TOKEN

请求正文

{
        "language":"zh_CN",
        "userid":"zhangsan"
}

请求示例(JAVA SDK)

public class Main {
    public static void main(String[] args) {
        try {
            DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/v2/user/get");
            OapiV2UserGetRequest req = new OapiV2UserGetRequest();
            req.setUserid("user123");
            OapiV2UserGetResponse rsp = client.execute(req, access_token);
            System.out.println(rsp.getBody());
        } catch (ApiException e) {
            e.printStackTrace();
        }
    }
}

返回示例

{
        "errcode":"0",
        "result":{
                "exclusive_account_type":"dingtalk",
                "extension":"{\"爱好\":\"旅游\",\"年龄\":\"24\"}",
                "unionid":"z21HjQliSzpw0YWCNxmii6u2Os62cZ62iSZ",
                "boss":"true",
                "role_list":{
                        "group_name":"职务",
                        "name":"总监",
                        "id":"100"
                },
                "exclusive_account":"true",
                "manager_userid":"manager240",
                "admin":"true",
                "remark":"备注备注",
                "title":"技术总监",
                "hired_date":"1597573616828",
                "userid":"zhangsan",
                "org_email_type":"profession",
                "work_place":"未来park",
                "dept_order_list":{
                        "dept_id":"2",
                        "order":"1"
                },
                "real_authed":"true",
                "nickname":"昵称",
                "dept_id_list":"[2,3,4]",
                "job_number":"4",
                "email":"test@xxx.com",
                "leader_in_dept":{
                        "leader":"true",
                        "dept_id":"2"
                },
                "login_id":"login_id3",
                "exclusive_account_corp_name":"组织名称",
                "mobile":"18513027676",
                "active":"true",
                "telephone":"010-86123456-2345",
                "avatar":"xxx",
                "hide_mobile":"false",
                "exclusive_account_corp_id":"dingxxx",
                "senior":"true",
                "org_email":"test@xxx.com",
                "name":"张三",
                "union_emp_ext":{
                        "union_emp_map_list":{
                                "userid":"5000",
                                "corp_id":"dingxxx"
                        },
                        "userid":"500",
                        "corp_id":"dingxxx"
                },
                "state_code":"86"
        },
        "errmsg":"ok"
}

错误码

错误码(errcode)

错误码描述(errmsg)

解决方案

33012

无效的userId

请检查userId是否正确

400002

无效的参数

请确认参数是否按要求输入

-1

系统繁忙

请稍后再试