淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
alipay_venue_query_param	AlipayVenueQueryParam	可选			参数
└ stress_test Boolean 可选 false 是否压测标 └ s Number 可选 1 页码 └ tabao_user_id Number 可选 2217601543209 淘宝用户id └ live_source String 可选 alipay.venue 直播渠道 └ user_id Number 可选 212313 支付宝用户id └ ttid String 可选 600000@taobao_android_10.39.31 设备信息 └ recommend_rule_code String 可选 11866001 推荐规则 └ n Number 可选 6 个数 └ scene String 可选 alipay.top.anchor top主播 └ exp_info_list String 可选 {"ITEM":"1,2,3","ACCOUNT":"2549841410,407700539"} 曝光参数 └ request_id String 可选 23da32q51 唯一请求id └ anchor_id_list Number [] 可选 63239528 主播id列表

名称	类型	示例值	描述
buiness_code	Number	0	code
data	AlipayVenueResponse		返回结果
alipay_venue_list AlipayVenueDTO [] "[]" 详情 └ live_id Number 1213 直播间id └ account_id Number 13242 主播id live_info LiveInfoDTO 直播间信息 └ room_status Number 1 直播状态 └ stream_status Number 1 流状态 └ title String 直播间标题直播间标题 └ cover_img String https://gw.alicdn.com/tfscom/i3/O1CN01ZHlcAT28vJ91TRJF2_!!2-dgshop.png 直播封面图片 live_url_list LiveUrlDO [] 直播流地址 └ code_level Number 0 编码等级 └ name String 流畅名称 └ flv_url String http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.flv flvUrl └ hls_url String http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8 hlsUrl └ h265_url String http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8 h265Url └ artp_url String http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8 artpUrl └ bfrtc_url String http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8 bfrtcUrl └ live_url_mini_bfrtc String http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8 liveUrlMiniBfrtc └ rtmp_url String http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8 rtmpUrl └ rtc_live_url String http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8 rtcLiveUrl └ definition String hd 清晰度 └ new_definition String hd 清晰度 └ recomm String false 推荐 └ whole_h265_flv_url String http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8 wholeH265FlvUrl └ whole_h265_artp_url String http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8 wholeH265ArtpUrl └ data_tracks String {} 埋点参数 └ view_count_format String 1.2万观看模糊化观看人数 account_info AccountInfoDTO 主播信息 └ account_name String 主播昵称主播昵称 └ account_head_img String //img.alicdn.com/imgextra/i4/201749140/O1CN01sXLxf62HOAZwwtu2a_!!201749140-0-beehive-scenes.jpg 主播头像 item_infos SimpleItemInfo [] 商品信息 └ item_id Number 1233224 商品id └ item_name String 商品标题商品标题 └ item_pic String //gw.alicdn.com/imgextra/O1CN013ROYzS1MHpRnmBAkX_!!2549841410-0-tmg_sticker.jpg 商品主图 └ pure_pic String //gw.alicdn.com/imgextra/O1CN013ROYzS1MHpRnmBAkX_!!2549841410-0-tmg_sticker.jpg 商品场景图 └ white_pic String //gw.alicdn.com/imgextra/O1CN013ROYzS1MHpRnmBAkX_!!2549841410-0-tmg_sticker.jpg 商品白底图 └ promotion_price String 2869 直播券后价 └ item_price String 2869 商品直播价 rec_reason_infos LiveRecReasonDTO [] 推荐理由信息 └ reason_type String right_depositRedRain 推荐理由类型值 └ index Number 1 排序，从小到大 └ content String 500万元定金红包雨瓜分中推荐理由文案 └ start_time Number 1746518160000 开始时间 └ end_time Number 1746539760000 结束时间 └ landing_params String &targetAliveExtendInfo=%7B%22rightConfig%22%3A%7B%22autoShow%22%3Atrue%7D%7D 承接参数
is_success	Boolean	true	调用是否成功
error_message	String	"系统错误"	错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTaobaoLiveRecommendAlipayQueryRequest req = new AlibabaTaobaoLiveRecommendAlipayQueryRequest();
AlibabaTaobaoLiveRecommendAlipayQueryRequest.AlipayVenueQueryParam obj1 = new AlibabaTaobaoLiveRecommendAlipayQueryRequest.AlipayVenueQueryParam();
obj1.setStressTest(false);
obj1.setS(1L);
obj1.setTabaoUserId(2217601543209L);
obj1.setLiveSource("alipay.venue");
obj1.setUserId(212313L);
obj1.setTtid("600000@taobao_android_10.39.31");
obj1.setRecommendRuleCode("11866001");
obj1.setN(6L);
obj1.setScene("alipay.top.anchor");
obj1.setExpInfoList("{\"ITEM\":\"1,2,3\",\"ACCOUNT\":\"2549841410,407700539\"}");
obj1.setRequestId("23da32q51");
obj1.setAnchorIdList(new Long[] { 63239528 };
);
req.setAlipayVenueQueryParam(obj1);
AlibabaTaobaoLiveRecommendAlipayQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaTaobaoLiveRecommendAlipayQueryRequest req = new AlibabaTaobaoLiveRecommendAlipayQueryRequest();
AlibabaTaobaoLiveRecommendAlipayQueryRequest.AlipayVenueQueryParamDomain obj1 = new AlibabaTaobaoLiveRecommendAlipayQueryRequest.AlipayVenueQueryParamDomain();
obj1.StressTest = false;
obj1.S = 1L;
obj1.TabaoUserId = 2217601543209L;
obj1.LiveSource = "alipay.venue";
obj1.UserId = 212313L;
obj1.Ttid = "600000@taobao_android_10.39.31";
obj1.RecommendRuleCode = "11866001";
obj1.N = 6L;
obj1.Scene = "alipay.top.anchor";
obj1.ExpInfoList = "{\"ITEM\":\"1,2,3\",\"ACCOUNT\":\"2549841410,407700539\"}";
obj1.RequestId = "23da32q51";
obj1.AnchorIdList = new long[] { 63239528 };
;
req.AlipayVenueQueryParam_ = obj1;
AlibabaTaobaoLiveRecommendAlipayQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaTaobaoLiveRecommendAlipayQueryRequest;
$alipay_venue_query_param = new AlipayVenueQueryParam;
$alipay_venue_query_param->stress_test="false";
$alipay_venue_query_param->s="1";
$alipay_venue_query_param->tabao_user_id="2217601543209";
$alipay_venue_query_param->live_source="alipay.venue";
$alipay_venue_query_param->user_id="212313";
$alipay_venue_query_param->ttid="600000@taobao_android_10.39.31";
$alipay_venue_query_param->recommend_rule_code="11866001";
$alipay_venue_query_param->n="6";
$alipay_venue_query_param->scene="alipay.top.anchor";
$alipay_venue_query_param->exp_info_list="{\"ITEM\":\"1,2,3\",\"ACCOUNT\":\"2549841410,407700539\"}";
$alipay_venue_query_param->request_id="23da32q51";
$alipay_venue_query_param->anchor_id_list="63239528";
$req->setAlipayVenueQueryParam(json_encode($alipay_venue_query_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.taobao.live.recommend.alipay.query' \
-d 'partner_id=apidoc' \
-d 'sign=3126DDA1184521BB60E878C33193FB73' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-16+21%3A37%3A44' \
-d 'v=2.0' \
-d 'alipay_venue_query_param=null'

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

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

req.alipay_venue_query_param="数据结构示例JSON格式"
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.taobao.live.recommend.alipay.query");
add_param(pRequest,"alipay_venue_query_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.taobao.live.recommend.alipay.query', {
	'alipay_venue_query_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_taobao_live_recommend_alipay_query_response>
    <buiness_code>0</buiness_code>
    <data>
        <alipay_venue_list>
            <alipay_venue_d_t_o>
                <live_id>1213</live_id>
                <account_id>13242</account_id>
                <live_info>
                    <room_status>1</room_status>
                    <stream_status>1</stream_status>
                    <title>直播间标题</title>
                    <cover_img>https://gw.alicdn.com/tfscom/i3/O1CN01ZHlcAT28vJ91TRJF2_!!2-dgshop.png</cover_img>
                    <live_url_list>
                        <live_url_d_o>
                            <code_level>0</code_level>
                            <name>流畅</name>
                            <flv_url>http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.flv</flv_url>
                            <hls_url>http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8</hls_url>
                            <h265_url>http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8</h265_url>
                            <artp_url>http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8</artp_url>
                            <bfrtc_url>http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8</bfrtc_url>
                            <live_url_mini_bfrtc>http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8</live_url_mini_bfrtc>
                            <rtmp_url>http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8</rtmp_url>
                            <rtc_live_url>http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8</rtc_live_url>
                            <definition>hd</definition>
                            <new_definition>hd</new_definition>
                            <recomm>false</recomm>
                            <whole_h265_flv_url>http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8</whole_h265_flv_url>
                            <whole_h265_artp_url>http://livecb.alicdn.com/mediaplatform/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8</whole_h265_artp_url>
                            <data_tracks>{}</data_tracks>
                        </live_url_d_o>
                    </live_url_list>
                    <view_count_format>1.2万观看</view_count_format>
                </live_info>
                <account_info>
                    <account_name>主播昵称</account_name>
                    <account_head_img>//img.alicdn.com/imgextra/i4/201749140/O1CN01sXLxf62HOAZwwtu2a_!!201749140-0-beehive-scenes.jpg</account_head_img>
                </account_info>
                <item_infos>
                    <simple_item_info>
                        <item_id>1233224</item_id>
                        <item_name>商品标题</item_name>
                        <item_pic>//gw.alicdn.com/imgextra/O1CN013ROYzS1MHpRnmBAkX_!!2549841410-0-tmg_sticker.jpg</item_pic>
                        <pure_pic>//gw.alicdn.com/imgextra/O1CN013ROYzS1MHpRnmBAkX_!!2549841410-0-tmg_sticker.jpg</pure_pic>
                        <white_pic>//gw.alicdn.com/imgextra/O1CN013ROYzS1MHpRnmBAkX_!!2549841410-0-tmg_sticker.jpg</white_pic>
                        <promotion_price>2869</promotion_price>
                        <item_price>2869</item_price>
                    </simple_item_info>
                </item_infos>
                <rec_reason_infos>
                    <live_rec_reason_d_t_o>
                        <reason_type>right_depositRedRain</reason_type>
                        <index>1</index>
                        <content>500万元定金红包雨瓜分中</content>
                        <start_time>1746518160000</start_time>
                        <end_time>1746539760000</end_time>
                        <landing_params>&amp;targetAliveExtendInfo=%7B%22rightConfig%22%3A%7B%22autoShow%22%3Atrue%7D%7D</landing_params>
                    </live_rec_reason_d_t_o>
                </rec_reason_infos>
            </alipay_venue_d_t_o>
        </alipay_venue_list>
    </data>
    <is_success>true</is_success>
    <error_message>&quot;系统错误&quot;</error_message>
</alibaba_taobao_live_recommend_alipay_query_response>

{
    "alibaba_taobao_live_recommend_alipay_query_response":{
        "buiness_code":0,
        "data":{
            "alipay_venue_list":{
                "alipay_venue_d_t_o":[
                    {
                        "live_id":1213,
                        "account_id":13242,
                        "live_info":{
                            "room_status":1,
                            "stream_status":1,
                            "title":"直播间标题",
                            "cover_img":"https:\/\/gw.alicdn.com\/tfscom\/i3\/O1CN01ZHlcAT28vJ91TRJF2_!!2-dgshop.png",
                            "live_url_list":{
                                "live_url_d_o":[
                                    {
                                        "code_level":0,
                                        "name":"流畅",
                                        "flv_url":"http:\/\/livecb.alicdn.com\/mediaplatform\/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.flv",
                                        "hls_url":"http:\/\/livecb.alicdn.com\/mediaplatform\/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8",
                                        "h265_url":"http:\/\/livecb.alicdn.com\/mediaplatform\/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8",
                                        "artp_url":"http:\/\/livecb.alicdn.com\/mediaplatform\/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8",
                                        "bfrtc_url":"http:\/\/livecb.alicdn.com\/mediaplatform\/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8",
                                        "live_url_mini_bfrtc":"http:\/\/livecb.alicdn.com\/mediaplatform\/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8",
                                        "rtmp_url":"http:\/\/livecb.alicdn.com\/mediaplatform\/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8",
                                        "rtc_live_url":"http:\/\/livecb.alicdn.com\/mediaplatform\/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8",
                                        "definition":"hd",
                                        "new_definition":"hd",
                                        "recomm":"false",
                                        "whole_h265_flv_url":"http:\/\/livecb.alicdn.com\/mediaplatform\/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8",
                                        "whole_h265_artp_url":"http:\/\/livecb.alicdn.com\/mediaplatform\/1424d3d5-4de2-4bff-b4eb-48baeb5c23a3_liveng-360p.m3u8",
                                        "data_tracks":"{}"
                                    }
                                ]
                            },
                            "view_count_format":"1.2万观看"
                        },
                        "account_info":{
                            "account_name":"主播昵称",
                            "account_head_img":"\/\/img.alicdn.com\/imgextra\/i4\/201749140\/O1CN01sXLxf62HOAZwwtu2a_!!201749140-0-beehive-scenes.jpg"
                        },
                        "item_infos":{
                            "simple_item_info":[
                                {
                                    "item_id":1233224,
                                    "item_name":"商品标题",
                                    "item_pic":"\/\/gw.alicdn.com\/imgextra\/O1CN013ROYzS1MHpRnmBAkX_!!2549841410-0-tmg_sticker.jpg",
                                    "pure_pic":"\/\/gw.alicdn.com\/imgextra\/O1CN013ROYzS1MHpRnmBAkX_!!2549841410-0-tmg_sticker.jpg",
                                    "white_pic":"\/\/gw.alicdn.com\/imgextra\/O1CN013ROYzS1MHpRnmBAkX_!!2549841410-0-tmg_sticker.jpg",
                                    "promotion_price":"2869",
                                    "item_price":"2869"
                                }
                            ]
                        },
                        "rec_reason_infos":{
                            "live_rec_reason_d_t_o":[
                                {
                                    "reason_type":"right_depositRedRain",
                                    "index":1,
                                    "content":"500万元定金红包雨瓜分中",
                                    "start_time":1746518160000,
                                    "end_time":1746539760000,
                                    "landing_params":"&targetAliveExtendInfo=%7B%22rightConfig%22%3A%7B%22autoShow%22%3Atrue%7D%7D"
                                }
                            ]
                        }
                    }
                ]
            }
        },
        "is_success":true,
        "error_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.taobao.live.recommend.alipay.query (支付宝直播会场数据查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ