通过该接口查询指定类型直播的列表。

接口请求地址

• 请求方法：POST
• URL：http://roomkit.netease.im//scene/apps/{appKey}/ent/live/v1/list
• Content-Type：application/json;charset=utf-8

请求参数

• POST 请求中 Header 的设置请参考请求结构描述。
• POST 请求中 Body 的设置如下：

参数名称	类型	是否必选	示例	描述
pageNum	Integer	必选	1	总页数。
pageSize	Integer	必选	20	每页最多展示的直播数量。
live	Integer	可选	0	直播状态。 0：未开始 1：直播中 2：PK 中 3：惩罚中 4：连麦中 5：等待 PK 中 6：直播结束
liveType	Integer	必选	1	直播类型。 1：INTERACTION_LIVE（互动直播-直播CDN） 2：CHAT_ROOM（语聊房） 3：KTV_ROOM（KTV 房间） 4：INTERACTION_LIVE_CROSS_CHANNEL（互动直播-跨频道转发）

返回参数

以下是返回结果中 data 属性内包含的参数。

参数	类型	示例	描述
total	Long	3	总直播数量。
pageNum	Object	1	当前页码。
pageSize	Integer	20	每页最多展示的直播数量。
size	Integer	3	当前页展示的直播数量。
anchor	Object	-	主播信息。详细信息请参考 anchor 结构。
live	Object	-	直播信息。详细信息请参考 live 结构。
startRow	Integer	0	开始行。
endRow	Integer	10	结束行。
pages	Integer	1	总页数。
prePage	Integer	0	上一页。
nextPage	Integer	0	下一页。
isFirstPage	Boolean	true	是否是第一页。
isLastPage	Boolean	true	是否是最后页。
hasPreviousPage	Boolean	false	是否有上一页。
hasNextPage	Boolean	false	是否有下一页。
navigatePages	Integer	8	导航总页数。
navigatepageNums	Integer	1	页数集合。

示例

请求 Body 示例

{
    "pageNum": 1,
    "pageSize": 20,
    "liveType": 1
}

返回示例

{
    "code": 200,
    "data": {
        "total": 3,
        "list": [
            {
                "anchor": {
                    "userUuid": "231340794139392",
                    "rtcUid": 231340794139392,
                    "userName": "用户254489",
                    "icon": "https://yx-web-nosdn.netease.im/quickhtml/assets/yunxin/default/g2-demo-avatar-imgs/86117804176052224.jpg"
                },
                "live": {
                    "liveRecordId": "238244707321274368",
                    "userUuid": "231340794139392",
                    "liveType": 2,
                    "status": 2,
                    "live": 1,
                    "liveTopic": "直播主题",
                    "cover": "https://t7.baidu.com/it/u=1595072465,3644073269&fm=193&f=GIF",
                    "rewardTotal": 0,
                    "audienceCount": 0
                }
            }
        ],
        "pageNum": 1,
        "pageSize": 10,
        "size": 3,
        "startRow": 0,
        "endRow": 10,
        "pages": 1,
        "prePage": 0,
        "nextPage": 0,
        "isFirstPage": true,
        "isLastPage": true,
        "hasPreviousPage": false,
        "hasNextPage": false,
        "navigatePages": 8,
        "navigatepageNums": [
            1
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 1
    },
    "requestId": "af245fd202110191026226210060000",
    "costTime": "315ms"
}