文档中心 > API类目 > 钉钉API

dingtalk.oapi.v2.user.get (查询用户详情)

查询用户详情

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
userid	String	必须	zhangsan	最大长度：64	用户id
language	String	可选	zh_CN	最大长度：6	语言

响应参数

名称	类型	示例值	描述
errcode	Number	0	错误码。0代表成功。
errmsg	String	ok	错误信息。
result	UserGetResponse		业务返回结果
└ userid String zhangsan 用户id └ unionid String z21HjQliSzpw0YWCNxmii6u2Os62cZ62iSZ 员工在当前开发者企业账号范围内的唯一标识 └ name String 张三员工名称 └ avatar String xxx 头像 └ state_code String 86 国际电话区号 └ mobile String 18513027676 手机号码 └ hide_mobile Boolean false 是否号码隐藏。隐藏手机号后，手机号在个人资料页隐藏，但仍可对其发DING、发起钉钉免费商务电话。 └ telephone String 010-86123456-2345 分机号 └ job_number String 4 员工工号 └ title String 技术总监职位 └ email String test@xxx.com 员工邮箱 └ org_email String test@xxx.com 员工的企业邮箱 └ work_place String 未来park 办公地点 └ remark String 备注备注备注 └ dept_id_list Number [] [2,3,4] 所属部门id列表 dept_order_list DeptOrder [] 员工在对应的部门中的排序。 └ dept_id Number 2 部门id └ order Number 1 员工在部门中的排序。 └ extension String {"爱好":"旅游","年龄":"24"} 扩展属性，长度最大2000个字符。可以设置多种属性（手机上最多显示10个扩展属性，具体显示哪些属性，请到OA管理后台->设置->通讯录信息设置和OA管理后台->设置->手机端显示信息设置）。该字段的值支持链接类型填写，同时链接支持变量通配符自动替换，目前支持通配符有：userid，corpid。示例： [工位地址](http://www.dingtalk.com?userid=#userid#&corpid=#corpid#) └ hired_date Number 1597573616828 入职时间，Unix时间戳，单位ms。 └ active Boolean true 是否激活 └ real_authed Boolean true 是否实名认证 └ senior Boolean true 是否高管 └ admin Boolean true 是否管理员 └ boss Boolean true 是否老板 leader_in_dept DeptLeader [] 员工在对应的部门中是否领导。 └ dept_id Number 2 部门id └ leader Boolean true 是否领导 role_list UserRole [] 角色列表 └ id Number 100 角色id └ name String 总监角色名称 └ group_name String 职务角色组名称 └ exclusive_account Boolean true 是否专属帐号 union_emp_ext UnionEmpExt 关联信息 └ userid String 500 员工id union_emp_map_list UnionEmpMapVo [] 关联映射关系 └ userid String 5000 员工id └ corp_id String dingxxx 企业id └ corp_id String dingxxx 企业id └ exclusive_account_type String dingtalk 专属帐号类型：{sso: 企业自定义idp;dingtalk: 钉钉idp} └ login_id String login_id3 本组织专属帐号登录名 └ manager_userid String manager240 主管的ID，仅限企业内部开发调用 dept_position_list DeptPosition [] 任职信息 └ dept_id Number 2 部门id └ is_main Boolean true 是否是主任职 └ work_place String 未来park 部门内工作地 └ title String 总监部门内职位 └ manager_userid String 100 部门内直属主管员工id └ title_i18n Json {"en_US":"market"} 任职国际化字段 └ work_place_i18n Json {"en_US":"hangzhou"} 办公地点国际化字段 └ org_email_type String profession 企业邮箱类型（profession：标准版，base：基础版） └ nickname String 昵称查询本组织专属帐号时可获得昵称 └ exclusive_account_corp_name String 组织名称专属帐号归属组织的组织名称 └ exclusive_account_corp_id String dingxxx 专属帐号归属组织的组织id ext_attrs EmpExtAttr [] 自定义字段列表 └ code String emp:xxx 自定义字段编码 └ name String 主页自定义字段名称 └ type String link 自定义字段类型 value EmpExtAttrValue 自定义字段值 └ text String 点击前往钉钉官网自定义字段文本值 └ url String www.dingtalk.com 自定义字段链接值 └ images String [] https://img.alicdn.com/imgextra/i2/O1CN01IVwD5w1mqnRxmUBng_!!6000000005006-2-tps-64-64.png 自定义字段图片值 └ gender String F/M/none 性别自定义字段 └ create_time String 2023-11-21T07:43:16.444Z 员工创建：UTC格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' └ limited Boolean false 是否外包:true表示是外包 └ has_subordinate Boolean false 汇报线结构-是否有下属 └ dept_name String 部门1-部门11-部门111 汇报线结构-按照人所在的部门链信息 └ flower_name String 花名企业内昵称（花名） └ disable_status Boolean false 企业账号是否停用 └ extension_i18n String {"爱好":{"zh_CN": "旅游", "en_US": "travel", "ja_JP": "旅行"}} 扩展属性的国际化值

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/v2/user/get");
OapiV2UserGetRequest req = new OapiV2UserGetRequest();
req.setUserid("zhangsan");
req.setLanguage("zh_CN");
OapiV2UserGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/v2/user/get");
OapiV2UserGetRequest req = new OapiV2UserGetRequest();
req.Userid = "zhangsan";
req.Language = "zh_CN";
OapiV2UserGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiV2UserGetRequest;
$req->setUserid("zhangsan");
$req->setLanguage("zh_CN");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/v2/user/get");

curl -X POST "https://oapi.dingtalk.com/topapi/v2/user/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=dc0dfc63-9d9a-4405-8748-94e7c113f103' \
-d 'language=zh_CN' \
-d 'userid=zhangsan'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiV2UserGetRequest("https://oapi.dingtalk.com/topapi/v2/user/get")

req.userid="zhangsan"
req.language="zh_CN"
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.v2.user.get");
add_param(pRequest,"userid","zhangsan");
add_param(pRequest,"language","zh_CN");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.v2.user.get', {
	'userid':'zhangsan',
	'language':'zh_CN'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"ok",
    "result":{
        "userid":"zhangsan",
        "unionid":"z21HjQliSzpw0YWCNxmii6u2Os62cZ62iSZ",
        "name":"张三",
        "avatar":"xxx",
        "state_code":"86",
        "mobile":"18513027676",
        "hide_mobile":false,
        "telephone":"010-86123456-2345",
        "job_number":"4",
        "title":"技术总监",
        "email":"test@xxx.com",
        "org_email":"test@xxx.com",
        "work_place":"未来park",
        "remark":"备注备注",
        "dept_id_list":{
            "number":[
                [2,
                3,
                4]
            ]
        },
        "dept_order_list":[
            {
                    "dept_id":2,
                    "order":1
            }
        ],
        "extension":"{\"爱好\":\"旅游\",\"年龄\":\"24\"}",
        "hired_date":1597573616828,
        "active":true,
        "real_authed":true,
        "senior":true,
        "admin":true,
        "boss":true,
        "leader_in_dept":[
            {
                    "dept_id":2,
                    "leader":true
            }
        ],
        "role_list":[
            {
                    "id":100,
                    "name":"总监",
                    "group_name":"职务"
            }
        ],
        "exclusive_account":true,
        "union_emp_ext":{
            "userid":"500",
            "union_emp_map_list":[
                {
                        "userid":"5000",
                        "corp_id":"dingxxx"
                }
            ],
            "corp_id":"dingxxx"
        },
        "exclusive_account_type":"dingtalk",
        "login_id":"login_id3",
        "manager_userid":"manager240",
        "dept_position_list":[
            {
                    "dept_id":2,
                    "is_main":true,
                    "work_place":"未来park",
                    "title":"总监",
                    "manager_userid":"100",
                    "title_i18n":"{\"en_US\":\"market\"}",
                    "work_place_i18n":"{\"en_US\":\"hangzhou\"}"
            }
        ],
        "org_email_type":"profession",
        "nickname":"昵称",
        "exclusive_account_corp_name":"组织名称",
        "exclusive_account_corp_id":"dingxxx",
        "ext_attrs":[
            {
                    "code":"emp:xxx",
                    "name":"主页",
                    "type":"link",
                    "value":{
                        "text":"点击前往钉钉官网",
                        "url":"www.dingtalk.com",
                        "images":{
                            "string":[
                                "https:\/\/img.alicdn.com\/imgextra\/i2\/O1CN01IVwD5w1mqnRxmUBng_!!6000000005006-2-tps-64-64.png"
                            ]
                        }
                    }
            }
        ],
        "gender":"F\/M\/none",
        "create_time":"2023-11-21T07:43:16.444Z",
        "limited":false,
        "has_subordinate":false,
        "dept_name":"部门1-部门11-部门111",
        "flower_name":"花名",
        "disable_status":false,
        "extension_i18n":"{\"爱好\":{\"zh_CN\": \"旅游\", \"en_US\": \"travel\", \"ja_JP\": \"旅行\"}}"
    }
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案
isp.-1

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

亲，您还没填写反馈内容。

联系方式

亲，电话号码格式不正确。

验证码刷新
亲，验证码错啦！

提交反馈

用户反馈

感谢您的反馈！

用户反馈

网络异常，请重新提交！
重新提交

钉钉API

dingtalk.oapi.v2.user.get (查询用户详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈