淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
ref_ent_id	String	必须	cb14553ed7654ff586b87b637ba23e2c		refEntId
username	String	可选	张三		委托人姓名
user_no	String	可选	D23		委托人编号
expire_status	String	可选	1		过期状态:0未过期1已过期
archive_status	String	可选	1		归档状态:0未归档1已归档
page	Number	必须	1	默认值：1	页码
page_size	Number	必须	10	默认值：10	页的大小

名称	类型	示例值	描述
result	ResultModel		返回结果
└ response_success Boolean true 是否响应成功 model Page 1 返回对象 └ total_num Number 10000 数据总数 └ page Number 1 页码 └ page_size Number 50 页的大小 result_list SyAgentPersonDTO [] 结果列表 └ username String 张三委托人姓名 └ user_no String D23 委托人编号 └ identity_no String 1234567 身份证号 └ identity_expire_date_str String 2099-01-01 身份证有效期至 └ tel String 1234567 联系电话 └ auth_area String 河南授权地区 └ auth_product String 向日葵授权品种 └ expire_status String 1 过期状态:0未过期1已过期 └ archive_status String 1 归档状态:0未归档1已归档 └ msg_code String SUCCESS 状态码 └ msg_info String 调用成功状态值

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthSynergySyAgentpersonQueryRequest req = new AlibabaAlihealthSynergySyAgentpersonQueryRequest();
req.setRefEntId("cb14553ed7654ff586b87b637ba23e2c");
req.setUsername("张三");
req.setUserNo("D23");
req.setExpireStatus("1");
req.setArchiveStatus("1");
req.setPage(1L);
req.setPageSize(10L);
AlibabaAlihealthSynergySyAgentpersonQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthSynergySyAgentpersonQueryRequest req = new AlibabaAlihealthSynergySyAgentpersonQueryRequest();
req.RefEntId = "cb14553ed7654ff586b87b637ba23e2c";
req.Username = "张三";
req.UserNo = "D23";
req.ExpireStatus = "1";
req.ArchiveStatus = "1";
req.Page = 1L;
req.PageSize = 10L;
AlibabaAlihealthSynergySyAgentpersonQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthSynergySyAgentpersonQueryRequest;
$req->setRefEntId("cb14553ed7654ff586b87b637ba23e2c");
$req->setUsername("张三");
$req->setUserNo("D23");
$req->setExpireStatus("1");
$req->setArchiveStatus("1");
$req->setPage("1");
$req->setPageSize("10");
$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.alihealth.synergy.sy.agentperson.query' \
-d 'partner_id=apidoc' \
-d 'sign=B6E741DE9038FDE327E3A3896D23BE47' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-01+07%3A10%3A13' \
-d 'v=2.0' \
-d 'archive_status=1' \
-d 'expire_status=1' \
-d 'page=1' \
-d 'page_size=10' \
-d 'ref_ent_id=cb14553ed7654ff586b87b637ba23e2c' \
-d 'user_no=D23' \
-d 'username=%E5%BC%A0%E4%B8%89'

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

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

req.ref_ent_id="cb14553ed7654ff586b87b637ba23e2c"
req.username="张三"
req.user_no="D23"
req.expire_status="1"
req.archive_status="1"
req.page=1
req.page_size=10
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.alihealth.synergy.sy.agentperson.query");
add_param(pRequest,"ref_ent_id","cb14553ed7654ff586b87b637ba23e2c");
add_param(pRequest,"username","张三");
add_param(pRequest,"user_no","D23");
add_param(pRequest,"expire_status","1");
add_param(pRequest,"archive_status","1");
add_param(pRequest,"page","1");
add_param(pRequest,"page_size","10");
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.alihealth.synergy.sy.agentperson.query', {
	'ref_ent_id':'cb14553ed7654ff586b87b637ba23e2c',
	'username':'张三',
	'user_no':'D23',
	'expire_status':'1',
	'archive_status':'1',
	'page':'1',
	'page_size':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_synergy_sy_agentperson_query_response>
    <result>
        <response_success>true</response_success>
        <model>
            <total_num>10000</total_num>
            <page>1</page>
            <page_size>50</page_size>
            <result_list>
                <sy_agent_person_d_t_o>
                    <username>张三</username>
                    <user_no>D23</user_no>
                    <identity_no>1234567</identity_no>
                    <identity_expire_date_str>2099-01-01</identity_expire_date_str>
                    <tel>1234567</tel>
                    <auth_area>河南</auth_area>
                    <auth_product>向日葵</auth_product>
                    <expire_status>1</expire_status>
                    <archive_status>1</archive_status>
                </sy_agent_person_d_t_o>
            </result_list>
        </model>
        <msg_code>SUCCESS</msg_code>
        <msg_info>调用成功</msg_info>
    </result>
</alibaba_alihealth_synergy_sy_agentperson_query_response>

{
    "alibaba_alihealth_synergy_sy_agentperson_query_response":{
        "result":{
            "response_success":true,
            "model":{
                "total_num":10000,
                "page":1,
                "page_size":50,
                "result_list":{
                    "sy_agent_person_d_t_o":[
                        {
                            "username":"张三",
                            "user_no":"D23",
                            "identity_no":"1234567",
                            "identity_expire_date_str":"2099-01-01",
                            "tel":"1234567",
                            "auth_area":"河南",
                            "auth_product":"向日葵",
                            "expire_status":"1",
                            "archive_status":"1"
                        }
                    ]
                }
            },
            "msg_code":"SUCCESS",
            "msg_info":"调用成功"
        }
    }
}

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下载

阿里健康追溯码

alibaba.alihealth.synergy.sy.agentperson.query (委托人查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ