API接口速览

该章分为API接口速览、主要验签方式、课件相关API说明、课中视频相关接口说明、课中数据接口说明。

类别	接口名称	接口说明
课件相关	课件上传与转换接口	该接口提供课件上传与转换服务，上传有两个维度，1、课节维度，代表上传到该课节的所属课件，当只填课节id不填用户id即为课节维度2、课节加用户维度，当接口上传参数填写用户id后，即为课节+用户维度，同一维度下，不能上传相同课件地址，否则为重复上传。
	课件获取接口	该接口主要提供获取课件转换状态和转换结果，转换结果包含课件创建时间、转换后地址、备份地址、课件大小、课件名称等基本信息。
	课件删除接口	删除机构下课件，根据teacher_id 和file_id来确定唯一的文件进行删除，由于third_token根据lesson_id验签，所以lesson_id必传，此处传任意值即可。
	机构课件查询接口	SDK对接机构教师课件查询，支持多种纬度查询。此接口提供机构下教师上传课件后的查询功能，支持老师id，课件id，和时间段组合查询，并已分页方式返回，其中lesson_id可以传任意值，不参与查询。
视频相关	获取课节监课地址和回放地址	该接口在课中使用时可以获取监课视频，进行监课巡课功能，课后可通过该接口获取回放视频流。
	获取录制视频地址	该接口主要获取录制服务器存放的视频地址。
数据相关	获取学生、老师是否在线接口	该接口返回一个课中在线用户列表，包含用户ID和用户角色等信息。
	用户进出记录获取接口(OPENAPI类型接口)	该接口主要是提供对学生和老师进出房记录的查询，可用于用户上课时长统计和考勤相关，该接口属于OPENAPI类型，openAPI类型的线上环境地址一般为 openapi.weclassroom.com
	获取关键事件接口(OPENAPI类型接口)	获取用户（老师/学生） 进入教室、离开教室、上课、下课等关键事件信息，属于OPENAPI类型，验签方式与用户进出记录获取接口中OPENAPI验签方式一致。
	获取网络延迟接口(OPENAPI类型接口)	获取用户（老师/学生） 进入教室、离开教室、上课、下课等关键事件信息，属于OPENAPI类型接口签方式与用户进出记录获取接口中OPENAPI验签方式一致。
	获取课节回放考勤时长接口(OPENAPI类型接口)	获取某一课节下，用户观看回放考勤时长相关数据
	学生签到查询接口	该接口提供大班课老师点名后的每次签名情况。
	SDK获取课程状态接口	获取SDK机构下课程的状态。
	获取教室内求助信息接口	本接口提供获取课中课堂用户提交的求助信息列表。只限于在机构后台配置直播云的求助页的课堂才能获取(一般默认配置)。
	获取用户的设备检测信息	该接口提供某节课堂下某个用户的设备具体信息，比如摄像头、麦克风和扬声器类型信息，另外提供用户的IP等信息。
课中互动	获取奖励数接口	该接口提供获取奖励数量服务。
事件推送	事件推送接收接口	实时推送课中卡顿、延迟、关键事件通过接口形式推送到机构端，机构端通过该接口可实时分析当前课堂上课质量。
内嵌页	内嵌页接口	提供轻便的方式获取在线课堂质量情况展示页面，包含课堂用户信息、上课视频流信息、关键事件等，可以嵌入到对接机构后台或者客户端中。