淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
dept_id	Number	必须	1		部门id
except_user_id_list	Number []	可选	[2,3]	最大列表长度：999	排除用户id列表
org_code	String	可选	ding123abc		组织编码
tenant_id	Number	可选	12		租户id
page_size	Number	可选	20	默认值：20	页面容量，默认20
page_num	Number	可选	1	默认值：1	页码，从1开始，默认1

名称	类型	示例值	描述
data	Data	data	返回结果
└ total Number 6 结果总数 └ user_id_list Number [] data 用户id列表 └ page_size Number 20 页面容量，默认20 └ page_num Number 1 页码，从1开始
has_error	Boolean	false	请求是否失败
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);
AlibabaDcUcInnerUserIdsByDepPageRequest req = new AlibabaDcUcInnerUserIdsByDepPageRequest();
req.setDeptId(1L);
req.setExceptUserIdList("2,3");
req.setOrgCode("ding123abc");
req.setTenantId(12L);
req.setPageSize(20L);
req.setPageNum(1L);
AlibabaDcUcInnerUserIdsByDepPageResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDcUcInnerUserIdsByDepPageRequest req = new AlibabaDcUcInnerUserIdsByDepPageRequest();
req.DeptId = 1L;
req.ExceptUserIdList = "2,3";
req.OrgCode = "ding123abc";
req.TenantId = 12L;
req.PageSize = 20L;
req.PageNum = 1L;
AlibabaDcUcInnerUserIdsByDepPageResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDcUcInnerUserIdsByDepPageRequest;
$req->setDeptId("1");
$req->setExceptUserIdList("[2,3]");
$req->setOrgCode("ding123abc");
$req->setTenantId("12");
$req->setPageSize("20");
$req->setPageNum("1");
$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.ids.by.dep.page' \
-d 'partner_id=apidoc' \
-d 'sign=1160221CCC0C206DD78C5AD524452752' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+16%3A55%3A31' \
-d 'v=2.0' \
-d 'dept_id=1' \
-d 'except_user_id_list=2%2C3' \
-d 'org_code=ding123abc' \
-d 'page_num=1' \
-d 'page_size=20' \
-d 'tenant_id=12'

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

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

req.dept_id=1
req.except_user_id_list="[2,3]"
req.org_code="ding123abc"
req.tenant_id=12
req.page_size=20
req.page_num=1
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.ids.by.dep.page");
add_param(pRequest,"dept_id","1");
add_param(pRequest,"except_user_id_list","2,3");
add_param(pRequest,"org_code","ding123abc");
add_param(pRequest,"tenant_id","12");
add_param(pRequest,"page_size","20");
add_param(pRequest,"page_num","1");
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.ids.by.dep.page', {
	'dept_id':'1',
	'except_user_id_list':'2,3',
	'org_code':'ding123abc',
	'tenant_id':'12',
	'page_size':'20',
	'page_num':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_dc_uc_inner_user_ids_by_dep_page_response>
    <data>
        <total>6</total>
        <user_id_list>
            <number>data</number>
        </user_id_list>
        <page_size>20</page_size>
        <page_num>1</page_num>
    </data>
    <has_error>false</has_error>
    <msg_info>demo</msg_info>
    <msg_code>demo</msg_code>
</alibaba_dc_uc_inner_user_ids_by_dep_page_response>

{
    "alibaba_dc_uc_inner_user_ids_by_dep_page_response":{
        "data":{
            "total":6,
            "user_id_list":{
                "number":[
                    data
                ]
            },
            "page_size":20,
            "page_num":1
        },
        "has_error":false,
        "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.ids.by.dep.page (分页查询部门下用户id列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ