淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
ext_params	String	可选	{}	扩展参数
banner_id	String	可选	123	banner 数据库主键
outer_program_name	String	可选	西游记	外部节目名
appkey	String	可选	123	渠道号
outer_program_id	String	可选	233	外部节目id
log_ext	String	可选	{"version":"2.2.0"}	日志扩展参数，比如版本，来源

名称	类型	示例值	描述
result	Result		接口返回model
└ headers String {} 返回头部，mtop可用，一般用于指定是否缓存 └ mapping_code String SUCESS 映射编码 model TvbuyBannerScheduleDo 134523^4351232 model └ id Number 123 banner 的数据库主键 └ title String 小游戏 banner的标题 └ pic String http://xx.jpg banner图地址 └ type String topics 指定这个banner关联的业务类型 └ business_id String 123 业务id └ banner_type String base banner类型，打底或者热门 └ uri String /topics/id 用于给客户端解析的uri └ http_status_code Number 200 http请求状态 └ biz_ext_map String {} 业务扩展参数 └ msg_code String 1 接口返回提示编码 └ msg_info String 1 接口返回提示 └ success Boolean false 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
YunosTvTaoTvbuyvodGetBannerInfoRequest req = new YunosTvTaoTvbuyvodGetBannerInfoRequest();
req.setExtParams("{}");
req.setBannerId("123");
req.setOuterProgramName("西游记");
req.setAppkey("123");
req.setOuterProgramId("233");
req.setLogExt("{\"version\":\"2.2.0\"}");
YunosTvTaoTvbuyvodGetBannerInfoResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
YunosTvTaoTvbuyvodGetBannerInfoRequest req = new YunosTvTaoTvbuyvodGetBannerInfoRequest();
req.ExtParams = "{}";
req.BannerId = "123";
req.OuterProgramName = "西游记";
req.Appkey = "123";
req.OuterProgramId = "233";
req.LogExt = "{\"version\":\"2.2.0\"}";
YunosTvTaoTvbuyvodGetBannerInfoResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new YunosTvTaoTvbuyvodGetBannerInfoRequest;
$req->setExtParams("{}");
$req->setBannerId("123");
$req->setOuterProgramName("西游记");
$req->setAppkey("123");
$req->setOuterProgramId("233");
$req->setLogExt("{\"version\":\"2.2.0\"}");
$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=yunos.tv.tao.tvbuyvod.get.banner.info' \
-d 'partner_id=apidoc' \
-d 'session=fa464800-ea2f-43de-8955-5c9d2d75f347' \
-d 'sign=3F4E165536711C42136F146A775EC664' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+16%3A17%3A47' \
-d 'v=2.0' \
-d 'appkey=123' \
-d 'banner_id=123' \
-d 'ext_params=%7B%7D' \
-d 'log_ext=%7B%5C%22version%5C%22%3A%5C%222.2.0%5C%22%7D' \
-d 'outer_program_id=233' \
-d 'outer_program_name=%E8%A5%BF%E6%B8%B8%E8%AE%B0'

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

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

req.ext_params="{}"
req.banner_id="123"
req.outer_program_name="西游记"
req.appkey="123"
req.outer_program_id="233"
req.log_ext="{\"version\":\"2.2.0\"}"
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,"yunos.tv.tao.tvbuyvod.get.banner.info");
add_param(pRequest,"ext_params","{}");
add_param(pRequest,"banner_id","123");
add_param(pRequest,"outer_program_name","西游记");
add_param(pRequest,"appkey","123");
add_param(pRequest,"outer_program_id","233");
add_param(pRequest,"log_ext","{\"version\":\"2.2.0\"}");
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('yunos.tv.tao.tvbuyvod.get.banner.info', {
	'ext_params':'{}',
	'banner_id':'123',
	'outer_program_name':'西游记',
	'appkey':'123',
	'outer_program_id':'233',
	'log_ext':'{\"version\":\"2.2.0\"}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<yunos_tv_tao_tvbuyvod_get_banner_info_response>
    <result>
        <headers>{}</headers>
        <mapping_code>SUCESS</mapping_code>
        <model>
            <id>123</id>
            <title>小游戏</title>
            <pic>http://xx.jpg</pic>
            <type>topics</type>
            <business_id>123</business_id>
            <banner_type>base</banner_type>
            <uri>/topics/id</uri>
        </model>
        <http_status_code>200</http_status_code>
        <biz_ext_map>{}</biz_ext_map>
        <msg_code>1</msg_code>
        <msg_info>1</msg_info>
        <success>false</success>
    </result>
</yunos_tv_tao_tvbuyvod_get_banner_info_response>

{
    "yunos_tv_tao_tvbuyvod_get_banner_info_response":{
        "result":{
            "headers":"{}",
            "mapping_code":"SUCESS",
            "model":{
                "id":123,
                "title":"小游戏",
                "pic":"http:\/\/xx.jpg",
                "type":"topics",
                "business_id":"123",
                "banner_type":"base",
                "uri":"\/topics\/id"
            },
            "http_status_code":200,
            "biz_ext_map":"{}",
            "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.tvbuyvod.get.banner.info (获取banner信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ