淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param_list	String []	可选	1	最大列表长度：999	直播间id集合
param_live_room_read_option_request	LiveRoomReadOptionRequest	可选			系统自动生成
└ include_anchor_type Boolean 可选 false 是否包含主播身份 └ include_statistic Boolean 可选 false 是否包含统计数据，只有指定true才会返回下文的statistic信息 └ include_stream_info Boolean 可选 false 是否包含流信息，只有指定true才会返回下文的stream信息 └ pool_id Number 可选 1 1 └ use_cache Boolean 可选 false 是否走缓存

名称	类型	示例值	描述
result	LiveRoomResponse		返回参数
live_room_dto_list LiveRoomDto [] 返回参数 └ anchor_id Number s 主播ID └ anchor_logo String a 主播logo └ anchor_nick String a 主播昵称 └ anchor_type String 1 主播身份判断优先级只取一个 └ anchor_types String [] 主播所有身份 shop， daren └ cover16x9_url String 1 16x9封面链接 └ cover1x1_url String 1 1x1封面链接 └ cover9x16_url String 1 9x16封面图 feature Feature 1 业务方扩展字段 └ empty Boolean 1 返回参数 └ id Number 1 直播内容Id └ item_ids Number [] 直播间商品ID列表 └ land_scape Boolean false 是否横屏 └ live_appointment_time Date 2023-03-20 12:00:00 返回参数 └ live_channel_id Number 1 直播频道id └ live_column_id Number 1 直播栏目id └ live_end_time Date 2023-03-20 12:00:00 直播结束时间 └ live_room_status Number 1 直播间状态：0=预告，1=直播中，2=直播结束（回放 └ live_start_time Date 2023-03-20 12:00:00 直播开始时间 └ live_uuid String 1 直播间唯一标识 └ location String 1 直播地理位置 └ pre_video_id String 1 预告视频ID └ pre_video_url String 1 预告视频播放地址 statistic StatisticDto 统计信息 └ praise_count Number 1 点赞次数 └ pv_count Number 1 观看次数 └ status Number 1 直播内容状态：0=正常，-1=用户删除，-2=小二删除 stream StreamDto 流信息 └ input_code_level Number 1 推流码率 └ input_stream_url String 1 推流地址 └ live_h_l_s_url String 1 原始HLS直播地址 └ live_id String 1 直播ID └ live_url String 1 直播地址：直播间的流媒体的地址 └ original_input_stream_url String 1 原始推流地址 └ playback_url String http:\\livecaing.alicdn.com\/mediaplatform\/99879e77-533e-4d27-a6e0-98e0943ed0bd.m3u8","pull_stream_url":"rtmp:\/\/liveca.alicdn.com\/mediaplatform\/99879e77-533e-4d27-a6e0-98e0943ed0bd?auth_key=1660385653-0-0-b8b2f551a0739a2ae6e56d4274f75158 回放地址 └ pull_stream_url String http:\\livecaing.alicdn.com\/mediaplatform\/99879e77-533e-4d27-a6e0-98e0943ed0bd.m3u8","pull_stream_url":"rtmp:\/\/liveca.alicdn.com\/mediaplatform\/99879e77-533e-4d27-a6e0-98e0943ed0bd?auth_key=1660385653-0-0-b8b2f551a0739a2ae6e56d4274f75158 拉流地址 └ security_input_stream_url String http:\\livecaing.alicdn.com\/mediaplatform\/99879e77-533e-4d27-a6e0-98e0943ed0bd.m3u8","pull_stream_url":"rtmp:\/\/liveca.alicdn.com\/mediaplatform\/99879e77-533e-4d27-a6e0-98e0943ed0bd?auth_key=1660385653-0-0-b8b2f551a0739a2ae6e56d4274f75158 安全的推流地址 └ stream_name String 1 流名称 └ stream_status Number 1 流状态 0断流，1推流，默认为0 └ summary String 1 直播间简介 └ title String 1 直播间标题

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaElemeGroupvpTbliveLiveroomRequest req = new AlibabaElemeGroupvpTbliveLiveroomRequest();
req.setParamList("1");
AlibabaElemeGroupvpTbliveLiveroomRequest.LiveRoomReadOptionRequest obj1 = new AlibabaElemeGroupvpTbliveLiveroomRequest.LiveRoomReadOptionRequest();
obj1.setIncludeAnchorType(false);
obj1.setIncludeStatistic(false);
obj1.setIncludeStreamInfo(false);
obj1.setPoolId(1L);
obj1.setUseCache(false);
req.setParamLiveRoomReadOptionRequest(obj1);
AlibabaElemeGroupvpTbliveLiveroomResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaElemeGroupvpTbliveLiveroomRequest req = new AlibabaElemeGroupvpTbliveLiveroomRequest();
req.ParamList = "1";
AlibabaElemeGroupvpTbliveLiveroomRequest.LiveRoomReadOptionRequestDomain obj1 = new AlibabaElemeGroupvpTbliveLiveroomRequest.LiveRoomReadOptionRequestDomain();
obj1.IncludeAnchorType = false;
obj1.IncludeStatistic = false;
obj1.IncludeStreamInfo = false;
obj1.PoolId = 1L;
obj1.UseCache = false;
req.ParamLiveRoomReadOptionRequest_ = obj1;
AlibabaElemeGroupvpTbliveLiveroomResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaElemeGroupvpTbliveLiveroomRequest;
$req->setParamList("1");
$param_live_room_read_option_request = new LiveRoomReadOptionRequest;
$param_live_room_read_option_request->include_anchor_type="false";
$param_live_room_read_option_request->include_statistic="false";
$param_live_room_read_option_request->include_stream_info="false";
$param_live_room_read_option_request->pool_id="1";
$param_live_room_read_option_request->use_cache="false";
$req->setParamLiveRoomReadOptionRequest(json_encode($param_live_room_read_option_request));
$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.eleme.groupvp.tblive.liveroom' \
-d 'partner_id=apidoc' \
-d 'sign=29CD163CBE4CC86145337FB1E7B1E10E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+20%3A32%3A03' \
-d 'v=2.0' \
-d 'param_list=1' \
-d 'param_live_room_read_option_request=null'

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

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

req.param_list="1"
req.param_live_room_read_option_request=""
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.eleme.groupvp.tblive.liveroom");
add_param(pRequest,"param_list","1");
add_param(pRequest,"param_live_room_read_option_request","数据结构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.eleme.groupvp.tblive.liveroom', {
	'param_list':'1',
	'param_live_room_read_option_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_eleme_groupvp_tblive_liveroom_response>
    <result>
        <live_room_dto_list>
            <live_room_dto>
                <anchor_id>s</anchor_id>
                <anchor_logo>a</anchor_logo>
                <anchor_nick>a</anchor_nick>
                <anchor_type>1</anchor_type>
                <anchor_types>
                    <string></string>
                </anchor_types>
                <cover16x9_url>1</cover16x9_url>
                <cover1x1_url>1</cover1x1_url>
                <cover9x16_url>1</cover9x16_url>
                <feature>
                    <empty>1</empty>
                </feature>
                <id>1</id>
                <item_ids>
                    <number></number>
                </item_ids>
                <land_scape>false</land_scape>
                <live_appointment_time>2023-03-20 12:00:00</live_appointment_time>
                <live_channel_id>1</live_channel_id>
                <live_column_id>1</live_column_id>
                <live_end_time>2023-03-20 12:00:00</live_end_time>
                <live_room_status>1</live_room_status>
                <live_start_time>2023-03-20 12:00:00</live_start_time>
                <live_uuid>1</live_uuid>
                <location>1</location>
                <pre_video_id>1</pre_video_id>
                <pre_video_url>1</pre_video_url>
                <statistic>
                    <praise_count>1</praise_count>
                    <pv_count>1</pv_count>
                </statistic>
                <status>1</status>
                <stream>
                    <input_code_level>1</input_code_level>
                    <input_stream_url>1</input_stream_url>
                    <live_h_l_s_url>1</live_h_l_s_url>
                    <live_id>1</live_id>
                    <live_url>1</live_url>
                    <original_input_stream_url>1</original_input_stream_url>
                    <playback_url>http:\\livecaing.alicdn.com\/mediaplatform\/99879e77-533e-4d27-a6e0-98e0943ed0bd.m3u8&quot;,&quot;pull_stream_url&quot;:&quot;rtmp:\/\/liveca.alicdn.com\/mediaplatform\/99879e77-533e-4d27-a6e0-98e0943ed0bd?auth_key=1660385653-0-0-b8b2f551a0739a2ae6e56d4274f75158</playback_url>
                    <pull_stream_url>http:\\livecaing.alicdn.com\/mediaplatform\/99879e77-533e-4d27-a6e0-98e0943ed0bd.m3u8&quot;,&quot;pull_stream_url&quot;:&quot;rtmp:\/\/liveca.alicdn.com\/mediaplatform\/99879e77-533e-4d27-a6e0-98e0943ed0bd?auth_key=1660385653-0-0-b8b2f551a0739a2ae6e56d4274f75158</pull_stream_url>
                    <security_input_stream_url>http:\\livecaing.alicdn.com\/mediaplatform\/99879e77-533e-4d27-a6e0-98e0943ed0bd.m3u8&quot;,&quot;pull_stream_url&quot;:&quot;rtmp:\/\/liveca.alicdn.com\/mediaplatform\/99879e77-533e-4d27-a6e0-98e0943ed0bd?auth_key=1660385653-0-0-b8b2f551a0739a2ae6e56d4274f75158</security_input_stream_url>
                    <stream_name>1</stream_name>
                    <stream_status>1</stream_status>
                </stream>
                <summary>1</summary>
                <title>1</title>
            </live_room_dto>
        </live_room_dto_list>
    </result>
</alibaba_eleme_groupvp_tblive_liveroom_response>

{
    "alibaba_eleme_groupvp_tblive_liveroom_response":{
        "result":{
            "live_room_dto_list":{
                "live_room_dto":[
                    {
                        "anchor_id":s,
                        "anchor_logo":"a",
                        "anchor_nick":"a",
                        "anchor_type":"1",
                        "anchor_types":{
                            "string":[
                                ""
                            ]
                        },
                        "cover16x9_url":"1",
                        "cover1x1_url":"1",
                        "cover9x16_url":"1",
                        "feature":{
                            "empty":1
                        },
                        "id":1,
                        "item_ids":{
                            "number":[
                                
                            ]
                        },
                        "land_scape":false,
                        "live_appointment_time":"2023-03-20 12:00:00",
                        "live_channel_id":1,
                        "live_column_id":1,
                        "live_end_time":"2023-03-20 12:00:00",
                        "live_room_status":1,
                        "live_start_time":"2023-03-20 12:00:00",
                        "live_uuid":"1",
                        "location":"1",
                        "pre_video_id":"1",
                        "pre_video_url":"1",
                        "statistic":{
                            "praise_count":1,
                            "pv_count":1
                        },
                        "status":1,
                        "stream":{
                            "input_code_level":1,
                            "input_stream_url":"1",
                            "live_h_l_s_url":"1",
                            "live_id":"1",
                            "live_url":"1",
                            "original_input_stream_url":"1",
                            "playback_url":"http:\\\\livecaing.alicdn.com\\\/mediaplatform\\\/99879e77-533e-4d27-a6e0-98e0943ed0bd.m3u8\",\"pull_stream_url\":\"rtmp:\\\/\\\/liveca.alicdn.com\\\/mediaplatform\\\/99879e77-533e-4d27-a6e0-98e0943ed0bd?auth_key=1660385653-0-0-b8b2f551a0739a2ae6e56d4274f75158",
                            "pull_stream_url":"http:\\\\livecaing.alicdn.com\\\/mediaplatform\\\/99879e77-533e-4d27-a6e0-98e0943ed0bd.m3u8\",\"pull_stream_url\":\"rtmp:\\\/\\\/liveca.alicdn.com\\\/mediaplatform\\\/99879e77-533e-4d27-a6e0-98e0943ed0bd?auth_key=1660385653-0-0-b8b2f551a0739a2ae6e56d4274f75158",
                            "security_input_stream_url":"http:\\\\livecaing.alicdn.com\\\/mediaplatform\\\/99879e77-533e-4d27-a6e0-98e0943ed0bd.m3u8\",\"pull_stream_url\":\"rtmp:\\\/\\\/liveca.alicdn.com\\\/mediaplatform\\\/99879e77-533e-4d27-a6e0-98e0943ed0bd?auth_key=1660385653-0-0-b8b2f551a0739a2ae6e56d4274f75158",
                            "stream_name":"1",
                            "stream_status":1
                        },
                        "summary":"1",
                        "title":"1"
                    }
                ]
            }
        }
    }
}

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.eleme.groupvp.tblive.liveroom (获取淘宝直播直播间信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ