淘宝开放平台 - 文档中心

请求地址：

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

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
req	PageUserIdByDeptIdReq	必须			入参
└ page_num Number 可选 1 页码，默认1 └ org_code String 可选 ding123abc 组织编码 └ tenant_id Number 可选 1 租户id └ dept_id Number 必须 1 部门id └ page_size Number 可选 20 页面容量，默认20 └ except_user_id_list Number [] 可选 [1,2,3] 排除用户id列表

名称	类型	示例值	描述
result	Result	result	接口返回model
└ code String demo code page Page page 分页对象 user_list User [] [] 用户列表 └ dept_id_list Number [] [1,2,3] 用户所属部门id列表 └ account_name String 张三账号名称 └ type String C 用户类型 └ extra String {} 扩展信息 └ id Number 1 用户id └ corp_id String ding123abc 组织编码 └ nick_name String 张三昵称 └ full_name String 张三全称 └ avatar String https://static-legacy.dingtalk.com/media/lADPD26eLU924Z_NAbDNAbA_432_432.jpg 头像URL └ account_id String 01024 账号id └ namespace String dd 命名空间，dd钉钉 └ tenant_id Number 1 租户id └ status String CREATED 用户状态 └ page_size Number 20 页面容量，默认20 └ page_num Number 1 页码，默认1 └ success Boolean true 是否成功 └ has_error Boolean false 是否请求失败 └ message String demo message └ msg_info String demo msgInfo └ msg_code String demo msgCode

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDcUcInnerUserListByDeptPageRequest req = new AlibabaDcUcInnerUserListByDeptPageRequest();
AlibabaDcUcInnerUserListByDeptPageRequest.PageUserIdByDeptIdReq obj1 = new AlibabaDcUcInnerUserListByDeptPageRequest.PageUserIdByDeptIdReq();
obj1.setPageNum(1L);
obj1.setOrgCode("ding123abc");
obj1.setTenantId(1L);
obj1.setDeptId(1L);
obj1.setPageSize(20L);
obj1.setExceptUserIdList(new Long[] { 1,2,3 };
);
req.setReq(obj1);
AlibabaDcUcInnerUserListByDeptPageResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDcUcInnerUserListByDeptPageRequest req = new AlibabaDcUcInnerUserListByDeptPageRequest();
AlibabaDcUcInnerUserListByDeptPageRequest.PageUserIdByDeptIdReqDomain obj1 = new AlibabaDcUcInnerUserListByDeptPageRequest.PageUserIdByDeptIdReqDomain();
obj1.PageNum = 1L;
obj1.OrgCode = "ding123abc";
obj1.TenantId = 1L;
obj1.DeptId = 1L;
obj1.PageSize = 20L;
obj1.ExceptUserIdList = new long[] { 1,2,3 };
;
req.Req_ = obj1;
AlibabaDcUcInnerUserListByDeptPageResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDcUcInnerUserListByDeptPageRequest;
$req = new PageUserIdByDeptIdReq;
$req->page_num="1";
$req->org_code="ding123abc";
$req->tenant_id="1";
$req->dept_id="1";
$req->page_size="20";
$req->except_user_id_list="[1,2,3]";
$req->setReq(json_encode($req));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.dc.uc.inner.user.list.by.dept.page' \
-d 'partner_id=apidoc' \
-d 'sign=02F225ABAC8955FBD36DED7F507D1357' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+17%3A13%3A15' \
-d 'v=2.0' \
-d 'req=null'

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

req=top.api.AlibabaDcUcInnerUserListByDeptPageRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.req=""
try:
	resp= req.getResponse()
	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,"alibaba.dc.uc.inner.user.list.by.dept.page");
add_param(pRequest,"req","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
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('alibaba.dc.uc.inner.user.list.by.dept.page', {
	'req':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_dc_uc_inner_user_list_by_dept_page_response>
    <result>
        <code>demo</code>
        <page>
            <user_list>
                <user>
                    <dept_id_list>
                        <number>[1</number>
                        <number>2</number>
                        <number>3]</number>
                    </dept_id_list>
                    <account_name>张三</account_name>
                    <type>C</type>
                    <extra>{}</extra>
                    <id>1</id>
                    <corp_id>ding123abc</corp_id>
                    <nick_name>张三</nick_name>
                    <full_name>张三</full_name>
                    <avatar>https://static-legacy.dingtalk.com/media/lADPD26eLU924Z_NAbDNAbA_432_432.jpg</avatar>
                    <account_id>01024</account_id>
                    <namespace>dd</namespace>
                    <tenant_id>1</tenant_id>
                    <status>CREATED</status>
                </user>
            </user_list>
            <page_size>20</page_size>
            <page_num>1</page_num>
        </page>
        <success>true</success>
        <has_error>false</has_error>
        <message>demo</message>
        <msg_info>demo</msg_info>
        <msg_code>demo</msg_code>
    </result>
</alibaba_dc_uc_inner_user_list_by_dept_page_response>

{
    "alibaba_dc_uc_inner_user_list_by_dept_page_response":{
        "result":{
            "code":"demo",
            "page":{
                "user_list":{
                    "user":[
                        {
                            "dept_id_list":{
                                "number":[
                                    [1,
                                    2,
                                    3]
                                ]
                            },
                            "account_name":"张三",
                            "type":"C",
                            "extra":"{}",
                            "id":1,
                            "corp_id":"ding123abc",
                            "nick_name":"张三",
                            "full_name":"张三",
                            "avatar":"https:\/\/static-legacy.dingtalk.com\/media\/lADPD26eLU924Z_NAbDNAbA_432_432.jpg",
                            "account_id":"01024",
                            "namespace":"dd",
                            "tenant_id":1,
                            "status":"CREATED"
                        }
                    ]
                },
                "page_size":20,
                "page_num":1
            },
            "success":true,
            "has_error":false,
            "message":"demo",
            "msg_info":"demo",
            "msg_code":"demo"
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

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

错误码	错误描述	解决方案

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

开放平台

用户API

alibaba.dc.uc.inner.user.list.by.dept.page (分页查询部门下用户信息列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ