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

dingtalk.oapi.user.listbypage (获取部门成员(详情))

获取部门成员（详情）

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
lang	String	可选	1	通讯录语言(默认zh_CN另外支持en_US)
department_id	Number	可选	1	获取的部门id
offset	Number	必须	1	支持分页查询，与size参数同时设置时才生效，此参数代表偏移量
size	Number	必须	1	支持分页查询，与offset参数同时设置时才生效，此参数代表分页大小，最大100
order	String	可选	1	支持分页查询，部门成员的排序规则，默认不传是按自定义排序；entry_asc代表按照进入部门的时间升序，entry_desc代表按照进入部门的时间降序，modify_asc代表按照部门信息修改时间升序，modify_desc代表按照部门信息修改时间降序，custom代表用户定义(未定义时按照拼音)排序

响应参数

名称	类型	示例值	描述
errcode	Number	0	errcode
errmsg	String	ok	errmsg
hasMore	Boolean	false	hasMore
userlist	Userlist []		userlist
└ userid String 1 userid └ order Number 1 order └ dingId String 1 dingId └ unionid String 1 unionid └ mobile String 1 mobile └ tel String 1 tel └ workPlace String 1 workPlace └ remark String 1 remark └ isAdmin Boolean false isAdmin └ isBoss Boolean false isBoss └ isHide Boolean false isHide └ isLeader Boolean false isLeader └ name String 1 name └ active Boolean false active └ department Number [] 1 department └ position String 1 position └ email String 1 email └ orgEmail String 1 orgEmail └ avatar String 1 avatar └ jobnumber String 1 jobnumber └ hiredDate Date hiredDate └ extattr String 1 extattr

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/user/listbypage");
OapiUserListbypageRequest req = new OapiUserListbypageRequest();
req.setLang("1");
req.setDepartmentId(1L);
req.setOffset(1L);
req.setSize(1L);
req.setOrder("1");
req.setHttpMethod("GET");
OapiUserListbypageResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/user/listbypage");
OapiUserListbypageRequest req = new OapiUserListbypageRequest();
req.Lang = "1";
req.DepartmentId = 1L;
req.Offset = 1L;
req.Size = 1L;
req.Order = "1";
req.SetHttpMethod("GET");
OapiUserListbypageResponse 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_GET , DingTalkConstant::$FORMAT_JSON);
$req = new OapiUserListbypageRequest;
$req->setLang("1");
$req->setDepartmentId("1");
$req->setOffset("1");
$req->setSize("1");
$req->setOrder("1");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/user/listbypage");

curl -X GET "https://oapi.dingtalk.com/user/listbypage" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=e599e3aa-1c36-4bdb-8fe3-d7601ae19185' \
-d 'department_id=1' \
-d 'lang=1' \
-d 'offset=1' \
-d 'order=1' \
-d 'size=1'

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

req=dingtalk.api.OapiUserListbypageRequest("https://oapi.dingtalk.com/user/listbypage")

req.lang="1"
req.department_id=1
req.offset=1
req.size=1
req.order="1"
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.user.listbypage");
add_param(pRequest,"lang","1");
add_param(pRequest,"department_id","1");
add_param(pRequest,"offset","1");
add_param(pRequest,"size","1");
add_param(pRequest,"order","1");
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.user.listbypage', {
	'lang':'1',
	'department_id':'1',
	'offset':'1',
	'size':'1',
	'order':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"ok",
    "hasMore":false,
    "userlist":[
        {
                "userid":"1",
                "order":1,
                "dingId":"1",
                "unionid":"1",
                "mobile":"1",
                "tel":"1",
                "workPlace":"1",
                "remark":"1",
                "isAdmin":false,
                "isBoss":false,
                "isHide":false,
                "isLeader":false,
                "name":"1",
                "active":false,
                "department":{
                    "number":[
                        1
                    ]
                },
                "position":"1",
                "email":"1",
                "orgEmail":"1",
                "avatar":"1",
                "jobnumber":"1",
                "hiredDate":"",
                "extattr":"1"
        }
    ]
}

异常示例

JSON示例

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.user.listbypage (获取部门成员(详情))

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ