淘宝开放平台

请求地址：

环境	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
inbox_id	Number	可选	462		收件箱id

名称	类型	示例值	描述
result	ResultModel		结果
└ response_success Boolean true 是否成功 model SyInboxDetailResponse 结果 ent_resources SySignatureResourceResponse [] 企业资料列表 └ resource_id Number 1 资料id └ resource_type_code String 21015 资料类型code └ resource_type_desc String 资料资料类型 └ signature_oss_key_url String 资料URL 资料URL └ page Number 1 资料页数 └ approve_status Number 1 资料查收状态，0不通过1通过 └ expire_date String 2025-11-11 资料过期时间 └ resource_name String xxx 资料名称 inbox_detail SyInboxModel 收件箱基本信息 └ id Number 1 收件箱id └ gmt_create Date 2025-06-23 20:26:50 创建时间 └ gmt_modified Date 2025-06-23 20:26:50 更新时间 └ ref_ent_id String cb14553ed7654ff586b87b637ba23e2c 本企业refEntId └ send_ref_ent_id String cb14553ed7654ff586b87b637ba23e2c 发送企业RefEntId └ send_ent_id String cb14553ed7654ff586b87b637ba23e2c 发送企业EntId └ send_ent_name String xxx 发送企业名称 └ send_person String xx 发件人 └ send_person_id String xx 发件人id └ type Number 0 资料类型，0企业资料1产品资料 └ send_time Date 2025-06-23 20:26:50 发送时间 └ exchange_status Number 302 301发送方已撤回,302接收方待查收,303接收方审批中,304接收方全部查收,305接收方部分查收,306接收方全部拒收 └ exchange_status_desc String 接收方待查收状态描述 └ total_resource_count Number 10 资料数 └ receive_resource_count Number 5 通过的资料数 └ reject_resource_count Number 5 拒收的资料数 └ note String xx 留言 └ withdraw_person String xx 撤回人 └ withdraw_person_id String xxx 撤回人id └ withdraw_time Date 2025-06-23 20:26:50 撤回时间 └ check_status Number 0 查收状态 0拒收，1全部查收，2部分查收 └ check_status_desc String 拒收查收状态 └ request_id Number 111 索取id products SySignatureProductResponse [] 产品列表 └ product_id Number 1 产品id └ product_name String 产品名称产品名称 └ product_type_desc String 药品、器械、其他产品分类 └ approval_or_register_no String xxx 批准文号/注册证号 └ supply_ent_name String xxx 供应商 └ resource_count Number 10 资料数 product_resources SySignatureResourceResponse [] 产品资料列表 └ resource_id Number 1 资料id └ resource_type_code String 21015 资料类型code └ resource_type_desc String 资料类型资料类型 └ signature_oss_key_url String 资料URL 资料URL └ page Number 1 资料页数 └ approve_status Number 1 资料查收状态，0不通过1通过 └ expire_date String 2025-11-11 资料过期时间 └ resource_name String xxx 资料名称 product_detail SyProductMapperDTO 产品详情 └ product_name String xxx 产品名称 └ product_name_en String abc 产品英文名 └ approval_no String xxx 批准文号 └ approval_date Date 2025-01-01 00:00:00 批准日期 └ approval_end_date Date 2025-01-01 00:00:00 批准有效期截止日期 └ drug_product_name String xxx 商品名称(一般指药品的商品名称) └ prepn_type_desc String 剂型剂型 └ prepn_spec String 制剂规格制剂规格 └ pkg_spec String 16片/盒包装规格 └ spec String 规格规格 └ drug_type_code Number 1 药品类别，0中药、1中药饮片、2化学药、3生物制剂、4辅料 └ drug_type_desc String 中药饮片药品类别 └ source Number 0 0国产、1进口 └ product_type_code Number 0 产品类型，0药品、1器械、2其他 └ product_type_desc String 药品产品类型 └ produce_ent_name String 生产企业名称生产企业名称 └ mah String 上市许可持有人上市许可持有人 └ produce_address String 生产企业地址生产企业地址 └ supply_ent_name String 供应商企业名称供应商企业名称 └ supply_ref_ent_id String 供应商企业id 供应商企业id └ sdc_code String 药品本位码药品本位码 └ sdc_code_note String 药品本位码备注药品本位码备注 └ product_no String 产品编码产品编码 └ supply_product_no String 供应商产品编码供应商产品编码 └ approval_no_old String 原批准文号/ 注册证号原批准文号/ 注册证号 └ execute_standard String 执行标准执行标准 └ pkg_approval_no String 分包装批准文号分包装批准文号 └ pkg_approval_date Date 2025-10-10 00:00:00 分包装批准文号批准日期 └ pkg_approval_expire_date Date 2025-10-10 00:00:00 分包装批准文号有效期至 └ pkg_ent_name String 分包装企业名称分包装企业名称 └ pkg_ent_address String 分包装企业地址分包装企业地址 └ register_no String 器械注册证号器械注册证号 └ md_register_date Date 2025-10-10 00:00:00 器械注册日期 └ md_register_end_date Date 2025-10-10 00:00:00 器械注册有效期截止日期 └ md_manage_type_code Number 1 器械管理类别, 1第一类2第二类3第三类，器械必传 └ md_manage_type_desc String 第一类器械管理类别 └ md_classify_no String 器械分类编码器械分类编码 └ md_component String 器械结构以及组成成分器械结构以及组成成分 └ md_apply_scope String 器械适用范围器械适用范围 └ md_product_desc String 器械产品描述器械产品描述 └ agent_ent_name String 代理人名称代理人名称 └ agent_ent_address String 代理人地址代理人地址 └ other_type_code Number 1 其他产品小类别，1食品、2化妆品、3消毒产品、4其他 agent_persons SySignatureAgentPersonResponse [] 委托人列表 └ agent_person_id Number 1 委托人id └ username String 张三委托人姓名 └ user_no String 1 委托人编号 └ tel String 188xxxx 电话 └ resource_count Number 10 资料数 agent_person_resources SySignatureResourceResponse [] 委托人资料列表 └ resource_id Number 1 资料id └ resource_type_code String 21015 资料类型code └ resource_type_desc String 资料类型资料类型 └ signature_oss_key_url String 资料URL 资料URL └ page Number 1 资料页数 └ approve_status Number 0 资料查收状态，0不通过1通过 └ expire_date String 2025-11-11 资料过期时间 └ resource_name String xxx 资料名称 agent_detail SyAgentPersonDTO 委托人详情 └ username String 张三委托人姓名 └ user_no String 1 委托人编号 └ tel String 188xxxx 电话 └ identity_no String 110xxx 身份证号 └ identity_expire_date Date 2029-10-01 00:00:00 身份证号有效期至 └ auth_area String 授权地区授权地区 └ auth_product String 授权品种授权品种 └ msg_info String xx 返回值 └ msg_code String xx 返回码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthSynergySyInboxDetailRequest req = new AlibabaAlihealthSynergySyInboxDetailRequest();
req.setRefEntId("cb14553ed7654ff586b87b637ba23e2c");
req.setInboxId(462L);
AlibabaAlihealthSynergySyInboxDetailResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthSynergySyInboxDetailRequest req = new AlibabaAlihealthSynergySyInboxDetailRequest();
req.RefEntId = "cb14553ed7654ff586b87b637ba23e2c";
req.InboxId = 462L;
AlibabaAlihealthSynergySyInboxDetailResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthSynergySyInboxDetailRequest;
$req->setRefEntId("cb14553ed7654ff586b87b637ba23e2c");
$req->setInboxId("462");
$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.inbox.detail' \
-d 'partner_id=apidoc' \
-d 'sign=D9624F5B11C0246A55885E020BA27CEC' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-12-12+05%3A19%3A16' \
-d 'v=2.0' \
-d 'inbox_id=462' \
-d 'ref_ent_id=cb14553ed7654ff586b87b637ba23e2c'

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

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

req.ref_ent_id="cb14553ed7654ff586b87b637ba23e2c"
req.inbox_id=462
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.inbox.detail");
add_param(pRequest,"ref_ent_id","cb14553ed7654ff586b87b637ba23e2c");
add_param(pRequest,"inbox_id","462");
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.inbox.detail', {
	'ref_ent_id':'cb14553ed7654ff586b87b637ba23e2c',
	'inbox_id':'462'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_synergy_sy_inbox_detail_response>
    <result>
        <response_success>true</response_success>
        <model>
            <ent_resources>
                <sy_signature_resource_response>
                    <resource_id>1</resource_id>
                    <resource_type_code>21015</resource_type_code>
                    <resource_type_desc>资料</resource_type_desc>
                    <signature_oss_key_url>资料URL</signature_oss_key_url>
                    <page>1</page>
                    <approve_status>1</approve_status>
                    <expire_date>2025-11-11</expire_date>
                    <resource_name>xxx</resource_name>
                </sy_signature_resource_response>
            </ent_resources>
            <inbox_detail>
                <id>1</id>
                <gmt_create>2025-06-23 20:26:50</gmt_create>
                <gmt_modified>2025-06-23 20:26:50</gmt_modified>
                <ref_ent_id>cb14553ed7654ff586b87b637ba23e2c</ref_ent_id>
                <send_ref_ent_id>cb14553ed7654ff586b87b637ba23e2c</send_ref_ent_id>
                <send_ent_id>cb14553ed7654ff586b87b637ba23e2c</send_ent_id>
                <send_ent_name>xxx</send_ent_name>
                <send_person>xx</send_person>
                <send_person_id>xx</send_person_id>
                <type>0</type>
                <send_time>2025-06-23 20:26:50</send_time>
                <exchange_status>302</exchange_status>
                <exchange_status_desc>接收方待查收</exchange_status_desc>
                <total_resource_count>10</total_resource_count>
                <receive_resource_count>5</receive_resource_count>
                <reject_resource_count>5</reject_resource_count>
                <note>xx</note>
                <withdraw_person>xx</withdraw_person>
                <withdraw_person_id>xxx</withdraw_person_id>
                <withdraw_time>2025-06-23 20:26:50</withdraw_time>
                <check_status>0</check_status>
                <check_status_desc>拒收</check_status_desc>
                <request_id>111</request_id>
            </inbox_detail>
            <products>
                <sy_signature_product_response>
                    <product_id>1</product_id>
                    <product_name>产品名称</product_name>
                    <product_type_desc>药品、器械、其他</product_type_desc>
                    <approval_or_register_no>xxx</approval_or_register_no>
                    <supply_ent_name>xxx</supply_ent_name>
                    <resource_count>10</resource_count>
                    <product_resources>
                        <sy_signature_resource_response>
                            <resource_id>1</resource_id>
                            <resource_type_code>21015</resource_type_code>
                            <resource_type_desc>资料类型</resource_type_desc>
                            <signature_oss_key_url>资料URL</signature_oss_key_url>
                            <page>1</page>
                            <approve_status>1</approve_status>
                            <expire_date>2025-11-11</expire_date>
                            <resource_name>xxx</resource_name>
                        </sy_signature_resource_response>
                    </product_resources>
                    <product_detail>
                        <product_name>xxx</product_name>
                        <product_name_en>abc</product_name_en>
                        <approval_no>xxx</approval_no>
                        <approval_date>2025-01-01 00:00:00</approval_date>
                        <approval_end_date>2025-01-01 00:00:00</approval_end_date>
                        <drug_product_name>xxx</drug_product_name>
                        <prepn_type_desc>剂型</prepn_type_desc>
                        <prepn_spec>制剂规格</prepn_spec>
                        <pkg_spec>16片/盒</pkg_spec>
                        <spec>规格</spec>
                        <drug_type_code>1</drug_type_code>
                        <drug_type_desc>中药饮片</drug_type_desc>
                        <source>0</source>
                        <product_type_code>0</product_type_code>
                        <product_type_desc>药品</product_type_desc>
                        <produce_ent_name>生产企业名称</produce_ent_name>
                        <mah>上市许可持有人</mah>
                        <produce_address>生产企业地址</produce_address>
                        <supply_ent_name>供应商企业名称</supply_ent_name>
                        <supply_ref_ent_id>供应商企业id</supply_ref_ent_id>
                        <sdc_code>药品本位码</sdc_code>
                        <sdc_code_note>药品本位码备注</sdc_code_note>
                        <product_no>产品编码</product_no>
                        <supply_product_no>供应商产品编码</supply_product_no>
                        <approval_no_old>原批准文号/ 注册证号</approval_no_old>
                        <execute_standard>执行标准</execute_standard>
                        <pkg_approval_no>分包装批准文号</pkg_approval_no>
                        <pkg_approval_date>2025-10-10 00:00:00</pkg_approval_date>
                        <pkg_approval_expire_date>2025-10-10 00:00:00</pkg_approval_expire_date>
                        <pkg_ent_name>分包装企业名称</pkg_ent_name>
                        <pkg_ent_address>分包装企业地址</pkg_ent_address>
                        <register_no>器械注册证号</register_no>
                        <md_register_date>2025-10-10 00:00:00</md_register_date>
                        <md_register_end_date>2025-10-10 00:00:00</md_register_end_date>
                        <md_manage_type_code>1</md_manage_type_code>
                        <md_manage_type_desc>第一类</md_manage_type_desc>
                        <md_classify_no>器械分类编码</md_classify_no>
                        <md_component>器械结构以及组成成分</md_component>
                        <md_apply_scope>器械适用范围</md_apply_scope>
                        <md_product_desc>器械产品描述</md_product_desc>
                        <agent_ent_name>代理人名称</agent_ent_name>
                        <agent_ent_address>代理人地址</agent_ent_address>
                        <other_type_code>1</other_type_code>
                    </product_detail>
                </sy_signature_product_response>
            </products>
            <agent_persons>
                <sy_signature_agent_person_response>
                    <agent_person_id>1</agent_person_id>
                    <username>张三</username>
                    <user_no>1</user_no>
                    <tel>188xxxx</tel>
                    <resource_count>10</resource_count>
                    <agent_person_resources>
                        <sy_signature_resource_response>
                            <resource_id>1</resource_id>
                            <resource_type_code>21015</resource_type_code>
                            <resource_type_desc>资料类型</resource_type_desc>
                            <signature_oss_key_url>资料URL</signature_oss_key_url>
                            <page>1</page>
                            <approve_status>0</approve_status>
                            <expire_date>2025-11-11</expire_date>
                            <resource_name>xxx</resource_name>
                        </sy_signature_resource_response>
                    </agent_person_resources>
                    <agent_detail>
                        <username>张三</username>
                        <user_no>1</user_no>
                        <tel>188xxxx</tel>
                        <identity_no>110xxx</identity_no>
                        <identity_expire_date>2029-10-01 00:00:00</identity_expire_date>
                        <auth_area>授权地区</auth_area>
                        <auth_product>授权品种</auth_product>
                    </agent_detail>
                </sy_signature_agent_person_response>
            </agent_persons>
        </model>
        <msg_info>xx</msg_info>
        <msg_code>xx</msg_code>
    </result>
</alibaba_alihealth_synergy_sy_inbox_detail_response>

{
    "alibaba_alihealth_synergy_sy_inbox_detail_response":{
        "result":{
            "response_success":true,
            "model":{
                "ent_resources":{
                    "sy_signature_resource_response":[
                        {
                            "resource_id":1,
                            "resource_type_code":"21015",
                            "resource_type_desc":"资料",
                            "signature_oss_key_url":"资料URL",
                            "page":1,
                            "approve_status":1,
                            "expire_date":"2025-11-11",
                            "resource_name":"xxx"
                        }
                    ]
                },
                "inbox_detail":{
                    "id":1,
                    "gmt_create":"2025-06-23 20:26:50",
                    "gmt_modified":"2025-06-23 20:26:50",
                    "ref_ent_id":"cb14553ed7654ff586b87b637ba23e2c",
                    "send_ref_ent_id":"cb14553ed7654ff586b87b637ba23e2c",
                    "send_ent_id":"cb14553ed7654ff586b87b637ba23e2c",
                    "send_ent_name":"xxx ",
                    "send_person":"xx ",
                    "send_person_id":"xx",
                    "type":0,
                    "send_time":"2025-06-23 20:26:50",
                    "exchange_status":302,
                    "exchange_status_desc":"接收方待查收",
                    "total_resource_count":10,
                    "receive_resource_count":5,
                    "reject_resource_count":5,
                    "note":"xx",
                    "withdraw_person":"xx",
                    "withdraw_person_id":"xxx",
                    "withdraw_time":"2025-06-23 20:26:50",
                    "check_status":0,
                    "check_status_desc":"拒收",
                    "request_id":111
                },
                "products":{
                    "sy_signature_product_response":[
                        {
                            "product_id":1,
                            "product_name":"产品名称",
                            "product_type_desc":"药品、器械、其他",
                            "approval_or_register_no":"xxx",
                            "supply_ent_name":"xxx ",
                            "resource_count":10,
                            "product_resources":{
                                "sy_signature_resource_response":[
                                    {
                                        "resource_id":1,
                                        "resource_type_code":"\t 21015  ",
                                        "resource_type_desc":"资料类型",
                                        "signature_oss_key_url":"资料URL",
                                        "page":1,
                                        "approve_status":1,
                                        "expire_date":"2025-11-11",
                                        "resource_name":"xxx"
                                    }
                                ]
                            },
                            "product_detail":{
                                "product_name":"xxx",
                                "product_name_en":"abc",
                                "approval_no":"xxx",
                                "approval_date":"2025-01-01 00:00:00",
                                "approval_end_date":"2025-01-01 00:00:00",
                                "drug_product_name":"xxx",
                                "prepn_type_desc":"剂型",
                                "prepn_spec":"制剂规格",
                                "pkg_spec":"16片\/盒",
                                "spec":"规格",
                                "drug_type_code":1,
                                "drug_type_desc":"中药饮片",
                                "source":0,
                                "product_type_code":0,
                                "product_type_desc":"药品",
                                "produce_ent_name":"生产企业名称",
                                "mah":"上市许可持有人",
                                "produce_address":"生产企业地址",
                                "supply_ent_name":"供应商企业名称",
                                "supply_ref_ent_id":"供应商企业id",
                                "sdc_code":"药品本位码",
                                "sdc_code_note":"药品本位码备注",
                                "product_no":"产品编码",
                                "supply_product_no":"供应商产品编码",
                                "approval_no_old":"原批准文号\/ 注册证号",
                                "execute_standard":"执行标准",
                                "pkg_approval_no":"分包装批准文号",
                                "pkg_approval_date":"2025-10-10 00:00:00",
                                "pkg_approval_expire_date":"2025-10-10 00:00:00",
                                "pkg_ent_name":"分包装企业名称",
                                "pkg_ent_address":"分包装企业地址",
                                "register_no":"器械注册证号",
                                "md_register_date":"2025-10-10 00:00:00",
                                "md_register_end_date":"2025-10-10 00:00:00",
                                "md_manage_type_code":1,
                                "md_manage_type_desc":"第一类",
                                "md_classify_no":"器械分类编码",
                                "md_component":"器械结构以及组成成分",
                                "md_apply_scope":"器械适用范围",
                                "md_product_desc":"器械产品描述",
                                "agent_ent_name":"代理人名称",
                                "agent_ent_address":"代理人地址",
                                "other_type_code":1
                            }
                        }
                    ]
                },
                "agent_persons":{
                    "sy_signature_agent_person_response":[
                        {
                            "agent_person_id":1,
                            "username":"张三",
                            "user_no":"1",
                            "tel":"188xxxx",
                            "resource_count":10,
                            "agent_person_resources":{
                                "sy_signature_resource_response":[
                                    {
                                        "resource_id":1,
                                        "resource_type_code":"21015",
                                        "resource_type_desc":"资料类型",
                                        "signature_oss_key_url":"资料URL",
                                        "page":1,
                                        "approve_status":0,
                                        "expire_date":"2025-11-11",
                                        "resource_name":"xxx"
                                    }
                                ]
                            },
                            "agent_detail":{
                                "username":"张三",
                                "user_no":"1",
                                "tel":"188xxxx",
                                "identity_no":"110xxx",
                                "identity_expire_date":"2029-10-01 00:00:00",
                                "auth_area":"授权地区",
                                "auth_product":"授权品种"
                            }
                        }
                    ]
                }
            },
            "msg_info":"xx",
            "msg_code":"xx"
        }
    }
}

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.inbox.detail (电子首营-收件箱详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ