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

dingtalk.oapi.v2.user.list (查询部门用户完整信息)

查询部门用户完整信息

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
dept_id	Number	必须	10	最小值：1	部门id
cursor	Number	必须	0	最小值：0 最大值：100000	游标
size	Number	必须	10	最小值：1 最大值：100	分页长度
order_field	String	可选	modify_desc		排序字段，默认custom。或者以下取值entry_asc、entry_desc、modify_asc、modify_desc、custom
contain_access_limit	Boolean	可选	false	默认值：false	是否返回访问受限的员工
language	String	可选	zh_CN	最大长度：6	语言

响应参数

名称	类型	示例值	描述
errcode	Number	0	错误码。0代表成功。
errmsg	String	ok	错误信息。
result	PageResult		返回结果
└ has_more Boolean true 是否还有更多的数据 └ next_cursor Number 10 下一次分页的游标，如果has_more为false，表示没有更多的分页数据 list ListUserResponse [] 用户信息列表 └ 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 Number 1 员工在部门中的排序。 └ extension String {"爱好":"旅游","年龄":"24"} 扩展属性 └ hired_date Number 1597573616828 入职时间，Unix时间戳，单位ms。 └ active Boolean true 是否激活 └ admin Boolean true 是否管理员 └ boss Boolean true 是否老板 └ leader Boolean true 是否领导 └ exclusive_account Boolean true 是否专属帐号 └ login_id String login_id3 本组织专属帐号登录名 └ exclusive_account_type String dingtalk\|sso 专属帐号类型 └ nickname String 昵称查询本组织专属帐号时可获得昵称 └ exclusive_account_corp_name String 组织名称专属帐号归属组织的组织名称 └ exclusive_account_corp_id String corpxxx 专属帐号归属组织的组织id └ gender String F/M/none 性别 └ disable_status Boolean true 企业账号是否停用

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/v2/user/list");
OapiV2UserListRequest req = new OapiV2UserListRequest();
req.setDeptId(10L);
req.setCursor(0L);
req.setSize(10L);
req.setOrderField("modify_desc");
req.setContainAccessLimit(false);
req.setLanguage("zh_CN");
OapiV2UserListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/v2/user/list");
OapiV2UserListRequest req = new OapiV2UserListRequest();
req.DeptId = 10L;
req.Cursor = 0L;
req.Size = 10L;
req.OrderField = "modify_desc";
req.ContainAccessLimit = false;
req.Language = "zh_CN";
OapiV2UserListResponse 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 OapiV2UserListRequest;
$req->setDeptId("10");
$req->setCursor("0");
$req->setSize("10");
$req->setOrderField("modify_desc");
$req->setContainAccessLimit("false");
$req->setLanguage("zh_CN");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/v2/user/list");

curl -X POST "https://oapi.dingtalk.com/topapi/v2/user/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=f0bb26d1-e9b7-45bb-9afc-2bbc429079aa' \
-d 'contain_access_limit=false' \
-d 'cursor=0' \
-d 'dept_id=10' \
-d 'language=zh_CN' \
-d 'order_field=modify_desc' \
-d 'size=10'

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

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

req.dept_id=10
req.cursor=0
req.size=10
req.order_field="modify_desc"
req.contain_access_limit=false
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.list");
add_param(pRequest,"dept_id","10");
add_param(pRequest,"cursor","0");
add_param(pRequest,"size","10");
add_param(pRequest,"order_field","modify_desc");
add_param(pRequest,"contain_access_limit","false");
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.list', {
	'dept_id':'10',
	'cursor':'0',
	'size':'10',
	'order_field':'modify_desc',
	'contain_access_limit':'false',
	'language':'zh_CN'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"ok",
    "result":{
        "has_more":true,
        "next_cursor":10,
        "list":[
            {
                    "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":1,
                    "extension":"{\"爱好\":\"旅游\",\"年龄\":\"24\"}",
                    "hired_date":1597573616828,
                    "active":true,
                    "admin":true,
                    "boss":true,
                    "leader":true,
                    "exclusive_account":true,
                    "login_id":"login_id3",
                    "exclusive_account_type":"dingtalk|sso",
                    "nickname":"昵称",
                    "exclusive_account_corp_name":"组织名称",
                    "exclusive_account_corp_id":"corpxxx",
                    "gender":"F\/M\/none",
                    "disable_status":true
            }
        ]
    }
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案
isv.invalid-argument

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.v2.user.list (查询部门用户完整信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ