查詢課節即時狀態與線上人數

更新時間：2024-10-21 09:33:43

介面說明

1、查询课节实时状态和在线人数
2、接口支持https协议

介面URL

https://api.polyv.net/hi-class-api/open/lesson/v1/getLessonLiveInfo

請求方式

GET

介面限制

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

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫MD5值【詳見簽名產生規則】
lessonIds	true	String	課節編號，以逗號分隔（上限100個課節）例如：1015,1016

範例

http://api.polyv.net/hi-class-api/open/lesson/v1/getLessonLiveInfo?appId=fyirmfdak4&timestamp=1638782295111&sign=4FFEE70C353D7F97F9D9057A8A72E453&lessonIds=1015,1016

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
error	Error	錯誤物件【詳見全域錯誤說明】
data	Array	請求失敗時為空，請求成功時為回應資訊【詳見data欄位說明】

data欄位說明

參數名	類型	說明
lessonId	Long	課節ID
timestamp	Long	目前時間，13位時間戳
teacherOnlineCount	Long	課節內老師人數
studentOnlineCount	Long	課節內學生人數
status	Integer	課節狀態 0：未開始 1：上課中 2：已下課 11：禁止上課

Java請求範例

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

    /**
     * 查询课节实时状态和在线人数
     * @throws IOException
     * @throws NoSuchAlgorithmException
     */
    @Test
    public void getLessonLiveInfo() 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/hi-class-api/open/lesson/v1/getLessonLiveInfo";
        String lessonIds = "1015,1016";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("lessonIds",lessonIds);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("查询课节实时状态和在线人数：{}",response);
        //do somethings
    }

回應範例

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

成功範例

{
  "code": 200,
  "status": "success",
  "data": [{
    "lessonId": 1015,
    "timestamp": 1638782349207,
    "teacherOnlineCount": 1,
    "studentOnlineCount": 9,
    "status": 1
  }, {
    "lessonId": 1016,
    "timestamp": 1638782349207,
    "teacherOnlineCount": 0,
    "studentOnlineCount": 0,
    "status": 11
  }],
  "success": true
}

異常範例

{
  "code": 400,
  "status": "error",
  "error": {
    "code": 20046,
    "desc": "参数输入超限"
  },
  "data": null,
  "success": false
}