淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
right_ename	String	必须	db9a4a98898c4ad3bafe9e564c6df344	发放的权益(奖品)唯一标识
receiver_id	String	必须	Adad2dasd_dad2	接收奖品的用户openId
user_type	String	必须	taobao	规定填taobao即可
unique_id	String	必须	unique_id	幂等校验id，业务重试需要，自定义唯一字段即可
app_name	String	必须	mtop	mtop
ip	String	可选	127.0.0.1	调用应用ip，非必填

名称	类型	示例值	描述
result_msg	String	发放成功	接口返回消息
result_code	String	SEND_SUCCESS	接口返回代码
result_success	Boolean	true	是否处理成功
right_id	Number	891033	权益id
prize_name	String	广陌测试虚拟奖品	奖品名称

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaBenefitSendRequest req = new AlibabaBenefitSendRequest();
req.setRightEname("db9a4a98898c4ad3bafe9e564c6df344");
req.setReceiverId("Adad2dasd_dad2");
req.setUserType("taobao");
req.setUniqueId("unique_id");
req.setAppName("mtop");
req.setIp("127.0.0.1");
AlibabaBenefitSendResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaBenefitSendRequest req = new AlibabaBenefitSendRequest();
req.RightEname = "db9a4a98898c4ad3bafe9e564c6df344";
req.ReceiverId = "Adad2dasd_dad2";
req.UserType = "taobao";
req.UniqueId = "unique_id";
req.AppName = "mtop";
req.Ip = "127.0.0.1";
AlibabaBenefitSendResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaBenefitSendRequest;
$req->setRightEname("db9a4a98898c4ad3bafe9e564c6df344");
$req->setReceiverId("Adad2dasd_dad2");
$req->setUserType("taobao");
$req->setUniqueId("unique_id");
$req->setAppName("mtop");
$req->setIp("127.0.0.1");
$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.benefit.send' \
-d 'partner_id=apidoc' \
-d 'session=2d862a41-84f1-4903-8763-3ced531aa0e6' \
-d 'sign=79FACE8C4355A9C48346E9930A04D1C7' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+16%3A43%3A20' \
-d 'v=2.0' \
-d 'app_name=mtop' \
-d 'ip=127.0.0.1' \
-d 'receiver_id=Adad2dasd_dad2' \
-d 'right_ename=db9a4a98898c4ad3bafe9e564c6df344' \
-d 'unique_id=unique_id' \
-d 'user_type=taobao'

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

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

req.right_ename="db9a4a98898c4ad3bafe9e564c6df344"
req.receiver_id="Adad2dasd_dad2"
req.user_type="taobao"
req.unique_id="unique_id"
req.app_name="mtop"
req.ip="127.0.0.1"
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.benefit.send");
add_param(pRequest,"right_ename","db9a4a98898c4ad3bafe9e564c6df344");
add_param(pRequest,"receiver_id","Adad2dasd_dad2");
add_param(pRequest,"user_type","taobao");
add_param(pRequest,"unique_id","unique_id");
add_param(pRequest,"app_name","mtop");
add_param(pRequest,"ip","127.0.0.1");
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.benefit.send', {
	'right_ename':'db9a4a98898c4ad3bafe9e564c6df344',
	'receiver_id':'Adad2dasd_dad2',
	'user_type':'taobao',
	'unique_id':'unique_id',
	'app_name':'mtop',
	'ip':'127.0.0.1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_benefit_send_response>
    <result_msg>发放成功</result_msg>
    <result_code>SEND_SUCCESS</result_code>
    <result_success>true</result_success>
    <right_id>891033</right_id>
    <prize_name>广陌测试虚拟奖品</prize_name>
</alibaba_benefit_send_response>

{
    "alibaba_benefit_send_response":{
        "result_msg":"发放成功",
        "result_code":"SEND_SUCCESS",
        "result_success":true,
        "right_id":891033,
        "prize_name":"广陌测试虚拟奖品"
    }
}

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.benefit.send (发奖接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ