淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
template_send_req	TemplateSendBenefitTopReqDTO	必须			发放参数
└ out_transaction_id String 必须 3a8349e1b0b24f32997efe8f26475a99 幂等id └ provider_acct_sys String 必须 BUC 权益模板创建者账号体系。如阿里小二创建的，就是BUC；如是商家创建的，就是商家TAO └ provider_id Number 必须 123456 权益模板创建者ID。如阿里小二创建的，就是小二工号；如是商家创建的，就是商家ID └ receive_user_acct_sys String 必须 TAO 权益接收者账号体系 └ template_id Number 必须 123456789 权益模板ID

名称	类型	示例值	描述
fail_code	String	PARAM_IS_NULL	错误码
fail_msg	String	request param can't be null	错误信息
model	TemplateSendBenefitTopRespDTO		响应结果
└ record_id Number 123456 发放记录ID
result_success	Boolean	true	是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaOrightBenefitTemplateSendRequest req = new AlibabaOrightBenefitTemplateSendRequest();
AlibabaOrightBenefitTemplateSendRequest.TemplateSendBenefitTopReqDTO obj1 = new AlibabaOrightBenefitTemplateSendRequest.TemplateSendBenefitTopReqDTO();
obj1.setOutTransactionId("3a8349e1b0b24f32997efe8f26475a99");
obj1.setProviderAcctSys("BUC");
obj1.setProviderId(123456L);
obj1.setReceiveUserAcctSys("TAO");
obj1.setTemplateId(123456789L);
req.setTemplateSendReq(obj1);
AlibabaOrightBenefitTemplateSendResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaOrightBenefitTemplateSendRequest req = new AlibabaOrightBenefitTemplateSendRequest();
AlibabaOrightBenefitTemplateSendRequest.TemplateSendBenefitTopReqDTODomain obj1 = new AlibabaOrightBenefitTemplateSendRequest.TemplateSendBenefitTopReqDTODomain();
obj1.OutTransactionId = "3a8349e1b0b24f32997efe8f26475a99";
obj1.ProviderAcctSys = "BUC";
obj1.ProviderId = 123456L;
obj1.ReceiveUserAcctSys = "TAO";
obj1.TemplateId = 123456789L;
req.TemplateSendReq_ = obj1;
AlibabaOrightBenefitTemplateSendResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaOrightBenefitTemplateSendRequest;
$template_send_req = new TemplateSendBenefitTopReqDTO;
$template_send_req->out_transaction_id="3a8349e1b0b24f32997efe8f26475a99";
$template_send_req->provider_acct_sys="BUC";
$template_send_req->provider_id="123456";
$template_send_req->receive_user_acct_sys="TAO";
$template_send_req->template_id="123456789";
$req->setTemplateSendReq(json_encode($template_send_req));
$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.oright.benefit.template.send' \
-d 'partner_id=apidoc' \
-d 'session=37b0b1d1-4b03-4565-a929-f203c683b6ac' \
-d 'sign=A68E8C70738819A0DC569AFC59D291EF' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-24+16%3A04%3A17' \
-d 'v=2.0' \
-d 'template_send_req=null'

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

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

req.template_send_req="数据结构示例JSON格式"
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.oright.benefit.template.send");
add_param(pRequest,"template_send_req","数据结构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.oright.benefit.template.send', {
	'template_send_req':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_oright_benefit_template_send_response>
    <fail_code>PARAM_IS_NULL</fail_code>
    <fail_msg>request param can&apos;t be null</fail_msg>
    <model>
        <record_id>123456</record_id>
    </model>
    <result_success>true</result_success>
</alibaba_oright_benefit_template_send_response>

{
    "alibaba_oright_benefit_template_send_response":{
        "fail_code":"PARAM_IS_NULL",
        "fail_msg":"request param can't be null",
        "model":{
            "record_id":123456
        },
        "result_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下载

营销API

alibaba.oright.benefit.template.send (单模板权益投放)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ