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

### 接口描述

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

### 接口URL

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

### 请求方式

```
GET
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/vclass/api/limit/README.md)

### 请求参数描述

| 参数名       | 必选   | 类型     | 说明                                                                                                                         |
| --------- | ---- | ------ | -------------------------------------------------------------------------------------------------------------------------- |
| appId     | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/vclass/api/getSecretKey/README.md)】       |
| timestamp | true | Long   | 当前13位毫秒级时间戳，3分钟内有效                                                                                                         |
| sign      | true | String | 签名，为32位大写的MD5值【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/vclass/api/buildSign/README.md)】 |
| lessonIds | true | String | 课节号，以逗号分隔（上限100个课节） 例如：1015,1016                                                                                           |

### 示例

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

### 响应参数描述

| 参数名    | 类型      | 说明                                                                                                                                 |
| ------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| code   | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vclass/api/errorInfo/README.md)】 |
| status | String  | 响应状态文本信息                                                                                                                           |
| error  | Error   | 错误对象【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vclass/api/errorInfo/README.md)】                   |
| data   | Array   | 请求失败时为空，请求成功时为响应信息 【详见[data字段描述](#data字段描述)】                                                                                       |

#### data字段描述

| 参数名                | 类型      | 说明                                                |
| ------------------ | ------- | ------------------------------------------------- |
| lessonId           | Long    | 课节ID                                              |
| timestamp          | Long    | 当前时间，13位时间戳                                       |
| teacherOnlineCount | Long    | 课节内老师人数                                           |
| studentOnlineCount | Long    | 课节内学生人数                                           |
| status             | Integer | <p>课节状态<br>0：未开始<br>1：上课中<br>2：已下课<br>11：禁止上课</p> |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

```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
    }
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vclass/api/errorInfo/README.md)

成功示例

```json
{
  "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
}
```

异常示例

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://polyv.gitbook.io/document/docs/vclass-copy/api/lesson/get_lesson_live_info.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.