查詢頻道連麥詳情資料

更新時間：2024-11-27 11:06:41

介面說明

1、接口用于查询某个频道的一段时间区间内的连麦详情数据，支持分页
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/mic/log/list-detail

線上API呼叫

請求方式

GET

介面限制

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

2、該介面查詢的資料並非即時，當日資料需在次日下午才開始產出資料，不同RTC廠商處理、產出資料耗時不同，產出資料耗時約為6~48小時

3、startDate和endDate相隔不可超過30天

請求參數說明

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號
startDate	true	String	開始日期，格式：yyyy-MM-dd，如2020-10-01，時間範圍不能超過30天
endDate	true	String	結束日期，格式：yyyy-MM-dd，如2020-10-01，時間範圍不能超過30天
page	false	Integer	當前頁碼，預設為1
pageSize	false	Integer	每頁資料大小，預設500筆，最大5000筆，超過5000筆可以分多批拉取，每次page加1，直到回傳列表contents為空為止

範例

http://api.polyv.net/live/v3/channel/mic/log/list-detail?endDate=2020-12-03&appId=frlr1zazn3&sign=F8ABBFE2C714CE6601D2551928EA704A&pageSize=2&page=1&userId=1b448be323&channelId=1965681&startDate=2020-12-01&timestamp=1621842680333

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	請求成功時為連麥詳情資訊【詳見Data參數說明】，請求失敗時為空

Data參數說明

參數名	類型	說明
page	Integer	當前頁碼，預設為1
pageSize	Integer	每頁記錄大小，預設500筆，最大5000筆，超過5000筆可以分多批拉取，每次page加1，直到回傳列表contents為空為止
contents	Array	查詢的結果列表【詳見Contents參數說明】

Contents參數說明

參數名	類型	說明
channelId	String	頻道號
sessionId	String	場次號
viewerId	String	觀眾ID
identity	String	身份 guest：嘉賓 student：學員
nickname	String	暱稱
joinTime	Long	進入 rtc 的時間，13位毫秒時間戳
leaveTime	Long	離開 rtc 的時間，13位毫秒時間戳
duration	Integer	連麥時長(分鐘數)

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelViewDataTest.class);
/**
 * 查询频道连麦详情数据
 * @throws IOException
 */
@Test
public void testLinkMicDetailList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/channel/mic/log/list-detail";
    String channelId = "1965681";
    String startDate = "2020-12-01";
    String endDate = "2020-12-03";
    String page = "1";
    String pageSize = "2";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("userId",userId);
    requestMap.put("channelId",channelId);
    requestMap.put("startDate",startDate);
    requestMap.put("endDate",endDate);
    requestMap.put("page",page);
    requestMap.put("pageSize",pageSize);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道连麦详情数据，返回值：{}",response);
    //do somethings

}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "page":1,
        "pageSize":2,
        "contents":[
            {
                "channelId":"1965681",
                "identity":"student",
                "viewerId":"1606986299073",
                "nickname":"",
                "joinTime":1606986326000,
                "leaveTime":1606986413000,
                "sessionId":"ftmnaan4l3"
            }
        ]
    }
}

異常範例

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