保利威文档中心

幫助中心

根據頻道 ID 與場次 ID 取得使用者發言次數統計

更新時間:2023-04-23 10:35:06

介面描述

1、根据频道id和场次id获取用户发言次数统计
2、搭配富德定制化开播端使用
3、接口支持https协议

介面 URL

http://api.polyv.net/live/v4/chat/get-group-login-times

請求方式

GET

介面限制

1、介面同時支援 HTTP 與 HTTPS,建議使用 HTTPS 以確保介面安全,介面呼叫有頻率限制,詳細請查看

請求參數說明

參數名 必填 類型 說明
appId true String 帳號 appId【詳見取得金鑰
channelId true String 頻道 ID
sign true String 簽名,為 32 位大寫 MD5 值,產生簽名的 appSecret 金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有 API 都必須透過客戶自己的伺服器中轉呼叫 POLYV 伺服器取得回應資料【詳見簽名產生規則
timestamp true String 目前 13 位毫秒級時間戳,3 分鐘內有效

範例

http://api.polyv.net/live/v4/chat/get-group-login-times?appId=frlr1zazn3&sign=D3FF70E76C06B7F741C406D23E35AFF0&channelId=1965681&timestamp=1682217131813

回應參數說明

參數名 類型 說明
code Integer 狀態碼,與 HTTP 狀態碼相同,用於確定基本的回應狀態
data Array 成功回應的資料【詳見Data 參數說明
error Object 狀態碼非 200 時的錯誤資訊【詳見Error 參數說明
requestId String 請求 ID,每次請求產生的唯一 UUID,僅可用於排查與除錯,不應與業務掛鉤
status String 回應結果,由業務決定,成功回傳 success,失敗回傳 error
success Boolean 是否成功回應

Data 參數說明

參數名 類型 說明
id String 分公司 ID
name String 分公司名稱
total Integer 登入人數

Error 參數說明

參數名 類型 說明
code Integer 錯誤代碼,用於確定具體的錯誤原因
desc String 錯誤描述,與 error.code 對應

Java 請求範例

快速接入基礎程式碼請下載相關依賴原始碼點擊下載原始碼,下載後加入自己的原始碼工程中即可。測試案例中的 HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播 Java SDK 完成 API 的功能對接,直播 Java SDK 對 API 呼叫邏輯、異常處理、資料簽名、HTTP 請求執行緒池進行了統一封裝與最佳化。

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 根据频道id和场次id获取用户发言次数统计
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void chatGetGroupLoginTimesTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/chat/get-group-login-times";
    String channelId = "1965681";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("channelId", channelId);
    requestMap.put("timestamp", timestamp);

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);

    log.info("测试根据频道id和场次id获取用户发言次数统计成功:{}", response);
    //do somethings

}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "628a84ad211344b8b15ec06a722fa793.71.16822171085604901",
    "data": [
        {
            "id": "a112",
            "name": "test",
            "total": 10000
        }
    ],
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询