淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
caller_app_key	String	必须	ad87qndead	用于调用模板的内部授权key
user_id	String	可选	g1234	目标用户
device_id	String	可选	UUIDadfad	目标设备ID
template	TemplateParam	必须		推送模板信息
└ body String 必须 {"key1":"value1","key2":"value2"} 模板的具体信息，Map数据 └ digest String 必须 5285ecef194f0d7c2a0e908585121cf2 32位的摘要信息，摘要的计算规则 └ code String 必须 Arrive_tempalte 模板的代表编号 open_uuid_param OpenUuidParam 可选 unionId转换的参数 └ union_id String 可选 aqqqdd 设备的开发id └ organization_id String 可选 sdaqq 组织id └ encode_type String 可选 PROJECT_ID 项目编码类型 └ encode_key String 可选 123442 项目编码key

名称	类型	示例值	描述
result	ServiceResult		返回的结果
└ error_msg String success 错误信息 └ result Boolean true 具体结果值 └ status_code Number 200 状态码，200为成功 └ time_cost Number 120 耗时 └ trace_id String 0b123sdfa traceId

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAilabsPushTemplateNotifyRequest req = new AlibabaAilabsPushTemplateNotifyRequest();
req.setCallerAppKey("ad87qndead");
req.setUserId("g1234");
req.setDeviceId("UUIDadfad");
AlibabaAilabsPushTemplateNotifyRequest.TemplateParam obj1 = new AlibabaAilabsPushTemplateNotifyRequest.TemplateParam();
obj1.setBody("{\"key1\":\"value1\",\"key2\":\"value2\"}");
obj1.setDigest("5285ecef194f0d7c2a0e908585121cf2");
obj1.setCode("Arrive_tempalte");
AlibabaAilabsPushTemplateNotifyRequest.OpenUuidParam obj2 = new AlibabaAilabsPushTemplateNotifyRequest.OpenUuidParam();
obj2.setUnionId("aqqqdd");
obj2.setOrganizationId("sdaqq");
obj2.setEncodeType("PROJECT_ID");
obj2.setEncodeKey("123442");
obj1.setOpenUuidParam(obj2);
req.setTemplate(obj1);
AlibabaAilabsPushTemplateNotifyResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAilabsPushTemplateNotifyRequest req = new AlibabaAilabsPushTemplateNotifyRequest();
req.CallerAppKey = "ad87qndead";
req.UserId = "g1234";
req.DeviceId = "UUIDadfad";
AlibabaAilabsPushTemplateNotifyRequest.TemplateParamDomain obj1 = new AlibabaAilabsPushTemplateNotifyRequest.TemplateParamDomain();
obj1.Body = "{\"key1\":\"value1\",\"key2\":\"value2\"}";
obj1.Digest = "5285ecef194f0d7c2a0e908585121cf2";
obj1.Code = "Arrive_tempalte";
AlibabaAilabsPushTemplateNotifyRequest.OpenUuidParamDomain obj2 = new AlibabaAilabsPushTemplateNotifyRequest.OpenUuidParamDomain();
obj2.UnionId = "aqqqdd";
obj2.OrganizationId = "sdaqq";
obj2.EncodeType = "PROJECT_ID";
obj2.EncodeKey = "123442";
obj1.OpenUuidParam= obj2;
req.Template_ = obj1;
AlibabaAilabsPushTemplateNotifyResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAilabsPushTemplateNotifyRequest;
$req->setCallerAppKey("ad87qndead");
$req->setUserId("g1234");
$req->setDeviceId("UUIDadfad");
$template = new TemplateParam;
$template->body="{\"key1\":\"value1\",\"key2\":\"value2\"}";
$template->digest="5285ecef194f0d7c2a0e908585121cf2";
$template->code="Arrive_tempalte";
$open_uuid_param = new OpenUuidParam;
$open_uuid_param->union_id="aqqqdd";
$open_uuid_param->organization_id="sdaqq";
$open_uuid_param->encode_type="PROJECT_ID";
$open_uuid_param->encode_key="123442";
$template->open_uuid_param = $open_uuid_param;
$req->setTemplate(json_encode($template));
$resp = $c->execute($req, $sessionKey);

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.ailabs.push.template.notify' \
-d 'partner_id=apidoc' \
-d 'session=b715244d-efdd-4027-8dae-566c8afdf5e1' \
-d 'sign=7CEA206B2EF58B4B43AF1EA0A2CA06E5' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+06%3A37%3A39' \
-d 'v=2.0' \
-d 'caller_app_key=ad87qndead' \
-d 'device_id=UUIDadfad' \
-d 'template=null' \
-d 'user_id=g1234'

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

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

req.caller_app_key="ad87qndead"
req.user_id="g1234"
req.device_id="UUIDadfad"
req.template=""
try:
	resp= req.getResponse(sessionkey)
	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.ailabs.push.template.notify");
add_param(pRequest,"caller_app_key","ad87qndead");
add_param(pRequest,"user_id","g1234");
add_param(pRequest,"device_id","UUIDadfad");
add_param(pRequest,"template","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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.ailabs.push.template.notify', {
	'caller_app_key':'ad87qndead',
	'user_id':'g1234',
	'device_id':'UUIDadfad',
	'template':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_ailabs_push_template_notify_response>
    <result>
        <error_msg>success</error_msg>
        <result>true</result>
        <status_code>200</status_code>
        <time_cost>120</time_cost>
        <trace_id>0b123sdfa</trace_id>
    </result>
</alibaba_ailabs_push_template_notify_response>

{
    "alibaba_ailabs_push_template_notify_response":{
        "result":{
            "error_msg":"success",
            "result":true,
            "status_code":200,
            "time_cost":120,
            "trace_id":"0b123sdfa"
        }
    }
}

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.ailabs.push.template.notify (Aligenie模板推送)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ