查询课节实时状态和在线人数

接口描述

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

接口URL

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

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

示例

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

响应参数描述

data字段描述

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
}