首页 >低代码音视频工厂 >API参考 >服务端API >API目录 >直播 >获取直播列表 >ListLiveRooms - 批量查询直播信息

ListLiveRooms - 批量查询直播信息

调用ListLiveRooms分页查询直播信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imp:ListLiveRoomsList
  • IMP
    acs:imp::{#accountId}:*

请求参数

名称类型必填描述示例值
AppIdstring

用户的应用ID,在控制台创建应用时生成。包含小写字母、数字,长度为6个字符。

7m***q
Statusinteger

直播状态。取值:

  • 0:已创建,未开始直播。
  • 1:直播中。
  • 2:直播结束。
  • 3或空:所有状态。
3
PageNumberinteger

查询页码,从1开始,参数为空默认查询第1页。

1
PageSizeinteger

每页显示个数,最大支持50,参数为空默认显示个数为10。

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

FE22D613-D3C6-4A58-87CA-F21FC85AA08E
Resultobject

分页查询直播信息返回的结果。

TotalCountinteger

直播总数。

100
PageTotalinteger

直播总页数。

10
HasMoreboolean

是否还有下一页。

true
LiveListarray

直播列表信息。

object
AppIdstring

用户的应用ID,在控制台创建应用时生成。包含小写字母、数字,长度为6个字符。

7m***q
LiveIdstring

直播的唯一标识ID。

b7f2****ebb3
Statusinteger

直播状态。取值:

  • 0:已创建,未开始直播。
  • 1:直播中。
  • 2:直播结束。
1
RoomIdstring

房间的唯一标识。

AE35-****-T95F
ChatIdstring

弹幕的唯一标识。

09***f8
Titlestring

直播标题。

Title001
Noticestring

直播公告。

Notice001
CoverUrlstring

直播封面。

http://***.png
AnchorIdstring

主播ID。

as****hs
UvLong

访问用户数,同个访客多次访问直播间仅计算一个UV。

100
Extensionobject

直播拓展字段。

string

直播拓展信息。

test001
AnchorNickstring

主播昵称。

User001
PvLong

访问用户人次,访客对同一直播间的多次访问,PV累加。

200
OnlineCountLong

在线用户数。

50
CreateTimeLong

直播的创建时间。单位为ms。

1624259500000
StartTimeLong

直播的开始时间。单位为ms。

1624259600000
EndTimeLong

直播的结束时间。单位为ms。

1624259800000

示例

请求示例

http(s)://[Endpoint]/?Action=ListLiveRooms
&AppId=7m***q
&Status=3
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
    "Result": {
        "TotalCount": 100,
        "PageTotal": 10,
        "HasMore": true,
        "LiveList": [
            {
                "AppId": "7m***q",
                "LiveId": "b7f2****ebb3",
                "Status": 1,
                "RoomId": "AE35-****-T95F",
                "ChatId": "09***f8",
                "Title": "Title001",
                "Notice": "Notice001",
                "CoverUrl": "http://***.png",
                "AnchorId": "as****hs",
                "Uv": 100,
                "Extension": {
                    "key": "test001"
                },
                "AnchorNick": "User001",
                "Pv": 200,
                "OnlineCount": 50
            }
        ]
    }
}

XML格式

<ListLiveRoomsResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <Result>
        <TotalCount>100</TotalCount>
        <PageTotal>10</PageTotal>
        <HasMore>true</HasMore>
        <LiveList>
            <AppId>7m***q</AppId>
            <LiveId>b7f2****ebb3</LiveId>
            <Status>1</Status>
            <RoomId>AE35-****-T95F</RoomId>
            <ChatId>09***f8</ChatId>
            <Title>Title001</Title>
            <Notice>Notice001</Notice>
            <CoverUrl>http://***.png</CoverUrl>
            <AnchorId>as****hs</AnchorId>
            <Uv>100</Uv>
            <Extension>
                <key>test001</key>
            </Extension>
            <AnchorNick>User001</AnchorNick>
            <Pv>200</Pv>
            <OnlineCount>50</OnlineCount>
        </LiveList>
    </Result>
</ListLiveRoomsResponse>

错误码

访问错误中心查看更多错误码。

阿里云首页 低代码音视频工厂 相关技术圈