淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
contrator_worker_query	ContratorWorkerQuery	可选			入参
└ worker_id String 可选 1 工人id └ worker_id_number String 可选 1 工人身份证 └ worker_phone String 可选 1 工人手机号 └ page_index Number 可选 1 页号 └ page_size Number 可选 10 页数 └ worker_name String 可选张三工人姓名 └ alipay_account String 可选 1 工人支付宝账号

名称	类型	示例值	描述
data	ContractorWorkerDTO []		返回数据
└ area_center_code String QUANGUO 所属中心code └ worker_name String 张三工人姓名 └ worker_id_number String 11 工人身份证 └ worker_id String 11 工人id └ worker_phone String 11 工人手机号 └ worker_alipay_account String 11 工人支付宝账号
is_success	Boolean	true	是否成功
error_message	Boolean	11	错误信息
total_count	Number	10	总数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaSscYichaoWorkerQueryRequest req = new AlibabaSscYichaoWorkerQueryRequest();
AlibabaSscYichaoWorkerQueryRequest.ContratorWorkerQuery obj1 = new AlibabaSscYichaoWorkerQueryRequest.ContratorWorkerQuery();
obj1.setWorkerId("1");
obj1.setWorkerIdNumber("1");
obj1.setWorkerPhone("1");
obj1.setPageIndex(1L);
obj1.setPageSize(10L);
obj1.setWorkerName("张三");
obj1.setAlipayAccount("1");
req.setContratorWorkerQuery(obj1);
AlibabaSscYichaoWorkerQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaSscYichaoWorkerQueryRequest req = new AlibabaSscYichaoWorkerQueryRequest();
AlibabaSscYichaoWorkerQueryRequest.ContratorWorkerQueryDomain obj1 = new AlibabaSscYichaoWorkerQueryRequest.ContratorWorkerQueryDomain();
obj1.WorkerId = "1";
obj1.WorkerIdNumber = "1";
obj1.WorkerPhone = "1";
obj1.PageIndex = 1L;
obj1.PageSize = 10L;
obj1.WorkerName = "张三";
obj1.AlipayAccount = "1";
req.ContratorWorkerQuery_ = obj1;
AlibabaSscYichaoWorkerQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaSscYichaoWorkerQueryRequest;
$contrator_worker_query = new ContratorWorkerQuery;
$contrator_worker_query->worker_id="1";
$contrator_worker_query->worker_id_number="1";
$contrator_worker_query->worker_phone="1";
$contrator_worker_query->page_index="1";
$contrator_worker_query->page_size="10";
$contrator_worker_query->worker_name="张三";
$contrator_worker_query->alipay_account="1";
$req->setContratorWorkerQuery(json_encode($contrator_worker_query));
$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=alibaba.ssc.yichao.worker.query' \
-d 'partner_id=apidoc' \
-d 'session=2172686d-6889-404f-ad98-1cdd3ea19407' \
-d 'sign=01DACAA8EB78D451FD7E1A8D29B0AF9D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-10+15%3A28%3A39' \
-d 'v=2.0' \
-d 'contrator_worker_query=null'

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

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

req.contrator_worker_query="数据结构示例JSON格式"
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,"alibaba.ssc.yichao.worker.query");
add_param(pRequest,"contrator_worker_query","数据结构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('alibaba.ssc.yichao.worker.query', {
	'contrator_worker_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_ssc_yichao_worker_query_response>
    <data>
        <contractor_worker_d_t_o>
            <area_center_code>QUANGUO</area_center_code>
            <worker_name>张三</worker_name>
            <worker_id_number>11</worker_id_number>
            <worker_id>11</worker_id>
            <worker_phone>11</worker_phone>
            <worker_alipay_account>11</worker_alipay_account>
        </contractor_worker_d_t_o>
    </data>
    <is_success>true</is_success>
    <error_message>11</error_message>
    <total_count>10</total_count>
</alibaba_ssc_yichao_worker_query_response>

{
    "alibaba_ssc_yichao_worker_query_response":{
        "data":{
            "contractor_worker_d_t_o":[
                {
                    "area_center_code":"QUANGUO",
                    "worker_name":"张三",
                    "worker_id_number":"11",
                    "worker_id":"11",
                    "worker_phone":"11",
                    "worker_alipay_account":"11"
                }
            ]
        },
        "is_success":true,
        "error_message":11,
        "total_count":10
    }
}

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.ssc.yichao.worker.query (灵工服务商工人查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ