淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
request_param	BoxOfficeIndexRequest	可选			系统自动生成
└ city_id Number 可选 -5 城市id └ device_id String 可选 X7jJ7bKYxfEDAH7qRhTrbfdC 设备编码 date_query DateQuery 必须系统自动生成 └ begin_date String 可选 20210112 开始时间 └ date_type Number 可选 1 日票房 └ end_date String 可选 20210113 结束时间 └ utdid String 可选 +XtOer9XgUDAFDWJHdfxK7N 设备标识 ID └ version String 可选客户端版本 5.2.2 └ ttid String 可选 movie_pro ttid └ client_ip String 可选 192.167.1.1 客户端ip

名称	类型	示例值	描述
result	PlainResult		返回
└ trace_id String trace_id 鹰眼id └ code String hello world 返回码 data BoxOfficeIndexVo data 数据 show_data_item_v_o_list Showdataitemvolist [] 票房和影片 box_office_data_item BoxOfficeDataItemVo 票房数据 └ box_office Number 20000 今日票房 └ schedule_rate String 50 排片占比 └ total_box_office Number 40000 总票房 total_box_office_with_unit DataWithUnit 4.5万格式化总后票房 └ value String 1.0 数值 └ unit String 元元 schedule_rate_with_unit DataWithUnit 33% 排片占比 └ value String 1.0 数值 └ unit String 元元 box_office_with_unit DataWithUnit 1.2万格式化后票房 └ value String 1.0 数值 └ unit String 元元 └ show_name String 送你一朵小红花影片名称 └ show_id Number 333143 影片id └ host_url String http://dengta.com/detail.html?showId=1 影片详情页地址 └ box_office Number 20000 今日票房 box_office_with_unit DataWithUnit 45万格式化总后票房 └ unit String 元元 └ value String 1.0 数值 └ latest_refresh_ts Number 123978634 最新时间戳 └ show_error Number show_error 展示错误信息 └ success Boolean false 是否成功 └ error_message String error_message error_message └ message String hello world 消息 └ ts Number ts 毫秒数 extra Extra 降级属性 └ downgrade_message String 暂无数据更新降级提示语

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaPicturesDengtaComponentBoxofficeRequest req = new AlibabaPicturesDengtaComponentBoxofficeRequest();
AlibabaPicturesDengtaComponentBoxofficeRequest.BoxOfficeIndexRequest obj1 = new AlibabaPicturesDengtaComponentBoxofficeRequest.BoxOfficeIndexRequest();
obj1.setCityId(-5L);
obj1.setDeviceId("X7jJ7bKYxfEDAH7qRhTrbfdC");
AlibabaPicturesDengtaComponentBoxofficeRequest.DateQuery obj2 = new AlibabaPicturesDengtaComponentBoxofficeRequest.DateQuery();
obj2.setBeginDate("20210112");
obj2.setDateType(1L);
obj2.setEndDate("20210113");
obj1.setDateQuery(obj2);
obj1.setUtdid("+XtOer9XgUDAFDWJHdfxK7N");
obj1.setVersion("客户端版本");
obj1.setTtid("movie_pro");
obj1.setClientIp("192.167.1.1");
req.setRequestParam(obj1);
AlibabaPicturesDengtaComponentBoxofficeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaPicturesDengtaComponentBoxofficeRequest req = new AlibabaPicturesDengtaComponentBoxofficeRequest();
AlibabaPicturesDengtaComponentBoxofficeRequest.BoxOfficeIndexRequestDomain obj1 = new AlibabaPicturesDengtaComponentBoxofficeRequest.BoxOfficeIndexRequestDomain();
obj1.CityId = -5L;
obj1.DeviceId = "X7jJ7bKYxfEDAH7qRhTrbfdC";
AlibabaPicturesDengtaComponentBoxofficeRequest.DateQueryDomain obj2 = new AlibabaPicturesDengtaComponentBoxofficeRequest.DateQueryDomain();
obj2.BeginDate = "20210112";
obj2.DateType = 1L;
obj2.EndDate = "20210113";
obj1.DateQuery= obj2;
obj1.Utdid = "+XtOer9XgUDAFDWJHdfxK7N";
obj1.Version = "客户端版本";
obj1.Ttid = "movie_pro";
obj1.ClientIp = "192.167.1.1";
req.RequestParam_ = obj1;
AlibabaPicturesDengtaComponentBoxofficeResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaPicturesDengtaComponentBoxofficeRequest;
$request_param = new BoxOfficeIndexRequest;
$request_param->city_id="-5";
$request_param->device_id="X7jJ7bKYxfEDAH7qRhTrbfdC";
$date_query = new DateQuery;
$date_query->begin_date="20210112";
$date_query->date_type="1";
$date_query->end_date="20210113";
$request_param->date_query = $date_query;
$request_param->utdid="+XtOer9XgUDAFDWJHdfxK7N";
$request_param->version="客户端版本";
$request_param->ttid="movie_pro";
$request_param->client_ip="192.167.1.1";
$req->setRequestParam(json_encode($request_param));
$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.pictures.dengta.component.boxoffice' \
-d 'partner_id=apidoc' \
-d 'sign=A0299B39749E7ECA6BB9AA7C8DC40E17' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+15%3A33%3A19' \
-d 'v=2.0' \
-d 'request_param=null'

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

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

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

XML示例
JSON示例

<alibaba_pictures_dengta_component_boxoffice_response>
    <result>
        <trace_id>trace_id</trace_id>
        <code>hello world</code>
        <data>
            <show_data_item_v_o_list>
                <showdataitemvolist>
                    <box_office_data_item>
                        <box_office>20000</box_office>
                        <schedule_rate>50</schedule_rate>
                        <total_box_office>40000</total_box_office>
                        <total_box_office_with_unit>
                            <value>1.0</value>
                            <unit>元</unit>
                        </total_box_office_with_unit>
                        <schedule_rate_with_unit>
                            <value>1.0</value>
                            <unit>元</unit>
                        </schedule_rate_with_unit>
                        <box_office_with_unit>
                            <value>1.0</value>
                            <unit>元</unit>
                        </box_office_with_unit>
                    </box_office_data_item>
                    <show_name>送你一朵小红花</show_name>
                    <show_id>333143</show_id>
                    <host_url>http://dengta.com/detail.html?showId=1</host_url>
                </showdataitemvolist>
            </show_data_item_v_o_list>
            <box_office>20000</box_office>
            <box_office_with_unit>
                <unit>元</unit>
                <value>1.0</value>
            </box_office_with_unit>
            <latest_refresh_ts>123978634</latest_refresh_ts>
        </data>
        <show_error>show_error</show_error>
        <success>false</success>
        <error_message>error_message</error_message>
        <message>hello world</message>
        <ts>ts</ts>
        <extra>
            <downgrade_message>暂无数据更新</downgrade_message>
        </extra>
    </result>
</alibaba_pictures_dengta_component_boxoffice_response>

{
    "alibaba_pictures_dengta_component_boxoffice_response":{
        "result":{
            "trace_id":"trace_id",
            "code":"hello world",
            "data":{
                "show_data_item_v_o_list":{
                    "showdataitemvolist":[
                        {
                            "box_office_data_item":{
                                "box_office":20000,
                                "schedule_rate":"50",
                                "total_box_office":40000,
                                "total_box_office_with_unit":{
                                    "value":"1.0",
                                    "unit":"元"
                                },
                                "schedule_rate_with_unit":{
                                    "value":"1.0",
                                    "unit":"元"
                                },
                                "box_office_with_unit":{
                                    "value":"1.0",
                                    "unit":"元"
                                }
                            },
                            "show_name":"送你一朵小红花",
                            "show_id":333143,
                            "host_url":"http:\/\/dengta.com\/detail.html?showId=1"
                        }
                    ]
                },
                "box_office":20000,
                "box_office_with_unit":{
                    "unit":"元",
                    "value":"1.0"
                },
                "latest_refresh_ts":123978634
            },
            "show_error":show_error,
            "success":false,
            "error_message":"error_message",
            "message":"hello world",
            "ts":ts,
            "extra":{
                "downgrade_message":"暂无数据更新"
            }
        }
    }
}

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.pictures.dengta.component.boxoffice (IOS票房小组件)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ