淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param_open_employee_query_request	OpenEmployeeQueryRequest	可选			入参对象。
└ page_size Number 可选 10 每页的最大数据记录数量；默认10，该值要求大于0且小于等于1000。 └ page_token String 可选 9YN+jxa7PcxbNUTISeKjEw== 游标分页的游标值，用来标记当前分页的开始位置，第一次请求不填表示从头开始遍历；分页查询还有更多数据项时会同时返回下一页起始游标值page_token，遍历下一页时用该page_token获取查询结果。 └ third_part_corp_id String 必须 test 第三方企业id。 └ third_part_job_no String 可选 001 第三方员工工号。 └ modified_time_greater_or_equal_than String 可选 2021-06-02 00:00:00 员工更新时间大于等于值，该值格式yyyy-MM-dd HH:mm:ss。

名称	类型	示例值	描述
result	BtmsResult	result	结果对象。
module PagingResult module 分页结果对象。 └ has_more Boolean true 是否还有更多数据项。 items OpenEmployeeInfo [] items 员工数组。 └ user_name String 小明员工昵称。 └ third_part_user_id String 123 第三方员工ID。 └ third_part_job_no String 001 第三方员工工号。 └ leave_status Number 1 1:离职 0:在职 └ page_token String 9YN+jxa7PcxbNUTISeKjEw== 游标分页下一页游标page_token值，当has_more为true时，会同时返回新的page_token，否则不返回page_token。 └ total Number 99 本次请求条件下的数据项总量。 └ result_code Number 0 结果码；0：成功，非0：失败。 └ result_msg String success 结果描述。 └ success Boolean true 请求是否成功。

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripBtripEmployeeQueryRequest req = new AlitripBtripEmployeeQueryRequest();
AlitripBtripEmployeeQueryRequest.OpenEmployeeQueryRequest obj1 = new AlitripBtripEmployeeQueryRequest.OpenEmployeeQueryRequest();
obj1.setPageSize(10L);
obj1.setPageToken("9YN+jxa7PcxbNUTISeKjEw==");
obj1.setThirdPartCorpId("test");
obj1.setThirdPartJobNo("001");
obj1.setModifiedTimeGreaterOrEqualThan("2021-06-02 00:00:00");
req.setParamOpenEmployeeQueryRequest(obj1);
AlitripBtripEmployeeQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripBtripEmployeeQueryRequest req = new AlitripBtripEmployeeQueryRequest();
AlitripBtripEmployeeQueryRequest.OpenEmployeeQueryRequestDomain obj1 = new AlitripBtripEmployeeQueryRequest.OpenEmployeeQueryRequestDomain();
obj1.PageSize = 10L;
obj1.PageToken = "9YN+jxa7PcxbNUTISeKjEw==";
obj1.ThirdPartCorpId = "test";
obj1.ThirdPartJobNo = "001";
obj1.ModifiedTimeGreaterOrEqualThan = "2021-06-02 00:00:00";
req.ParamOpenEmployeeQueryRequest_ = obj1;
AlitripBtripEmployeeQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripBtripEmployeeQueryRequest;
$param_open_employee_query_request = new OpenEmployeeQueryRequest;
$param_open_employee_query_request->page_size="10";
$param_open_employee_query_request->page_token="9YN+jxa7PcxbNUTISeKjEw==";
$param_open_employee_query_request->third_part_corp_id="test";
$param_open_employee_query_request->third_part_job_no="001";
$param_open_employee_query_request->modified_time_greater_or_equal_than="2021-06-02 00:00:00";
$req->setParamOpenEmployeeQueryRequest(json_encode($param_open_employee_query_request));
$resp = $c->execute($req, $sessionKey);

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=alitrip.btrip.employee.query' \
-d 'partner_id=apidoc' \
-d 'session=db79cf5e-8ed4-43df-b1bc-fff9b2cd5997' \
-d 'sign=9198A865620EF2446D8C1C2FD2174D02' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-03+07%3A59%3A19' \
-d 'v=2.0' \
-d 'param_open_employee_query_request=null'

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

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

req.param_open_employee_query_request=""
try:
	resp= req.getResponse(sessionkey)
	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,"alitrip.btrip.employee.query");
add_param(pRequest,"param_open_employee_query_request","数据结构JSON示例");
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('alitrip.btrip.employee.query', {
	'param_open_employee_query_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alitrip_btrip_employee_query_response>
    <result>
        <module>
            <has_more>true</has_more>
            <items>
                <open_employee_info>
                    <user_name>小明</user_name>
                    <third_part_user_id>123</third_part_user_id>
                    <third_part_job_no>001</third_part_job_no>
                    <leave_status>1</leave_status>
                </open_employee_info>
            </items>
            <page_token>9YN+jxa7PcxbNUTISeKjEw==</page_token>
            <total>99</total>
        </module>
        <result_code>0</result_code>
        <result_msg>success</result_msg>
        <success>true</success>
    </result>
</alitrip_btrip_employee_query_response>

{
    "alitrip_btrip_employee_query_response":{
        "result":{
            "module":{
                "has_more":true,
                "items":{
                    "open_employee_info":[
                        {
                            "user_name":"小明",
                            "third_part_user_id":"123",
                            "third_part_job_no":"001",
                            "leave_status":1
                        }
                    ]
                },
                "page_token":"9YN+jxa7PcxbNUTISeKjEw==",
                "total":99
            },
            "result_code":0,
            "result_msg":"success",
            "success":true
        }
    }
}

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

alitrip.btrip.employee.query (企业员工查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ