文档中心 > API类目 > 营销API

alibaba.benefit.draw (抽奖接口)

功能：抽奖功能，供小程序抽奖调用业务逻辑：程序中通过奖池编号ename,业务方身份appName来查询奖池，根据授权用户(买家)来确认抽奖用户。然后程序进行抽奖流程。小程。安全保障：为保证数据不会越权，需要买家授，并且验证系统参数appKey。只有通过授权的，并且 appkey验证通过的，才会进入抽奖流程，否则直接失败。因为appkey是系统参数，并且程序内部可以验证appkey和业务身份appName的关系是否一致，所以可以保证参数appName的合法性，没有越权。

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	描述
ename	String	必须	82a36d90e6b5401c86623bf579a67b88	奖池唯一标识，奖池创建时即生成
app_name	String	必须	promotioncenter-3000000002037004	调用方AppName：规定为promotioncenter-${appId}
ip	String	可选	127.0.0.1	调用方应用ip，非必填

响应参数

名称	类型	示例值	描述
result	Result		接口返回model
└ result_msg String 抽奖成功 message └ result_code String code └ result_success Boolean false 是否成功
prize_id	String	2280001	权益id
right_id	String	1107261	奖品id
ext_attribute	String	{"template_name":"红包","amount":"500","condition":"10000"}	扩展信息

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaBenefitDrawRequest req = new AlibabaBenefitDrawRequest();
req.setEname("82a36d90e6b5401c86623bf579a67b88");
req.setAppName("promotioncenter-3000000002037004");
req.setIp("127.0.0.1");
AlibabaBenefitDrawResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaBenefitDrawRequest req = new AlibabaBenefitDrawRequest();
req.Ename = "82a36d90e6b5401c86623bf579a67b88";
req.AppName = "promotioncenter-3000000002037004";
req.Ip = "127.0.0.1";
AlibabaBenefitDrawResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaBenefitDrawRequest;
$req->setEname("82a36d90e6b5401c86623bf579a67b88");
$req->setAppName("promotioncenter-3000000002037004");
$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.draw' \
-d 'partner_id=apidoc' \
-d 'session=609ce441-61d1-471a-b2c3-438b466b1612' \
-d 'sign=F8529BA425E75650FCA236DD3461AD66' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+17%3A30%3A27' \
-d 'v=2.0' \
-d 'app_name=promotioncenter-3000000002037004' \
-d 'ename=82a36d90e6b5401c86623bf579a67b88' \
-d 'ip=127.0.0.1'

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

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

req.ename="82a36d90e6b5401c86623bf579a67b88"
req.app_name="promotioncenter-3000000002037004"
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.draw");
add_param(pRequest,"ename","82a36d90e6b5401c86623bf579a67b88");
add_param(pRequest,"app_name","promotioncenter-3000000002037004");
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.draw', {
	'ename':'82a36d90e6b5401c86623bf579a67b88',
	'app_name':'promotioncenter-3000000002037004',
	'ip':'127.0.0.1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<alibaba_benefit_draw_response>
    <result>
        <result_msg>抽奖成功</result_msg>
        <result_code></result_code>
        <result_success>false</result_success>
    </result>
    <prize_id>2280001</prize_id>
    <right_id>1107261</right_id>
    <ext_attribute>{&quot;template_name&quot;:&quot;红包&quot;,&quot;amount&quot;:&quot;500&quot;,&quot;condition&quot;:&quot;10000&quot;}</ext_attribute>
</alibaba_benefit_draw_response>

{
    "alibaba_benefit_draw_response":{
        "result":{
            "result_msg":"抽奖成功",
            "result_code":"",
            "result_success":false
        },
        "prize_id":"2280001",
        "right_id":"1107261",
        "ext_attribute":"{\"template_name\":\"红包\",\"amount\":\"500\",\"condition\":\"10000\"}"
    }
}

异常示例

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工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

营销API

alibaba.benefit.draw (抽奖接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈