淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
merchant_code	String	可选	aikang		商户唯一码
name	String	可选	张三		体检人姓名
reserve_number	String	可选	123		阿里健康预约唯一标识
gender	String	可选	0		性别(0-男;1-女;)
birthday	String	可选	2000-01-01		出生日期
reserve_date	String	可选	2016-08-01		预约时间
package_code	String	可选	aikang001		体检套餐编码
married	String	可选	0		婚否(0-未婚; 1-已婚)
store_id	String	可选	aikang_cy		店铺ID
phone	String	可选	13912341234		电话号码
cert_type	String	可选	1		证件类型(0-身份证; 1-护照; 2-军官证)
cert_number	String	可选	110110200001011234		证件号
company	String	可选	阿里健康		所属公司
department	String	可选	技术部		所属部门
address	String	可选	北京市朝阳区望京SOHO		报告邮寄地址
add_items	AddItem []	可选		最大列表长度：50	加项列表
└ version Number 可选 123456 版本号，isv需要进行校验版本号是否过期，判断加项信息是否已更改，健康未同步 └ isv_item_id String 可选 123 加项id
add_packs	AddPack []	可选		最大列表长度：50	加项包列表
└ isv_pack_id String 可选 1234 加项包id └ version Number 可选 123456 版本号，isv需要进行校验版本号是否过期，判断加项包信息是否已更改，健康未同步
hava_report	String	可选	0;1		0没报告1有报告
employee_number	String	可选	170178		员工号
service_type	String	可选	ONSITE_SERVICE		服务类型，ONSITE_SERVICE（到店检测）、DOOR_TO_DOOR_SERVICE（上门检测）
service_address	AddAddress	可选			上门服务的上门地址
└ address String 可选北京市朝阳区望京街道用户的上门地址 └ latitude String 可选 30.1212 上门地址纬度（高德系） └ longitude String 可选 120.123123 上门地址经度（高德系） └ district_code String 可选 330110 区域编码（高德标准） └ district String 可选余杭区区域名称（高德标准） └ city_code String 可选 330100 城市编码（高德标准） └ city String 可选杭州市城市名称（高德标准） └ province_code String 可选省份编码省份编码（高德标准） └ province String 可选浙江省省份名称（高德标准）
reserve_time_start	String	可选	2020-12-22 15:30:00		预约时间段开始
reserve_time_end	String	可选	2020-12-22 16:00:00		预约时间段截止

名称	类型	示例值	描述
message	String	正确	返回结果描述
uniq_reserve_code	String	dadafddfdfd	体检机构预约唯一标识码
response_code	String	200	返回结果编码
voucher_code	String	1234556	预约电子凭证码值，若返回凭证码值，会展示在订单详情。用户到店/上门后，可以通过该码值来验证订单，不同预约码值不能重复。长度不超过64位

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthExaminationReserveConfirmRequest req = new AlibabaAlihealthExaminationReserveConfirmRequest();
req.setMerchantCode("aikang");
req.setName("张三");
req.setReserveNumber("123");
req.setGender("0");
req.setBirthday("2000-01-01");
req.setReserveDate("2016-08-01");
req.setPackageCode("aikang001");
req.setMarried("0");
req.setStoreId("aikang_cy");
req.setPhone("13912341234");
req.setCertType("1");
req.setCertNumber("110110200001011234");
req.setCompany("阿里健康");
req.setDepartment("技术部");
req.setAddress("北京市朝阳区望京SOHO");
List<AlibabaAlihealthExaminationReserveConfirmRequest.AddItem> list2 = new ArrayList<AlibabaAlihealthExaminationReserveConfirmRequest.AddItem>();
AlibabaAlihealthExaminationReserveConfirmRequest.AddItem obj3 = new AlibabaAlihealthExaminationReserveConfirmRequest.AddItem();
list2.add(obj3);
obj3.setVersion(123456L);
obj3.setIsvItemId("123");
req.setAddItems(list2);
List<AlibabaAlihealthExaminationReserveConfirmRequest.AddPack> list5 = new ArrayList<AlibabaAlihealthExaminationReserveConfirmRequest.AddPack>();
AlibabaAlihealthExaminationReserveConfirmRequest.AddPack obj6 = new AlibabaAlihealthExaminationReserveConfirmRequest.AddPack();
list5.add(obj6);
obj6.setIsvPackId("1234");
obj6.setVersion(123456L);
req.setAddPacks(list5);
req.setHavaReport("0;1");
req.setEmployeeNumber("170178");
req.setServiceType("ONSITE_SERVICE");
AlibabaAlihealthExaminationReserveConfirmRequest.AddAddress obj7 = new AlibabaAlihealthExaminationReserveConfirmRequest.AddAddress();
obj7.setAddress("北京市朝阳区望京街道");
obj7.setLatitude("30.1212");
obj7.setLongitude("120.123123");
obj7.setDistrictCode("330110");
obj7.setDistrict("余杭区");
obj7.setCityCode("330100");
obj7.setCity("杭州市");
obj7.setProvinceCode("省份编码");
obj7.setProvince("浙江省");
req.setServiceAddress(obj7);
req.setReserveTimeStart("2020-12-22 15:30:00");
req.setReserveTimeEnd("2020-12-22 16:00:00");
AlibabaAlihealthExaminationReserveConfirmResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthExaminationReserveConfirmRequest req = new AlibabaAlihealthExaminationReserveConfirmRequest();
req.MerchantCode = "aikang";
req.Name = "张三";
req.ReserveNumber = "123";
req.Gender = "0";
req.Birthday = "2000-01-01";
req.ReserveDate = "2016-08-01";
req.PackageCode = "aikang001";
req.Married = "0";
req.StoreId = "aikang_cy";
req.Phone = "13912341234";
req.CertType = "1";
req.CertNumber = "110110200001011234";
req.Company = "阿里健康";
req.Department = "技术部";
req.Address = "北京市朝阳区望京SOHO";
List<AlibabaAlihealthExaminationReserveConfirmRequest.AddItemDomain> list2 = new List<AlibabaAlihealthExaminationReserveConfirmRequest.AddItemDomain>();
AlibabaAlihealthExaminationReserveConfirmRequest.AddItemDomain obj3 = new AlibabaAlihealthExaminationReserveConfirmRequest.AddItemDomain();
list2.Add(obj3);
obj3.Version = 123456L;
obj3.IsvItemId = "123";
req.AddItems_ = list2;
List<AlibabaAlihealthExaminationReserveConfirmRequest.AddPackDomain> list5 = new List<AlibabaAlihealthExaminationReserveConfirmRequest.AddPackDomain>();
AlibabaAlihealthExaminationReserveConfirmRequest.AddPackDomain obj6 = new AlibabaAlihealthExaminationReserveConfirmRequest.AddPackDomain();
list5.Add(obj6);
obj6.IsvPackId = "1234";
obj6.Version = 123456L;
req.AddPacks_ = list5;
req.HavaReport = "0;1";
req.EmployeeNumber = "170178";
req.ServiceType = "ONSITE_SERVICE";
AlibabaAlihealthExaminationReserveConfirmRequest.AddAddressDomain obj7 = new AlibabaAlihealthExaminationReserveConfirmRequest.AddAddressDomain();
obj7.Address = "北京市朝阳区望京街道";
obj7.Latitude = "30.1212";
obj7.Longitude = "120.123123";
obj7.DistrictCode = "330110";
obj7.District = "余杭区";
obj7.CityCode = "330100";
obj7.City = "杭州市";
obj7.ProvinceCode = "省份编码";
obj7.Province = "浙江省";
req.ServiceAddress_ = obj7;
req.ReserveTimeStart = "2020-12-22 15:30:00";
req.ReserveTimeEnd = "2020-12-22 16:00:00";
AlibabaAlihealthExaminationReserveConfirmResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthExaminationReserveConfirmRequest;
$req->setMerchantCode("aikang");
$req->setName("张三");
$req->setReserveNumber("123");
$req->setGender("0");
$req->setBirthday("2000-01-01");
$req->setReserveDate("2016-08-01");
$req->setPackageCode("aikang001");
$req->setMarried("0");
$req->setStoreId("aikang_cy");
$req->setPhone("13912341234");
$req->setCertType("1");
$req->setCertNumber("110110200001011234");
$req->setCompany("阿里健康");
$req->setDepartment("技术部");
$req->setAddress("北京市朝阳区望京SOHO");
$add_items = new AddItem;
$add_items->version="123456";
$add_items->isv_item_id="123";
$req->setAddItems(json_encode($add_items));
$add_packs = new AddPack;
$add_packs->isv_pack_id="1234";
$add_packs->version="123456";
$req->setAddPacks(json_encode($add_packs));
$req->setHavaReport("0;1");
$req->setEmployeeNumber("170178");
$req->setServiceType("ONSITE_SERVICE");
$service_address = new AddAddress;
$service_address->address="北京市朝阳区望京街道";
$service_address->latitude="30.1212";
$service_address->longitude="120.123123";
$service_address->district_code="330110";
$service_address->district="余杭区";
$service_address->city_code="330100";
$service_address->city="杭州市";
$service_address->province_code="省份编码";
$service_address->province="浙江省";
$req->setServiceAddress(json_encode($service_address));
$req->setReserveTimeStart("2020-12-22 15:30:00");
$req->setReserveTimeEnd("2020-12-22 16:00:00");
$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.examination.reserve.confirm' \
-d 'partner_id=apidoc' \
-d 'sign=BAD391A0BB5278871EA7D4B2471F2468' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-28+02%3A11%3A03' \
-d 'v=2.0' \
-d 'add_items=null' \
-d 'add_packs=null' \
-d 'address=%E5%8C%97%E4%BA%AC%E5%B8%82%E6%9C%9D%E9%98%B3%E5%8C%BA%E6%9C%9B%E4%BA%ACSOHO' \
-d 'birthday=2000-01-01' \
-d 'cert_number=110110200001011234' \
-d 'cert_type=1' \
-d 'company=%E9%98%BF%E9%87%8C%E5%81%A5%E5%BA%B7' \
-d 'department=%E6%8A%80%E6%9C%AF%E9%83%A8' \
-d 'employee_number=170178' \
-d 'gender=0' \
-d 'hava_report=0%3B1' \
-d 'married=0' \
-d 'merchant_code=aikang' \
-d 'name=%E5%BC%A0%E4%B8%89' \
-d 'package_code=aikang001' \
-d 'phone=13912341234' \
-d 'reserve_date=2016-08-01' \
-d 'reserve_number=123' \
-d 'reserve_time_end=2020-12-22+16%3A00%3A00' \
-d 'reserve_time_start=2020-12-22+15%3A30%3A00' \
-d 'service_address=null' \
-d 'service_type=ONSITE_SERVICE' \
-d 'store_id=aikang_cy'

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

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

req.merchant_code="aikang"
req.name="张三"
req.reserve_number="123"
req.gender="0"
req.birthday="2000-01-01"
req.reserve_date="2016-08-01"
req.package_code="aikang001"
req.married="0"
req.store_id="aikang_cy"
req.phone="13912341234"
req.cert_type="1"
req.cert_number="110110200001011234"
req.company="阿里健康"
req.department="技术部"
req.address="北京市朝阳区望京SOHO"
req.add_items=""
req.add_packs=""
req.hava_report="0;1"
req.employee_number="170178"
req.service_type="ONSITE_SERVICE"
req.service_address=""
req.reserve_time_start="2020-12-22 15:30:00"
req.reserve_time_end="2020-12-22 16:00:00"
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.examination.reserve.confirm");
add_param(pRequest,"merchant_code","aikang");
add_param(pRequest,"name","张三");
add_param(pRequest,"reserve_number","123");
add_param(pRequest,"gender","0");
add_param(pRequest,"birthday","2000-01-01");
add_param(pRequest,"reserve_date","2016-08-01");
add_param(pRequest,"package_code","aikang001");
add_param(pRequest,"married","0");
add_param(pRequest,"store_id","aikang_cy");
add_param(pRequest,"phone","13912341234");
add_param(pRequest,"cert_type","1");
add_param(pRequest,"cert_number","110110200001011234");
add_param(pRequest,"company","阿里健康");
add_param(pRequest,"department","技术部");
add_param(pRequest,"address","北京市朝阳区望京SOHO");
add_param(pRequest,"add_items","数据结构JSON示例");
add_param(pRequest,"add_packs","数据结构JSON示例");
add_param(pRequest,"hava_report","0;1");
add_param(pRequest,"employee_number","170178");
add_param(pRequest,"service_type","ONSITE_SERVICE");
add_param(pRequest,"service_address","数据结构JSON示例");
add_param(pRequest,"reserve_time_start","2020-12-22 15:30:00");
add_param(pRequest,"reserve_time_end","2020-12-22 16:00:00");
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.examination.reserve.confirm', {
	'merchant_code':'aikang',
	'name':'张三',
	'reserve_number':'123',
	'gender':'0',
	'birthday':'2000-01-01',
	'reserve_date':'2016-08-01',
	'package_code':'aikang001',
	'married':'0',
	'store_id':'aikang_cy',
	'phone':'13912341234',
	'cert_type':'1',
	'cert_number':'110110200001011234',
	'company':'阿里健康',
	'department':'技术部',
	'address':'北京市朝阳区望京SOHO',
	'add_items':'数据结构JSON示例',
	'add_packs':'数据结构JSON示例',
	'hava_report':'0;1',
	'employee_number':'170178',
	'service_type':'ONSITE_SERVICE',
	'service_address':'数据结构JSON示例',
	'reserve_time_start':'2020-12-22 15:30:00',
	'reserve_time_end':'2020-12-22 16:00:00'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_examination_reserve_confirm_response>
    <message>正确</message>
    <uniq_reserve_code>dadafddfdfd</uniq_reserve_code>
    <response_code>200</response_code>
    <voucher_code>1234556</voucher_code>
</alibaba_alihealth_examination_reserve_confirm_response>

{
    "alibaba_alihealth_examination_reserve_confirm_response":{
        "message":"正确",
        "uniq_reserve_code":"dadafddfdfd",
        "response_code":"200",
        "voucher_code":"1234556"
    }
}

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"
	}
}

错误码	错误描述	解决方案
isv.access_deny	权限异常	直接返回
isv.error	未知错误	直接返回
isv.cant_reserve	不能预约	直接返回
isv.illegal_args	参数错误	直接返回
isv.reserve_over	预约已满	直接返回
isp.http-read-timeout

API测试工具错误码查询工具 SDK下载

体检机构API

alibaba.alihealth.examination.reserve.confirm (体检机构对接_体检套餐预定确认)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ