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

请求地址：

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

名称	类型	是否必须	示例值	描述
open_template_id	String	可选	4324are	对外消息模板唯一id（业务）
account_id	Number	可选	4234	平台账号id
application_id	String	可选	areq2323	应用id

名称	类型	示例值	描述
result	BaseResult		返回包装类
└ ret_code Number 返回码 ret_value MessageTemplateDetailDto 返回值 app_box_template AppBoxTemplate APP消息盒子消息模板 app_message AppMessage APP消息内容 └ title String 标题 └ content String 内容 fatigue_rule FatigueRule 疲劳度控制 └ type String EXPRESSION EXPRESSION:单日允许次数、NUMERIC:间隔时间段允许推送次数 └ frequency String 1 推送次数，当type为EXPRESSION时，一天内允许推送次数；当type为NUMERIC时，间隔时间段允许推送次数 └ interval String 3 当type为NUMERIC时有效，指定时间段「时间段」推送一条 └ unit_type String SECONDS 当type为NUMERIC时有效，指定时间段「单位」推送一条。MILLSECONDS:毫秒,SECONDS:秒,MINUTES:分钟,HOURS:小时,DAY:天 app_desk_template AppDeskTemplate APP弹窗消息模板 app_message AppMessage APP消息内容 └ title String 标题 └ content String 内容 fatigue_rule FatigueRule 疲劳度控制 └ type String EXPRESSION:单日允许次数、NUMERIC:间隔时间段允许推送次数 └ frequency String 推送次数，当type为EXPRESSION时，一天内允许推送次数；当type为NUMERIC时，间隔时间段允许推送次数 └ interval String 当type为NUMERIC时有效，指定时间段「时间段」推送一条 └ unit_type String 当type为NUMERIC时有效，指定时间段「单位」推送一条。MILLSECONDS:毫秒,SECONDS:秒,MINUTES:分钟,HOURS:小时,DAY:天 push_period_list PushPeriod [] 允许推送时间段 └ start_time String 06:00:00 开始时间 └ end_time String 14:00:00 截止时间 tts_immediate_template TtsImmediateTemplate TTS弹窗消息模板 └ tts_message String TTS内容 fatigue_rule FatigueRule 疲劳度控制 └ type String EXPRESSION:单日允许次数、NUMERIC:间隔时间段允许推送次数 └ frequency String 推送次数，当type为EXPRESSION时，一天内允许推送次数；当type为NUMERIC时，间隔时间段允许推送次数 └ interval String 当type为NUMERIC时有效，指定时间段「时间段」推送一条 └ unit_type String 当type为NUMERIC时有效，指定时间段「单位」推送一条。MILLSECONDS:毫秒,SECONDS:秒,MINUTES:分钟,HOURS:小时,DAY:天 push_period_list PushPeriod [] 允许推送时间段 └ start_time String 开始时间 └ end_time String 截止时间 └ message String 错误信息 └ success Boolean true 是否执行成功 └ trace_id String 请求唯一标识

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAilabsIotSaasMessageTemplateGetRequest req = new AlibabaAilabsIotSaasMessageTemplateGetRequest();
req.setOpenTemplateId("4324are");
req.setAccountId(4234L);
req.setApplicationId("areq2323");
AlibabaAilabsIotSaasMessageTemplateGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAilabsIotSaasMessageTemplateGetRequest req = new AlibabaAilabsIotSaasMessageTemplateGetRequest();
req.OpenTemplateId = "4324are";
req.AccountId = 4234L;
req.ApplicationId = "areq2323";
AlibabaAilabsIotSaasMessageTemplateGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAilabsIotSaasMessageTemplateGetRequest;
$req->setOpenTemplateId("4324are");
$req->setAccountId("4234");
$req->setApplicationId("areq2323");
$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.ailabs.iot.saas.message.template.get' \
-d 'partner_id=apidoc' \
-d 'sign=E33B3BE1DA6AA1E4080AB32DC21EDB50' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+02%3A10%3A52' \
-d 'v=2.0' \
-d 'account_id=4234' \
-d 'application_id=areq2323' \
-d 'open_template_id=4324are'

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

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

req.open_template_id="4324are"
req.account_id=4234
req.application_id="areq2323"
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.ailabs.iot.saas.message.template.get");
add_param(pRequest,"open_template_id","4324are");
add_param(pRequest,"account_id","4234");
add_param(pRequest,"application_id","areq2323");
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.ailabs.iot.saas.message.template.get', {
	'open_template_id':'4324are',
	'account_id':'4234',
	'application_id':'areq2323'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_ailabs_iot_saas_message_template_get_response>
    <result>
        <ret_code></ret_code>
        <ret_value>
            <app_box_template>
                <app_message>
                    <title></title>
                    <content></content>
                </app_message>
                <fatigue_rule>
                    <type>EXPRESSION</type>
                    <frequency>1</frequency>
                    <interval>3</interval>
                    <unit_type>SECONDS</unit_type>
                </fatigue_rule>
            </app_box_template>
            <app_desk_template>
                <app_message>
                    <title></title>
                    <content></content>
                </app_message>
                <fatigue_rule>
                    <type></type>
                    <frequency></frequency>
                    <interval></interval>
                    <unit_type></unit_type>
                </fatigue_rule>
                <push_period_list>
                    <push_period>
                        <start_time>06:00:00</start_time>
                        <end_time>14:00:00</end_time>
                    </push_period>
                </push_period_list>
            </app_desk_template>
            <tts_immediate_template>
                <tts_message></tts_message>
                <fatigue_rule>
                    <type></type>
                    <frequency></frequency>
                    <interval></interval>
                    <unit_type></unit_type>
                </fatigue_rule>
                <push_period_list>
                    <push_period>
                        <start_time></start_time>
                        <end_time></end_time>
                    </push_period>
                </push_period_list>
            </tts_immediate_template>
        </ret_value>
        <message></message>
        <success>true</success>
        <trace_id></trace_id>
    </result>
</alibaba_ailabs_iot_saas_message_template_get_response>

{
    "alibaba_ailabs_iot_saas_message_template_get_response":{
        "result":{
            "ret_code":,
            "ret_value":{
                "app_box_template":{
                    "app_message":{
                        "title":"",
                        "content":""
                    },
                    "fatigue_rule":{
                        "type":"EXPRESSION",
                        "frequency":"1",
                        "interval":"3",
                        "unit_type":"SECONDS"
                    }
                },
                "app_desk_template":{
                    "app_message":{
                        "title":"",
                        "content":""
                    },
                    "fatigue_rule":{
                        "type":"",
                        "frequency":"",
                        "interval":"",
                        "unit_type":""
                    },
                    "push_period_list":{
                        "push_period":[
                            {
                                "start_time":"06:00:00",
                                "end_time":"14:00:00"
                            }
                        ]
                    }
                },
                "tts_immediate_template":{
                    "tts_message":"",
                    "fatigue_rule":{
                        "type":"",
                        "frequency":"",
                        "interval":"",
                        "unit_type":""
                    },
                    "push_period_list":{
                        "push_period":[
                            {
                                "start_time":"",
                                "end_time":""
                            }
                        ]
                    }
                }
            },
            "message":"",
            "success":true,
            "trace_id":""
        }
    }
}

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.iot.saas.message.template.get (获取模板详情信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈