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

alibaba.benefit.query (奖池奖品查询列表)

功能：奖池奖品查询列表业务逻辑：程序中通过奖池编号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	必须	e17c4803d2f94f4dbb31c39015dd0b25	奖池编号
award_type	String	可选	1	表示奖池类型（发奖奖池传1，抽奖传0）
app_name	String	必须	promotioncenter-12345	商家来源身份标识（"promotion-"+appId）

响应参数

名称	类型	示例值	描述
result	Result	{"defaultModel":[{"amount":"2000","benefitName":"那云小程序测试","endDate":"2019-08-22 00:00:00","prizeId":2204018,"prizeQuantity":1000,"probability":"1.0","remainPrizeQuantity":1000,"rightTypeId":3,"rightTypeName":"店铺/门店优惠券","startDate":"2019-08-20 00:00:00"}],"resultCode":{"msgCode":"SUCCESS","msgInfo":"调用成功"},"success":true}	接口返回model
└ msg String 调用成功 msg └ code String SUCCESS code └ success Boolean true 是否成功 datas OrightDto [] s": "com.taobao.mrp.platform.openservice.award.dataobject.OrightDTO", "startDate": 1566230400000, "remainPrizeQuantity": 1000 } ] datas └ prize_id Number 2204018 奖品id └ template_name String template_name 模板名称 └ benefit_name String 那云小程序测试权益内容 └ right_type_name String 店铺/门店优惠券权益类型名称 └ right_type_id Number 3 权益类型id └ start_date Date 开始时间 └ end_date Date 结束时间 └ prize_quantity Number 总数 └ remain_prize_quantity Number 可发放数 └ probability String 概率 └ amount String 金额 └ use_start_time Date 使用开始时间 └ use_end_time Date 使用结束时间 └ condition String 10000 门槛 └ ext_attribute String "" 扩展参数

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaBenefitQueryRequest req = new AlibabaBenefitQueryRequest();
req.setEname("e17c4803d2f94f4dbb31c39015dd0b25");
req.setAwardType("1");
req.setAppName("promotioncenter-12345");
AlibabaBenefitQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaBenefitQueryRequest req = new AlibabaBenefitQueryRequest();
req.Ename = "e17c4803d2f94f4dbb31c39015dd0b25";
req.AwardType = "1";
req.AppName = "promotioncenter-12345";
AlibabaBenefitQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaBenefitQueryRequest;
$req->setEname("e17c4803d2f94f4dbb31c39015dd0b25");
$req->setAwardType("1");
$req->setAppName("promotioncenter-12345");
$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.query' \
-d 'partner_id=apidoc' \
-d 'session=48b96c4b-e9d8-4f27-bdc1-589fbd0ee8b4' \
-d 'sign=5B827EDD3CCC79421413840E8ECD000B' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+17%3A28%3A05' \
-d 'v=2.0' \
-d 'app_name=promotioncenter-12345' \
-d 'award_type=1' \
-d 'ename=e17c4803d2f94f4dbb31c39015dd0b25'

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

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

req.ename="e17c4803d2f94f4dbb31c39015dd0b25"
req.award_type="1"
req.app_name="promotioncenter-12345"
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.query");
add_param(pRequest,"ename","e17c4803d2f94f4dbb31c39015dd0b25");
add_param(pRequest,"award_type","1");
add_param(pRequest,"app_name","promotioncenter-12345");
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.query', {
	'ename':'e17c4803d2f94f4dbb31c39015dd0b25',
	'award_type':'1',
	'app_name':'promotioncenter-12345'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<alibaba_benefit_query_response>
    <result>
        <msg>调用成功</msg>
        <code>SUCCESS</code>
        <success>true</success>
        <datas>
            <oright_dto>
                <prize_id>2204018</prize_id>
                <template_name>template_name</template_name>
                <benefit_name>那云小程序测试</benefit_name>
                <right_type_name>店铺/门店优惠券</right_type_name>
                <right_type_id>3</right_type_id>
                <start_date></start_date>
                <end_date></end_date>
                <prize_quantity></prize_quantity>
                <remain_prize_quantity></remain_prize_quantity>
                <probability></probability>
                <amount></amount>
                <use_start_time></use_start_time>
                <use_end_time></use_end_time>
                <condition>10000</condition>
                <ext_attribute>&quot;&quot;</ext_attribute>
            </oright_dto>
        </datas>
    </result>
</alibaba_benefit_query_response>

{
    "alibaba_benefit_query_response":{
        "result":{
            "msg":"调用成功",
            "code":"SUCCESS",
            "success":true,
            "datas":{
                "oright_dto":[
                    {
                        "prize_id":2204018,
                        "template_name":"template_name",
                        "benefit_name":"那云小程序测试",
                        "right_type_name":"店铺\/门店优惠券",
                        "right_type_id":3,
                        "start_date":"",
                        "end_date":"",
                        "prize_quantity":,
                        "remain_prize_quantity":,
                        "probability":"",
                        "amount":"",
                        "use_start_time":"",
                        "use_end_time":"",
                        "condition":"10000",
                        "ext_attribute":"\"\""
                    }
                ]
            }
        }
    }
}

异常示例

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.query (奖池奖品查询列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈