淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
offset	Number	可选	0	默认值：0	偏移量
page_size	Number	可选	20	默认值：20	数量
show_id	String	可选	－		节目id

名称	类型	示例值	描述
result	Result	-	result
└ code String SUCCESS code └ detail_message String - detailMessage └ message String 成功 message └ success Boolean true success value VideoPageResult - 数据列表 └ has_next_page Boolean true 是否有下一页视频 └ offset Number 76892 当前最大偏移量 video_list Video [] - 视频列表 └ category String 电影视频主分类 └ definition_list String [] ["DEF_NORMAL","DEF_HIGH","DEF_SUPER"] 清晰度列表，DEF_FLUENCY=流畅清晰度，DEF_NORMAL=普通清晰度，DEF_HIGH=高清清晰度，DEF_SUPER=超清/720P清晰度，DEF_FHD=超高清/1080P清晰度，DEF_4K=4K清晰度 └ description String 描述信息描述 └ duration String 120 视频时长(秒) └ language_list String [] 国语语言列表 └ license_list String [] CIBN 牌照列表 └ paid Number 0 是否收费，1=收费，0=免费 └ panorama Boolean false 是否全景 └ rc_title String - 推荐标题 └ release_date String 2016-10-01 00:00:00 发行日期 └ sequence String 1 节目中视频的顺序 └ show_id String cbf9ff68962411de83b1 节目id └ small_thumb_url String http://r4.ykimg.com/0542040850F5600E6A0A4364D75D7F74 海报缩略图 └ source_type String YOUKU 视频来源 └ status String 发布数娱视频状态 └ thumb_url String http://r4.ykimg.com/0542040850F5600E6A0A4364D75D7F74 海报 └ title String 《边界布鲁斯》高清预告片标题 └ video_id String XMzEzOTI3NjY0 视频id └ video_stage Number 1 期号、集号 └ video_type String 正片视频类型（正片、预告片等） └ web_url String http://v.youku.com/v_show/id_XMzEzOTI3NjY0.html 优酷PC主站地址 └ play_feature Number 491520 支持的视频流，是二进制的组合 └ live_info String 12321 直播间属性 └ drm Number 1 0:不是drm，1：drm └ vertical_style Boolean false 是否是竖版视频 └ pay_type_list String [] ["mon"] 视频的付费信息 └ show_version_type_list String [] 节目视频版本类型列表包含的值：默认版,标准解说版,拆条版,方言解说版,独家版,番外版,花式解说版,加时赛拆条,精编版,先导片,小节拆条

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
VmacVideopageGetRequest req = new VmacVideopageGetRequest();
req.setOffset(0L);
req.setPageSize(20L);
req.setShowId("－");
VmacVideopageGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
VmacVideopageGetRequest req = new VmacVideopageGetRequest();
req.Offset = 0L;
req.PageSize = 20L;
req.ShowId = "－";
VmacVideopageGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new VmacVideopageGetRequest;
$req->setOffset("0");
$req->setPageSize("20");
$req->setShowId("－");
$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=taobao.vmac.videopage.get' \
-d 'partner_id=apidoc' \
-d 'sign=EC9893F41B3C4765BA67074BAF7E02DC' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+16%3A42%3A34' \
-d 'v=2.0' \
-d 'offset=0' \
-d 'page_size=20' \
-d 'show_id=%EF%BC%8D'

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

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

req.offset=0
req.page_size=20
req.show_id="－"
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,"taobao.vmac.videopage.get");
add_param(pRequest,"offset","0");
add_param(pRequest,"page_size","20");
add_param(pRequest,"show_id","－");
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('taobao.vmac.videopage.get', {
	'offset':'0',
	'page_size':'20',
	'show_id':'－'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<vmac_videopage_get_response>
    <result>
        <code>SUCCESS</code>
        <detail_message>-</detail_message>
        <message>成功</message>
        <success>true</success>
        <value>
            <has_next_page>true</has_next_page>
            <offset>76892</offset>
            <video_list>
                <video>
                    <category>电影</category>
                    <definition_list>
                        <string>[&quot;DEF_NORMAL&quot;</string>
                        <string>&quot;DEF_HIGH&quot;</string>
                        <string>&quot;DEF_SUPER&quot;]</string>
                    </definition_list>
                    <description>描述信息</description>
                    <duration>120</duration>
                    <language_list>
                        <string>国语</string>
                    </language_list>
                    <license_list>
                        <string>CIBN</string>
                    </license_list>
                    <paid>0</paid>
                    <panorama>false</panorama>
                    <rc_title>-</rc_title>
                    <release_date>2016-10-01 00:00:00</release_date>
                    <sequence>1</sequence>
                    <show_id>cbf9ff68962411de83b1</show_id>
                    <small_thumb_url>http://r4.ykimg.com/0542040850F5600E6A0A4364D75D7F74</small_thumb_url>
                    <source_type>YOUKU</source_type>
                    <status>发布</status>
                    <thumb_url>http://r4.ykimg.com/0542040850F5600E6A0A4364D75D7F74</thumb_url>
                    <title>《边界布鲁斯》高清预告片</title>
                    <video_id>XMzEzOTI3NjY0</video_id>
                    <video_stage>1</video_stage>
                    <video_type>正片</video_type>
                    <web_url>http://v.youku.com/v_show/id_XMzEzOTI3NjY0.html</web_url>
                    <play_feature>491520</play_feature>
                    <live_info>12321</live_info>
                    <drm>1</drm>
                    <vertical_style>false</vertical_style>
                    <pay_type_list>
                        <string>[&quot;mon&quot;]</string>
                    </pay_type_list>
                </video>
            </video_list>
        </value>
    </result>
</vmac_videopage_get_response>

{
    "vmac_videopage_get_response":{
        "result":{
            "code":"SUCCESS",
            "detail_message":"-",
            "message":"成功",
            "success":true,
            "value":{
                "has_next_page":true,
                "offset":76892,
                "video_list":{
                    "video":[
                        {
                            "category":"电影",
                            "definition_list":{
                                "string":[
                                    "[\"DEF_NORMAL\"",
                                    "\"DEF_HIGH\"",
                                    "\"DEF_SUPER\"]"
                                ]
                            },
                            "description":"描述信息",
                            "duration":"120",
                            "language_list":{
                                "string":[
                                    "国语"
                                ]
                            },
                            "license_list":{
                                "string":[
                                    "CIBN"
                                ]
                            },
                            "paid":0,
                            "panorama":false,
                            "rc_title":"-",
                            "release_date":"2016-10-01 00:00:00",
                            "sequence":"1",
                            "show_id":"cbf9ff68962411de83b1",
                            "small_thumb_url":"http:\/\/r4.ykimg.com\/0542040850F5600E6A0A4364D75D7F74",
                            "source_type":"YOUKU",
                            "status":"发布",
                            "thumb_url":"http:\/\/r4.ykimg.com\/0542040850F5600E6A0A4364D75D7F74",
                            "title":"《边界布鲁斯》高清预告片",
                            "video_id":"XMzEzOTI3NjY0",
                            "video_stage":1,
                            "video_type":"正片",
                            "web_url":"http:\/\/v.youku.com\/v_show\/id_XMzEzOTI3NjY0.html",
                            "play_feature":491520,
                            "live_info":"12321",
                            "drm":1,
                            "vertical_style":false,
                            "pay_type_list":{
                                "string":[
                                    "[\"mon\"]"
                                ]
                            }
                        }
                    ]
                }
            }
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
SHOW_UNAVAILABLE	节目不可用	下线该节目。
SYSTEM_ERROR	系统错误	请联系家庭娱乐媒资开发，并提供错误信息排查。

API测试工具错误码查询工具 SDK下载

开放平台

数娱媒资输出

taobao.vmac.videopage.get (视频分页数据输出)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ