淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
id	Number	可选	22		福利宝id
ext_params	String	可选	{}		扩展参数

名称	类型	示例值	描述
result	Result	{}	接口返回model
└ headers String {} 请求头 └ mapping_code String 1 映射码 model Model {} 福利宝 └ ztc_skin String https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png 直通车背景图 └ win_title String 中奖了中奖标题 └ unlucky_skin String https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png 未中奖背景图 └ title String 恭喜您中奖了标题 └ small_button_unfocus String https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png 小按钮非聚焦图 └ small_button_focus String https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png 小按钮聚焦图 └ safe_code String 1A18924BN5W42UR0PJ9GMZ 安全码 └ rule_info String https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png 活动规则图 └ rule String sdkgamerule 抽奖规则 └ reconfirm_skin String https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png 阻断背景图 └ lottery_button_unfocus String https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png 抽奖按钮非聚焦图 └ lottery_button_focus String https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png 抽奖按钮聚焦图 list ArrayList [] [] 奖项集合 └ url String https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png 奖项图片 └ type String coupon 奖项类型 └ tips String 中了电视淘宝红包中奖提示 └ message String 电视淘宝红包中奖文案 └ game_skin String https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png 福利宝背景图 └ big_button_unfocus String https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png 大按钮非聚焦图 └ big_button_focus String https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png 大按钮聚焦图 └ ext_params String https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png 扩展参数 └ http_status_code Number 12 http状态码 └ biz_ext_map String 1 业务扩展参数 └ msg_code String 1 msgCode └ msg_info String 1 msgInfo └ success Boolean false 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
YunosTvTaoWelfareGamedetailRequest req = new YunosTvTaoWelfareGamedetailRequest();
req.setId(22L);
req.setExtParams("{}");
YunosTvTaoWelfareGamedetailResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
YunosTvTaoWelfareGamedetailRequest req = new YunosTvTaoWelfareGamedetailRequest();
req.Id = 22L;
req.ExtParams = "{}";
YunosTvTaoWelfareGamedetailResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new YunosTvTaoWelfareGamedetailRequest;
$req->setId("22");
$req->setExtParams("{}");
$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=yunos.tv.tao.welfare.gamedetail' \
-d 'partner_id=apidoc' \
-d 'sign=6E98165062D11EBD13C0B36D4F379D5A' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+01%3A13%3A21' \
-d 'v=2.0' \
-d 'ext_params=%7B%7D' \
-d 'id=22'

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

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

req.id=22
req.ext_params="{}"
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,"yunos.tv.tao.welfare.gamedetail");
add_param(pRequest,"id","22");
add_param(pRequest,"ext_params","{}");
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('yunos.tv.tao.welfare.gamedetail', {
	'id':'22',
	'ext_params':'{}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<yunos_tv_tao_welfare_gamedetail_response>
    <result>
        <headers>{}</headers>
        <mapping_code>1</mapping_code>
        <model>
            <ztc_skin>https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png</ztc_skin>
            <win_title>中奖了</win_title>
            <unlucky_skin>https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png</unlucky_skin>
            <title>恭喜您中奖了</title>
            <small_button_unfocus>https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png</small_button_unfocus>
            <small_button_focus>https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png</small_button_focus>
            <safe_code>1A18924BN5W42UR0PJ9GMZ</safe_code>
            <rule_info>https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png</rule_info>
            <rule>sdkgamerule</rule>
            <reconfirm_skin>https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png</reconfirm_skin>
            <lottery_button_unfocus>https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png</lottery_button_unfocus>
            <lottery_button_focus>https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png</lottery_button_focus>
            <list>
                <array_list>
                    <url>https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png</url>
                    <type>coupon</type>
                    <tips>中了电视淘宝红包</tips>
                    <message>电视淘宝红包</message>
                </array_list>
            </list>
            <game_skin>https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png</game_skin>
            <big_button_unfocus>https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png</big_button_unfocus>
            <big_button_focus>https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png</big_button_focus>
            <ext_params>https://img.alicdn.com/tfs/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png</ext_params>
        </model>
        <http_status_code>12</http_status_code>
        <biz_ext_map>1</biz_ext_map>
        <msg_code>1</msg_code>
        <msg_info>1</msg_info>
        <success>false</success>
    </result>
</yunos_tv_tao_welfare_gamedetail_response>

{
    "yunos_tv_tao_welfare_gamedetail_response":{
        "result":{
            "headers":"{}",
            "mapping_code":"1",
            "model":{
                "ztc_skin":"https:\/\/img.alicdn.com\/tfs\/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png",
                "win_title":"中奖了",
                "unlucky_skin":"https:\/\/img.alicdn.com\/tfs\/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png",
                "title":"恭喜您中奖了",
                "small_button_unfocus":"https:\/\/img.alicdn.com\/tfs\/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png",
                "small_button_focus":"https:\/\/img.alicdn.com\/tfs\/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png",
                "safe_code":"1A18924BN5W42UR0PJ9GMZ",
                "rule_info":"https:\/\/img.alicdn.com\/tfs\/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png",
                "rule":"sdkgamerule",
                "reconfirm_skin":"https:\/\/img.alicdn.com\/tfs\/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png",
                "lottery_button_unfocus":"https:\/\/img.alicdn.com\/tfs\/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png",
                "lottery_button_focus":"https:\/\/img.alicdn.com\/tfs\/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png",
                "list":{
                    "array_list":[
                        {
                            "url":"https:\/\/img.alicdn.com\/tfs\/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png",
                            "type":"coupon",
                            "tips":"中了电视淘宝红包",
                            "message":"电视淘宝红包"
                        }
                    ]
                },
                "game_skin":"https:\/\/img.alicdn.com\/tfs\/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png",
                "big_button_unfocus":"https:\/\/img.alicdn.com\/tfs\/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png",
                "big_button_focus":"https:\/\/img.alicdn.com\/tfs\/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png",
                "ext_params":"https:\/\/img.alicdn.com\/tfs\/TB1rgQzB3HqK1RjSZJnXXbNLpXa-417-183.png"
            },
            "http_status_code":12,
            "biz_ext_map":"1",
            "msg_code":"1",
            "msg_info":"1",
            "success":false
        }
    }
}

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

yunos.tv.tao.welfare.gamedetail (福利宝信息获取)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ