分頁取得頻道聊天室房間線上人數列表

更新時間：2022-09-02 18:08:07

介面URL

http://api.polyv.net/live/v3/channel/chat/get-chat-user-list

介面說明

1、分页获取频道聊天室房间在线人数
2、支持分页，最大每页1000条数据，最小每页1条数据
3、接口支持https

支援格式

JSON

請求方式

GET

請求數限制

TRUE

請求參數

參數名	必選	類型	說明
appId	是	string	從API設定中取得，在直播系統登記的appId
timestamp	是	long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值,`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	是	int	頻道號
page	否	int	第幾頁，預設：1（第一頁）
pageSize	否	int	每頁資料大小，預設每頁100筆資料，最大每頁1000筆資料，最小每頁1筆資料
toGetSubRooms	否	int	是否取得轉播頻道線上人數，1：表示取得，0：表示不取得

回應成功JSON範例：

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 2,
        "pageNumber": 1,
        "totalItems": 2,
        "contents": [
            {
                "userId": "ovtl9t4a6-vVGrnOVZvA95zuk2x4",
                "pic": "https://s1.videocc.net/default-img/avatar/viewer.png",
                "nick": "123",
                "roomId": "1888749"
            }
        ],
        "startRow": 1,
        "firstPage": true,
        "lastPage": true,
        "prePageNumber": 1,
        "limit": 2,
        "totalPages": 1,
        "endRow": 2,
        "nextPageNumber": 1,
        "offset": 0
    }
}

回應失敗JSON範例：

未輸入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正確

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

時間戳錯誤

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

簽名錯誤

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

非法頻道

{
    "code": 403,
    "status": "error",
    "message": "illegal channel id: 1779742",
    "data": ""
}

非法參數

{
    "code": 400,
    "status": "error",
    "message": "param is not digit: size",
    "data": ""
}

參數數值超出規定範圍

{
    "code": 400,
    "status": "error",
    "message": "number range error",
    "data": ""
}

欄位說明

參數名	類型	說明
code	int	回應代碼，成功為200，失敗為400，簽名錯誤為401，異常錯誤500
status	string	成功為success，失敗為error
message	string	錯誤時為錯誤提示訊息
data	object	回應結果集
pageNumber	int	當前的頁數
totalItems	int	總的筆數
contents	array	查詢的結果列表
contents[0].userId	int	加入房間的userId
contents[0].pic	string	加入房間的頭像
contents[0].nick	int	加入房間的暱稱
contents[0].roomId	string	房間號
firstPage	boolean	是否為第一頁，值為：true/false
lastPage	boolean	是否為最後一頁，值為：true/false
nextPageNumber	int	下一頁編號
prePageNumber	int	上一頁編號
totalPages	int	總頁數
startRow	int	當前頁第一個數量的位置
endRow	int	當前頁最後一個數量的位置
limit	int	每頁數量大小

Java請求範例

public static void main(String[] args) {
        String url = "https://api.polyv.net/live/v3/channel/chat/get-chat-user-list";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("channelId", "0000000");
        params.put("page", "1");
        params.put("size", "10");
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
    }