淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param_top_update_activity_lottery_info_param	TopUpdateActivityLotteryInfoParam	必须			入参
└ activity_biz_id String 必须 6776 商家通过isv创建的活动id └ app_key String 必须 2222222 isv的appkey └ banner_url String 必须 http://xxx.play.m.jaeapp.com 可随意传，目前没有用到，扩展字段 └ benefit_amount String 必须 100 商家创建的红包总额 └ benefit_attribute String 必须 xx 可随意传，目前没有用到，扩展字段 └ benefit_denomination Number 必须 1 商家创建的红包面额 └ benefit_id Number 必须 111 商家选择使用的红包权益id └ benefit_type String 必须 1 目前填1，代表支付宝红包 └ biz_type String 必须 4 目前必须填4，代表互动城 └ end_time Date 必须 2015-12-31 14:39:08 商家创建的isv活动的结束时间 └ lottery_activity_end_date Number 必须 4444444 抽奖活动开始时间，long型 └ lottery_activity_start_date Number 必须 4444444 抽奖活动结束时间 └ name String 必须抽奖活动名称抽奖活动名称 └ prize_ext_attribute String 必须 xxx 奖品扩展字段 └ prize_name String 必须奖品名称 1元红包 └ prize_param_attribute String 必须 xxx 奖品扩展字段 └ prize_quantity String 必须 100 奖品总数 └ prize_remain_quantity String 必须 100 奖品总数 └ prize_type String 必须 1 必须填1，代表红包 └ probability String 必须 0.9 0～1之间，代表奖池的概率 └ win_permission_activity_count Number 必须 10 用户活动期间总共中奖次数限制 └ win_permission_day_count Number 必须 10 用户每天总共中奖次数限制 └ start_time Date 必须 2015-12-31 14:39:08 商家创建的isv活动的开始时间

名称	类型	示例值	描述
result	Result	xx	接口返回model
data ActivityLotteryWriteResult xx 返回的数据 └ activity_id Number 12 isv活动的id └ h5_url String http://xxx isv活动url └ err_code String -101 错误码 └ err_msg String 抽奖活动创建失败错误信息 module_map Modulemap xxx xxx └ empty Boolean false false └ success Boolean false 注册抽奖活动失败 └ trace_id String 1234 方便追踪请求的唯一标识

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaInteractLotteryactivityRegisterRequest req = new AlibabaInteractLotteryactivityRegisterRequest();
AlibabaInteractLotteryactivityRegisterRequest.TopUpdateActivityLotteryInfoParam obj1 = new AlibabaInteractLotteryactivityRegisterRequest.TopUpdateActivityLotteryInfoParam();
obj1.setActivityBizId("6776");
obj1.setAppKey("2222222");
obj1.setBannerUrl("http://xxx.play.m.jaeapp.com");
obj1.setBenefitAmount("100");
obj1.setBenefitAttribute("xx");
obj1.setBenefitDenomination(1L);
obj1.setBenefitId(111L);
obj1.setBenefitType("1");
obj1.setBizType("4");
obj1.setEndTime(StringUtils.parseDateTime("2015-12-31 14:39:08"));
obj1.setLotteryActivityEndDate(4444444L);
obj1.setLotteryActivityStartDate(4444444L);
obj1.setName("抽奖活动名称");
obj1.setPrizeExtAttribute("xxx");
obj1.setPrizeName("奖品名称");
obj1.setPrizeParamAttribute("xxx");
obj1.setPrizeQuantity("100");
obj1.setPrizeRemainQuantity("100");
obj1.setPrizeType("1");
obj1.setProbability("0.9");
obj1.setWinPermissionActivityCount(10L);
obj1.setWinPermissionDayCount(10L);
obj1.setStartTime(StringUtils.parseDateTime("2015-12-31 14:39:08"));
req.setParamTopUpdateActivityLotteryInfoParam(obj1);
AlibabaInteractLotteryactivityRegisterResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaInteractLotteryactivityRegisterRequest req = new AlibabaInteractLotteryactivityRegisterRequest();
AlibabaInteractLotteryactivityRegisterRequest.TopUpdateActivityLotteryInfoParamDomain obj1 = new AlibabaInteractLotteryactivityRegisterRequest.TopUpdateActivityLotteryInfoParamDomain();
obj1.ActivityBizId = "6776";
obj1.AppKey = "2222222";
obj1.BannerUrl = "http://xxx.play.m.jaeapp.com";
obj1.BenefitAmount = "100";
obj1.BenefitAttribute = "xx";
obj1.BenefitDenomination = 1L;
obj1.BenefitId = 111L;
obj1.BenefitType = "1";
obj1.BizType = "4";
obj1.EndTime = DateTime.Parse(2015-12-31 14:39:08");
obj1.LotteryActivityEndDate = 4444444L;
obj1.LotteryActivityStartDate = 4444444L;
obj1.Name = "抽奖活动名称";
obj1.PrizeExtAttribute = "xxx";
obj1.PrizeName = "奖品名称";
obj1.PrizeParamAttribute = "xxx";
obj1.PrizeQuantity = "100";
obj1.PrizeRemainQuantity = "100";
obj1.PrizeType = "1";
obj1.Probability = "0.9";
obj1.WinPermissionActivityCount = 10L;
obj1.WinPermissionDayCount = 10L;
obj1.StartTime = DateTime.Parse(2015-12-31 14:39:08");
req.ParamTopUpdateActivityLotteryInfoParam_ = obj1;
AlibabaInteractLotteryactivityRegisterResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaInteractLotteryactivityRegisterRequest;
$param_top_update_activity_lottery_info_param = new TopUpdateActivityLotteryInfoParam;
$param_top_update_activity_lottery_info_param->activity_biz_id="6776";
$param_top_update_activity_lottery_info_param->app_key="2222222";
$param_top_update_activity_lottery_info_param->banner_url="http://xxx.play.m.jaeapp.com";
$param_top_update_activity_lottery_info_param->benefit_amount="100";
$param_top_update_activity_lottery_info_param->benefit_attribute="xx";
$param_top_update_activity_lottery_info_param->benefit_denomination="1";
$param_top_update_activity_lottery_info_param->benefit_id="111";
$param_top_update_activity_lottery_info_param->benefit_type="1";
$param_top_update_activity_lottery_info_param->biz_type="4";
$param_top_update_activity_lottery_info_param->end_time="2015-12-31 14:39:08";
$param_top_update_activity_lottery_info_param->lottery_activity_end_date="4444444";
$param_top_update_activity_lottery_info_param->lottery_activity_start_date="4444444";
$param_top_update_activity_lottery_info_param->name="抽奖活动名称";
$param_top_update_activity_lottery_info_param->prize_ext_attribute="xxx";
$param_top_update_activity_lottery_info_param->prize_name="奖品名称";
$param_top_update_activity_lottery_info_param->prize_param_attribute="xxx";
$param_top_update_activity_lottery_info_param->prize_quantity="100";
$param_top_update_activity_lottery_info_param->prize_remain_quantity="100";
$param_top_update_activity_lottery_info_param->prize_type="1";
$param_top_update_activity_lottery_info_param->probability="0.9";
$param_top_update_activity_lottery_info_param->win_permission_activity_count="10";
$param_top_update_activity_lottery_info_param->win_permission_day_count="10";
$param_top_update_activity_lottery_info_param->start_time="2015-12-31 14:39:08";
$req->setParamTopUpdateActivityLotteryInfoParam(json_encode($param_top_update_activity_lottery_info_param));
$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.interact.lotteryactivity.register' \
-d 'partner_id=apidoc' \
-d 'session=134a5213-4068-48a4-bf44-fda84840d6e7' \
-d 'sign=5FC8F082682D85832AC75723B860EDD9' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-17+13%3A20%3A30' \
-d 'v=2.0' \
-d 'param_top_update_activity_lottery_info_param=null'

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

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

req.param_top_update_activity_lottery_info_param=""
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.interact.lotteryactivity.register");
add_param(pRequest,"param_top_update_activity_lottery_info_param","数据结构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.interact.lotteryactivity.register', {
	'param_top_update_activity_lottery_info_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_interact_lotteryactivity_register_response>
    <result>
        <data>
            <activity_id>12</activity_id>
            <h5_url>http://xxx</h5_url>
        </data>
        <err_code>-101</err_code>
        <err_msg>抽奖活动创建失败</err_msg>
        <module_map>
            <empty>false</empty>
        </module_map>
        <success>false</success>
        <trace_id>1234</trace_id>
    </result>
</alibaba_interact_lotteryactivity_register_response>

{
    "alibaba_interact_lotteryactivity_register_response":{
        "result":{
            "data":{
                "activity_id":12,
                "h5_url":"http:\/\/xxx"
            },
            "err_code":"-101",
            "err_msg":"抽奖活动创建失败",
            "module_map":{
                "empty":false
            },
            "success":false,
            "trace_id":"1234"
        }
    }
}

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.interact.lotteryactivity.register (回传抽奖相关参数)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ