淘宝开放平台

请求地址：

环境	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
id	Number	必须	1234		合同id

名称	类型	示例值	描述
result	ResultModel		结果
└ msg_code String xx 状态码 └ msg_info String xx 状态值 model SyContractDetail true 结果 sy_contract_model SyContractModel 合同信息 └ gmt_create Date 2025-1-1 创建时间 └ contract_no String xxx 合同编号 └ receive_ref_ent_id String 32000000000012xxxx 接收方企业refEntId └ receive_ent_id String 32000000000012xxxx 接受方企业entid └ receive_ent_name String xx企业接受方企业名称 └ create_person String 张三发起人 └ send_time Date 2025-1-1 收发时间 └ contract_source String 0 合同来源：0己方发起 1 对方发起 └ contract_source_desc String 己方发起合同来源描述 └ total_page Number 1 页数 └ contract_name String xx合同合同名称 └ contract_type Number 1 合同类型：0, "质量保障协议", 1, "销售合同", 2, "采购合同" └ contract_type_desc String 签署合同合同类型描述 └ expire_date String 2024-1-1 到期时间 └ send_ent_name String xx企业发送方企业名称 └ complete_time Date 2020-1-1 签署完成时间 └ contract_status Number 1 合同状态： 0, "暂存", 1, "发起方待选章提交", 2, "发起方审批中", 3, "发起方审批不通过", 4, "发起方待签章发送", 5, "发起方签章失败", 6, "发起方待发送", 7, "接收方待查收", 8, "接收方审批中", 9, "接收方拒签", 10, "接收方待签章", 11, "接收方签章失败", 12, "双方签署成功", 13, "发起方已撤回" └ contract_status_desc String 发起方待选章提交合同状态描述 └ id Number 1 合同id └ send_ref_ent_id String 32000000000012xxxx 发送方企业refEntId └ send_ent_id String 32000000000012xxxx 发送方企业entid sy_contract_resource_model SyContractResourceModel [] 材料信息 └ pdf_oss_key_url String xx pdf在阿里云oss对象存储中的url └ page Number 1 页数 └ id Number xx id └ resource_name String xx pdf名称 receive_seal_infos ResourceSealInfo 接收方签章 └ mode Number xx 数量 seal_info_list SealInfo [] 印章信息列表 └ seal_type String xx 印章类型 └ seal_type_name String xx 印章类型名称 └ seal_name String xx 印章名称 └ seal_desc String xx 印章描述 position_list Position [] 统一位置，优先看自定义位置 └ x String 10 x轴 └ y String 10 y轴 └ page_range String all 盖章页范围 custom_position_list Position [] 自定义位置 └ x String 10 x轴 └ y String 10 y轴 └ page_range String all 盖章页范围 receive_seal_limit ResourceSealInfo 接受方签章 seal_info_list SealInfo [] 签章信息列表 └ seal_type String xx 印章类型 └ seal_type_name String xx 印章类型名称 └ seal_name String xx 印章名称 └ seal_desc String xx 印章描述 custom_position_list Position [] 位置 └ x String xx x轴 └ y String xx y轴 └ page_range String xx 盖章页范围 send_seal_infos ResourceSealInfo 发送方签章信息 └ model Number 1 1 seal_info_list SealInfo [] 发送方签章列表信息 └ seal_type String xx 印章类型 └ seal_type_name String xx 印章类型名称 └ seal_name String xx 印章名称 └ seal_desc String xx 印章描述 position_list Position [] 统一盖章位置，优先看自定义盖章位置 └ x String 10 x └ y String 10 y └ page_range String all 盖章页范围 custom_position_list Position [] 自定义盖章位置 └ x String 10 x └ y String 10 y └ page_range String 1-10,13,15 盖章页范围 └ response_success Boolean true 是否调用成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthSynergySyContractDetailRequest req = new AlibabaAlihealthSynergySyContractDetailRequest();
req.setRefEntId("cb14553ed7654ff586b87b637ba23e2c");
req.setId(1234L);
AlibabaAlihealthSynergySyContractDetailResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthSynergySyContractDetailRequest req = new AlibabaAlihealthSynergySyContractDetailRequest();
req.RefEntId = "cb14553ed7654ff586b87b637ba23e2c";
req.Id = 1234L;
AlibabaAlihealthSynergySyContractDetailResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthSynergySyContractDetailRequest;
$req->setRefEntId("cb14553ed7654ff586b87b637ba23e2c");
$req->setId("1234");
$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.contract.detail' \
-d 'partner_id=apidoc' \
-d 'sign=41E95594C0F73B78E961725CB9EF5076' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-12-11+05%3A56%3A18' \
-d 'v=2.0' \
-d 'id=1234' \
-d 'ref_ent_id=cb14553ed7654ff586b87b637ba23e2c'

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

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

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

XML示例
JSON示例

<alibaba_alihealth_synergy_sy_contract_detail_response>
    <result>
        <msg_code>xx</msg_code>
        <msg_info>xx</msg_info>
        <model>
            <sy_contract_model>
                <gmt_create>2025-1-1</gmt_create>
                <contract_no>xxx</contract_no>
                <receive_ref_ent_id>32000000000012xxxx</receive_ref_ent_id>
                <receive_ent_id>32000000000012xxxx</receive_ent_id>
                <receive_ent_name>xx企业</receive_ent_name>
                <create_person>张三</create_person>
                <send_time>2025-1-1</send_time>
                <contract_source>0</contract_source>
                <contract_source_desc>己方发起</contract_source_desc>
                <total_page>1</total_page>
                <contract_name>xx合同</contract_name>
                <contract_type>1</contract_type>
                <contract_type_desc>签署合同</contract_type_desc>
                <expire_date>2024-1-1</expire_date>
                <send_ent_name>xx企业</send_ent_name>
                <complete_time>2020-1-1</complete_time>
                <contract_status>1</contract_status>
                <contract_status_desc>发起方待选章提交</contract_status_desc>
                <id>1</id>
                <send_ref_ent_id>32000000000012xxxx</send_ref_ent_id>
                <send_ent_id>32000000000012xxxx</send_ent_id>
            </sy_contract_model>
            <sy_contract_resource_model>
                <sy_contract_resource_model>
                    <pdf_oss_key_url>xx</pdf_oss_key_url>
                    <page>1</page>
                    <id>xx</id>
                    <resource_name>xx</resource_name>
                    <receive_seal_infos>
                        <mode>xx</mode>
                        <seal_info_list>
                            <seal_info>
                                <seal_type>xx</seal_type>
                                <seal_type_name>xx</seal_type_name>
                                <seal_name>xx</seal_name>
                                <seal_desc>xx</seal_desc>
                                <position_list>
                                    <position>
                                        <x>10</x>
                                        <y>10</y>
                                        <page_range>all</page_range>
                                    </position>
                                </position_list>
                                <custom_position_list>
                                    <position>
                                        <x>10</x>
                                        <y>10</y>
                                        <page_range>all</page_range>
                                    </position>
                                </custom_position_list>
                            </seal_info>
                        </seal_info_list>
                    </receive_seal_infos>
                    <receive_seal_limit>
                        <seal_info_list>
                            <seal_info>
                                <seal_type>xx</seal_type>
                                <seal_type_name>xx</seal_type_name>
                                <seal_name>xx</seal_name>
                                <seal_desc>xx</seal_desc>
                                <custom_position_list>
                                    <position>
                                        <x>xx</x>
                                        <y>xx</y>
                                        <page_range>xx</page_range>
                                    </position>
                                </custom_position_list>
                            </seal_info>
                        </seal_info_list>
                    </receive_seal_limit>
                    <send_seal_infos>
                        <model>1</model>
                        <seal_info_list>
                            <seal_info>
                                <seal_type>xx</seal_type>
                                <seal_type_name>xx</seal_type_name>
                                <seal_name>xx</seal_name>
                                <seal_desc>xx</seal_desc>
                                <position_list>
                                    <position>
                                        <x>10</x>
                                        <y>10</y>
                                        <page_range>all</page_range>
                                    </position>
                                </position_list>
                                <custom_position_list>
                                    <position>
                                        <x>10</x>
                                        <y>10</y>
                                        <page_range>1-10,13,15</page_range>
                                    </position>
                                </custom_position_list>
                            </seal_info>
                        </seal_info_list>
                    </send_seal_infos>
                </sy_contract_resource_model>
            </sy_contract_resource_model>
        </model>
        <response_success>true</response_success>
    </result>
</alibaba_alihealth_synergy_sy_contract_detail_response>

{
    "alibaba_alihealth_synergy_sy_contract_detail_response":{
        "result":{
            "msg_code":"xx",
            "msg_info":"xx",
            "model":{
                "sy_contract_model":{
                    "gmt_create":"2025-1-1",
                    "contract_no":"xxx",
                    "receive_ref_ent_id":"32000000000012xxxx",
                    "receive_ent_id":"32000000000012xxxx",
                    "receive_ent_name":"xx企业",
                    "create_person":"张三",
                    "send_time":"2025-1-1",
                    "contract_source":"0",
                    "contract_source_desc":"己方发起",
                    "total_page":1,
                    "contract_name":"xx合同",
                    "contract_type":1,
                    "contract_type_desc":"签署合同",
                    "expire_date":"2024-1-1",
                    "send_ent_name":"xx企业",
                    "complete_time":"2020-1-1",
                    "contract_status":1,
                    "contract_status_desc":"发起方待选章提交",
                    "id":1,
                    "send_ref_ent_id":"32000000000012xxxx",
                    "send_ent_id":"32000000000012xxxx"
                },
                "sy_contract_resource_model":{
                    "sy_contract_resource_model":[
                        {
                            "pdf_oss_key_url":"xx",
                            "page":1,
                            "id":xx,
                            "resource_name":"xx",
                            "receive_seal_infos":{
                                "mode":xx,
                                "seal_info_list":{
                                    "seal_info":[
                                        {
                                            "seal_type":"xx",
                                            "seal_type_name":"xx",
                                            "seal_name":"xx",
                                            "seal_desc":"xx",
                                            "position_list":{
                                                "position":[
                                                    {
                                                        "x":"10",
                                                        "y":"10",
                                                        "page_range":"all"
                                                    }
                                                ]
                                            },
                                            "custom_position_list":{
                                                "position":[
                                                    {
                                                        "x":"10",
                                                        "y":"10",
                                                        "page_range":"all"
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            "receive_seal_limit":{
                                "seal_info_list":{
                                    "seal_info":[
                                        {
                                            "seal_type":"xx",
                                            "seal_type_name":"xx",
                                            "seal_name":"xx",
                                            "seal_desc":"xx",
                                            "custom_position_list":{
                                                "position":[
                                                    {
                                                        "x":"xx",
                                                        "y":"xx",
                                                        "page_range":"xx"
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            "send_seal_infos":{
                                "model":1,
                                "seal_info_list":{
                                    "seal_info":[
                                        {
                                            "seal_type":"xx",
                                            "seal_type_name":"xx",
                                            "seal_name":"xx",
                                            "seal_desc":"xx",
                                            "position_list":{
                                                "position":[
                                                    {
                                                        "x":"10",
                                                        "y":"10",
                                                        "page_range":"all"
                                                    }
                                                ]
                                            },
                                            "custom_position_list":{
                                                "position":[
                                                    {
                                                        "x":"10",
                                                        "y":"10",
                                                        "page_range":"1-10,13,15"
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    ]
                }
            },
            "response_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下载

阿里健康追溯码

alibaba.alihealth.synergy.sy.contract.detail (电子首营合同详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ