淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
rank_reward_request	RankRewardRequest	必须			指定排名用户发奖
└ biz_scene String 必须 DDZ_EVEVRYONE 业务场景 └ act_id String 必须 20250108141313456102090632 活动id └ copy_id String 必须 20250108150940360326277625 组件id └ rank_no Number 必须 1 用户场次排名 └ request_id String 必须 124324323 幂等id └ open_id String 必须 AAFh0z9sAOAaPm8T4L3O22tX openId └ rank_biz_id String 必须 20250107_1 用户比赛场次标识

名称	类型	示例值	描述
biz_error_msg	String	SUCCESS	错误信息
trace_id	String	2136014817363904785403457e5504	traceId
can_retry	Boolean	false	是否可重试
biz_error_code	String	SUCCESS	错误码
data	SnsRewardRankUserDTO		返回数据
send_right_infos SendRightInfos [] 发放的奖励信息 └ valid_time_value String "" 有效时间时间值 └ valid_type String "" 有效时间类型 └ out_biz_instance_id String "" 外部权益实例id └ out_template_id String 462 外部底层模版id └ act_code String e34byhsqilzkn20j 活动码 └ right_name String "" 权益名称 discount_info RightDiscountInfoDTO "" 优惠信息 └ fixed_price_yuan String "" 单品特价，单位元 └ amount Number 1 积分类资产数量 └ benefit_type String VIRTUAL_INTEGRAL 优惠类型 └ reduction_yuan String 0.01 抵扣金额，单位元 └ threshold_yuan String "" 门槛，单位元 └ threshold String "" 门槛，单位分 └ reduction String 1 抵扣金额，单位分 └ fixed_price String "" 单品特价 oright_send_record_info RightDiscountInfoDTO "" oright返回值 └ record_id Number 2 recordId └ template_provider_id Number 2 templateProviderId └ template_id Number 2 templateId └ out_benefit_id String "" outBenefitId └ status String "" status └ result_code String "" resultCode └ result_msg String "" resultMsg └ operate_type Number "" operateType └ product_code String "" productCode └ out_template_id String "" outTemplateId └ prize_id String "" prizeId └ template_name String "" templateName └ gmt_create Date "" gmtCreate material_info OrightSendRecordDTO "" 权益素材相关信息 └ title String "" 标题 └ description String "" 描述 └ pic String "" 图片 └ button_text String "" 按钮文本 └ jump_url String "" 跳链 └ alipay_resource_id String "" alipayResourceId └ scene_code String 4CA660AU9Q5 场景码 └ right_instance_id_str String 2501094269844133575 权益实例id └ right_id String 2403062009314568586 权益id └ sub_type String INTEGRAL_PROPERTY 券子类型 user_limit_info RightUserLimitInfoDTO "" 核销限制信息 └ venue_id String "" 核销信息 └ start_time Date "" 开始时间 └ end_time Date "" 结束时间 └ valid_time_unit Date "" 有效时间时间单位 └ has_prize Boolean true 是否有奖励
biz_success	Boolean	true	调用是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscGrowthInteractiveSnsRankRewardRequest req = new AlibabaAlscGrowthInteractiveSnsRankRewardRequest();
AlibabaAlscGrowthInteractiveSnsRankRewardRequest.RankRewardRequest obj1 = new AlibabaAlscGrowthInteractiveSnsRankRewardRequest.RankRewardRequest();
obj1.setBizScene("DDZ_EVEVRYONE");
obj1.setActId("20250108141313456102090632");
obj1.setCopyId("20250108150940360326277625");
obj1.setRankNo(1L);
obj1.setRequestId("124324323");
obj1.setOpenId("AAFh0z9sAOAaPm8T4L3O22tX");
obj1.setRankBizId("20250107_1");
req.setRankRewardRequest(obj1);
AlibabaAlscGrowthInteractiveSnsRankRewardResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscGrowthInteractiveSnsRankRewardRequest req = new AlibabaAlscGrowthInteractiveSnsRankRewardRequest();
AlibabaAlscGrowthInteractiveSnsRankRewardRequest.RankRewardRequestDomain obj1 = new AlibabaAlscGrowthInteractiveSnsRankRewardRequest.RankRewardRequestDomain();
obj1.BizScene = "DDZ_EVEVRYONE";
obj1.ActId = "20250108141313456102090632";
obj1.CopyId = "20250108150940360326277625";
obj1.RankNo = 1L;
obj1.RequestId = "124324323";
obj1.OpenId = "AAFh0z9sAOAaPm8T4L3O22tX";
obj1.RankBizId = "20250107_1";
req.RankRewardRequest_ = obj1;
AlibabaAlscGrowthInteractiveSnsRankRewardResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscGrowthInteractiveSnsRankRewardRequest;
$rank_reward_request = new RankRewardRequest;
$rank_reward_request->biz_scene="DDZ_EVEVRYONE";
$rank_reward_request->act_id="20250108141313456102090632";
$rank_reward_request->copy_id="20250108150940360326277625";
$rank_reward_request->rank_no="1";
$rank_reward_request->request_id="124324323";
$rank_reward_request->open_id="AAFh0z9sAOAaPm8T4L3O22tX";
$rank_reward_request->rank_biz_id="20250107_1";
$req->setRankRewardRequest(json_encode($rank_reward_request));
$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.alsc.growth.interactive.sns.rank.reward' \
-d 'partner_id=apidoc' \
-d 'sign=B37DC9695BD58EE3E2AFC8D6E4C98721' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-29+15%3A53%3A07' \
-d 'v=2.0' \
-d 'rank_reward_request=null'

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

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

req.rank_reward_request="数据结构示例JSON格式"
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.alsc.growth.interactive.sns.rank.reward");
add_param(pRequest,"rank_reward_request","数据结构JSON示例");
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.alsc.growth.interactive.sns.rank.reward', {
	'rank_reward_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alsc_growth_interactive_sns_rank_reward_response>
    <biz_error_msg>SUCCESS</biz_error_msg>
    <trace_id>2136014817363904785403457e5504</trace_id>
    <can_retry>false</can_retry>
    <biz_error_code>SUCCESS</biz_error_code>
    <data>
        <send_right_infos>
            <send_right_infos>
                <valid_time_value>&quot;&quot;</valid_time_value>
                <valid_type>&quot;&quot;</valid_type>
                <out_biz_instance_id>&quot;&quot;</out_biz_instance_id>
                <out_template_id>462</out_template_id>
                <act_code>e34byhsqilzkn20j</act_code>
                <right_name>&quot;&quot;</right_name>
                <discount_info>
                    <fixed_price_yuan>&quot;&quot;</fixed_price_yuan>
                    <amount>1</amount>
                    <benefit_type>VIRTUAL_INTEGRAL</benefit_type>
                    <reduction_yuan>0.01</reduction_yuan>
                    <threshold_yuan>&quot;&quot;</threshold_yuan>
                    <threshold>&quot;&quot;</threshold>
                    <reduction>1</reduction>
                    <fixed_price>&quot;&quot;</fixed_price>
                </discount_info>
                <oright_send_record_info>
                    <record_id>2</record_id>
                    <template_provider_id>2</template_provider_id>
                    <template_id>2</template_id>
                    <out_benefit_id>&quot;&quot;</out_benefit_id>
                    <status>&quot;&quot;</status>
                    <result_code>&quot;&quot;</result_code>
                    <result_msg>&quot;&quot;</result_msg>
                    <operate_type>&quot;&quot;</operate_type>
                    <product_code>&quot;&quot;</product_code>
                    <out_template_id>&quot;&quot;</out_template_id>
                    <prize_id>&quot;&quot;</prize_id>
                    <template_name>&quot;&quot;</template_name>
                    <gmt_create>&quot;&quot;</gmt_create>
                </oright_send_record_info>
                <material_info>
                    <title>&quot;&quot;</title>
                    <description>&quot;&quot;</description>
                    <pic>&quot;&quot;</pic>
                    <button_text>&quot;&quot;</button_text>
                    <jump_url>&quot;&quot;</jump_url>
                    <alipay_resource_id>&quot;&quot;</alipay_resource_id>
                </material_info>
                <scene_code>4CA660AU9Q5</scene_code>
                <right_instance_id_str>2501094269844133575</right_instance_id_str>
                <right_id>2403062009314568586</right_id>
                <sub_type>INTEGRAL_PROPERTY</sub_type>
                <user_limit_info>
                    <venue_id>&quot;&quot;</venue_id>
                </user_limit_info>
                <start_time>&quot;&quot;</start_time>
                <end_time>&quot;&quot;</end_time>
                <valid_time_unit>&quot;&quot;</valid_time_unit>
            </send_right_infos>
        </send_right_infos>
        <has_prize>true</has_prize>
    </data>
    <biz_success>true</biz_success>
</alibaba_alsc_growth_interactive_sns_rank_reward_response>

{
    "alibaba_alsc_growth_interactive_sns_rank_reward_response":{
        "biz_error_msg":"SUCCESS",
        "trace_id":"2136014817363904785403457e5504",
        "can_retry":false,
        "biz_error_code":"SUCCESS",
        "data":{
            "send_right_infos":{
                "send_right_infos":[
                    {
                        "valid_time_value":"\"\"",
                        "valid_type":"\"\"",
                        "out_biz_instance_id":"\"\"",
                        "out_template_id":"462",
                        "act_code":"e34byhsqilzkn20j",
                        "right_name":"\"\"",
                        "discount_info":{
                            "fixed_price_yuan":"\"\"",
                            "amount":1,
                            "benefit_type":"VIRTUAL_INTEGRAL",
                            "reduction_yuan":"0.01",
                            "threshold_yuan":"\"\"",
                            "threshold":"\"\"",
                            "reduction":"1",
                            "fixed_price":"\"\""
                        },
                        "oright_send_record_info":{
                            "record_id":2,
                            "template_provider_id":2,
                            "template_id":2,
                            "out_benefit_id":"\"\"",
                            "status":"\"\"",
                            "result_code":"\"\"",
                            "result_msg":"\"\"",
                            "operate_type":"",
                            "product_code":"\"\"",
                            "out_template_id":"\"\"",
                            "prize_id":"\"\"",
                            "template_name":"\"\"",
                            "gmt_create":"\"\""
                        },
                        "material_info":{
                            "title":"\"\"",
                            "description":"\"\"",
                            "pic":"\"\"",
                            "button_text":"\"\"",
                            "jump_url":"\"\"",
                            "alipay_resource_id":"\"\""
                        },
                        "scene_code":"4CA660AU9Q5",
                        "right_instance_id_str":"2501094269844133575",
                        "right_id":"2403062009314568586",
                        "sub_type":"INTEGRAL_PROPERTY",
                        "user_limit_info":{
                            "venue_id":"\"\""
                        },
                        "start_time":"\"\"",
                        "end_time":"\"\"",
                        "valid_time_unit":"\"\""
                    }
                ]
            },
            "has_prize":true
        },
        "biz_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下载

本地生活用户增长互动业务

alibaba.alsc.growth.interactive.sns.rank.reward (指定用户排名发奖接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ