阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
birthday	String	可选	2020-06-01		接种人出生日期
area	String	可选	朝阳区		区名称
address	String	可选	北京市朝阳区呼家楼1号		接种点地址
order_id	String	可选	86837		订单 ID
pov_name	String	必须	呼家楼接种点		接种点名称
city	String	可选	北京市		城市名称
pov_no	String	可选	2088332589401234		接种点编码
sex	Number	可选	1		接种人性别:1=男,2=女
mobile	String	可选	18801293033		联系电话
vaccine_list	VaccineInfo []	必须		最大列表长度：999	接种的疫苗信息
└ vaccine_name String 必须卡介苗疫苗名称 └ vaccine_code String 可选 100AF1 疫苗编码 └ the_times Number 必须 1 疫苗针次 └ vaccine_gb_code String 必须 10002 阿里健康疫苗编码
province	String	可选	北京市		省份名称
message_type	Number	必须	1		消息提醒类型：1=疫苗下一针预约提醒 2=预约成功提醒 3=接种提醒 4=补种提醒
reserve_time	String	可选	09:00-11:30		预约时间段
name	String	必须	王小明		接种人姓名
isv_user_id	String	可选	3928019		ISV 侧用户 ID
reserve_date	String	可选	2020-07-01		预约日期
alipay_user_id	String	必须	2088332589401234		支付宝用户 ID
app_channel	String	可选	yl	默认值：alipay	用户入口，支付宝或医鹿，alipay或yl

名称	类型	示例值	描述
is_success	Boolean	true	是否成功执行
model	Boolean	true	有数据返回时的数据详情
msg_info	String	错误消息详情	找不到疫苗信息
msg_code	String	错误码	200

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaHealthVaccinNoticeSendRequest req = new AlibabaHealthVaccinNoticeSendRequest();
req.setBirthday("2020-06-01");
req.setArea("朝阳区");
req.setAddress("北京市朝阳区呼家楼1号");
req.setOrderId("86837");
req.setPovName("呼家楼接种点");
req.setCity("北京市");
req.setPovNo("2088332589401234");
req.setSex(1L);
req.setMobile("18801293033");
List<AlibabaHealthVaccinNoticeSendRequest.VaccineInfo> list2 = new ArrayList<AlibabaHealthVaccinNoticeSendRequest.VaccineInfo>();
AlibabaHealthVaccinNoticeSendRequest.VaccineInfo obj3 = new AlibabaHealthVaccinNoticeSendRequest.VaccineInfo();
list2.add(obj3);
obj3.setVaccineName("卡介苗");
obj3.setVaccineCode("100AF1");
obj3.setTheTimes(1L);
obj3.setVaccineGbCode("10002");
req.setVaccineList(list2);
req.setProvince("北京市");
req.setMessageType(1L);
req.setReserveTime("09:00-11:30");
req.setName("王小明");
req.setIsvUserId("3928019");
req.setReserveDate("2020-07-01");
req.setAlipayUserId("2088332589401234");
req.setAppChannel("yl");
AlibabaHealthVaccinNoticeSendResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaHealthVaccinNoticeSendRequest req = new AlibabaHealthVaccinNoticeSendRequest();
req.Birthday = "2020-06-01";
req.Area = "朝阳区";
req.Address = "北京市朝阳区呼家楼1号";
req.OrderId = "86837";
req.PovName = "呼家楼接种点";
req.City = "北京市";
req.PovNo = "2088332589401234";
req.Sex = 1L;
req.Mobile = "18801293033";
List<AlibabaHealthVaccinNoticeSendRequest.VaccineInfoDomain> list2 = new List<AlibabaHealthVaccinNoticeSendRequest.VaccineInfoDomain>();
AlibabaHealthVaccinNoticeSendRequest.VaccineInfoDomain obj3 = new AlibabaHealthVaccinNoticeSendRequest.VaccineInfoDomain();
list2.Add(obj3);
obj3.VaccineName = "卡介苗";
obj3.VaccineCode = "100AF1";
obj3.TheTimes = 1L;
obj3.VaccineGbCode = "10002";
req.VaccineList_ = list2;
req.Province = "北京市";
req.MessageType = 1L;
req.ReserveTime = "09:00-11:30";
req.Name = "王小明";
req.IsvUserId = "3928019";
req.ReserveDate = "2020-07-01";
req.AlipayUserId = "2088332589401234";
req.AppChannel = "yl";
AlibabaHealthVaccinNoticeSendResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaHealthVaccinNoticeSendRequest;
$req->setBirthday("2020-06-01");
$req->setArea("朝阳区");
$req->setAddress("北京市朝阳区呼家楼1号");
$req->setOrderId("86837");
$req->setPovName("呼家楼接种点");
$req->setCity("北京市");
$req->setPovNo("2088332589401234");
$req->setSex("1");
$req->setMobile("18801293033");
$vaccine_list = new VaccineInfo;
$vaccine_list->vaccine_name="卡介苗";
$vaccine_list->vaccine_code="100AF1";
$vaccine_list->the_times="1";
$vaccine_list->vaccine_gb_code="10002";
$req->setVaccineList(json_encode($vaccine_list));
$req->setProvince("北京市");
$req->setMessageType("1");
$req->setReserveTime("09:00-11:30");
$req->setName("王小明");
$req->setIsvUserId("3928019");
$req->setReserveDate("2020-07-01");
$req->setAlipayUserId("2088332589401234");
$req->setAppChannel("yl");
$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.health.vaccin.notice.send' \
-d 'partner_id=apidoc' \
-d 'sign=5A05A84AC81DD5F47986359519047933' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-11-25+23%3A52%3A48' \
-d 'v=2.0' \
-d 'address=%E5%8C%97%E4%BA%AC%E5%B8%82%E6%9C%9D%E9%98%B3%E5%8C%BA%E5%91%BC%E5%AE%B6%E6%A5%BC1%E5%8F%B7' \
-d 'alipay_user_id=2088332589401234' \
-d 'app_channel=yl' \
-d 'area=%E6%9C%9D%E9%98%B3%E5%8C%BA' \
-d 'birthday=2020-06-01' \
-d 'city=%E5%8C%97%E4%BA%AC%E5%B8%82' \
-d 'isv_user_id=3928019' \
-d 'message_type=1' \
-d 'mobile=18801293033' \
-d 'name=%E7%8E%8B%E5%B0%8F%E6%98%8E' \
-d 'order_id=86837' \
-d 'pov_name=%E5%91%BC%E5%AE%B6%E6%A5%BC%E6%8E%A5%E7%A7%8D%E7%82%B9' \
-d 'pov_no=2088332589401234' \
-d 'province=%E5%8C%97%E4%BA%AC%E5%B8%82' \
-d 'reserve_date=2020-07-01' \
-d 'reserve_time=09%3A00-11%3A30' \
-d 'sex=1' \
-d 'vaccine_list=null'

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

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

req.birthday="2020-06-01"
req.area="朝阳区"
req.address="北京市朝阳区呼家楼1号"
req.order_id="86837"
req.pov_name="呼家楼接种点"
req.city="北京市"
req.pov_no="2088332589401234"
req.sex=1
req.mobile="18801293033"
req.vaccine_list=""
req.province="北京市"
req.message_type=1
req.reserve_time="09:00-11:30"
req.name="王小明"
req.isv_user_id="3928019"
req.reserve_date="2020-07-01"
req.alipay_user_id="2088332589401234"
req.app_channel="yl"
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.health.vaccin.notice.send");
add_param(pRequest,"birthday","2020-06-01");
add_param(pRequest,"area","朝阳区");
add_param(pRequest,"address","北京市朝阳区呼家楼1号");
add_param(pRequest,"order_id","86837");
add_param(pRequest,"pov_name","呼家楼接种点");
add_param(pRequest,"city","北京市");
add_param(pRequest,"pov_no","2088332589401234");
add_param(pRequest,"sex","1");
add_param(pRequest,"mobile","18801293033");
add_param(pRequest,"vaccine_list","数据结构JSON示例");
add_param(pRequest,"province","北京市");
add_param(pRequest,"message_type","1");
add_param(pRequest,"reserve_time","09:00-11:30");
add_param(pRequest,"name","王小明");
add_param(pRequest,"isv_user_id","3928019");
add_param(pRequest,"reserve_date","2020-07-01");
add_param(pRequest,"alipay_user_id","2088332589401234");
add_param(pRequest,"app_channel","yl");
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.health.vaccin.notice.send', {
	'birthday':'2020-06-01',
	'area':'朝阳区',
	'address':'北京市朝阳区呼家楼1号',
	'order_id':'86837',
	'pov_name':'呼家楼接种点',
	'city':'北京市',
	'pov_no':'2088332589401234',
	'sex':'1',
	'mobile':'18801293033',
	'vaccine_list':'数据结构JSON示例',
	'province':'北京市',
	'message_type':'1',
	'reserve_time':'09:00-11:30',
	'name':'王小明',
	'isv_user_id':'3928019',
	'reserve_date':'2020-07-01',
	'alipay_user_id':'2088332589401234',
	'app_channel':'yl'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_health_vaccin_notice_send_response>
    <is_success>true</is_success>
    <model>true</model>
    <msg_info>错误消息详情</msg_info>
    <msg_code>错误码</msg_code>
</alibaba_health_vaccin_notice_send_response>

{
    "alibaba_health_vaccin_notice_send_response":{
        "is_success":true,
        "model":true,
        "msg_info":"错误消息详情",
        "msg_code":"错误码"
    }
}

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.health.vaccin.notice.send (发送消息提醒)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈