修订记录

6.0.8 2026年03月

新增课堂直播回放参数设置接口,支持更多网页直播回放相关设置。

6.0.7 2026年03月

消息订阅课节结束后推送的消息 新增以下消息:

  • 课堂出勤数据

    在课堂结束后推送课堂的出勤情况,缺勤及出勤数据均会包括。

6.0.6 2026年02月01日

6.0.5 2026年01月06日

消息订阅LMS活动相关的消息 中作业成绩推送新增以下字段:

  • State: 40 已批阅; 50 已打回

6.0.4 2025年11月24日

6.0.3 2025年10月30日

  • 接口变化:课堂活动的单元改为非必填参数
    创建课堂 unitId 参数从必填改为非必填。 如果不传单元参数,则课堂会创建到无单元主题下 。
  • 接口变化:创建课堂 增加频次限制,不超过1000次/分钟

6.0.2 2025年9月4日

消息订阅LMS活动相关的消息 新增以下数据:

  • 讨论活动的评论数据

    推送讨论活动所有的评论、回复和点赞。

6.0.1 2025年8月21日

  • 接口变化:API支持设置OMO站播
    创建课堂编辑课堂接口新增参数:omoStationBroadcast,支持创建OMO站播课堂。

6.0 2025年5月27日

ClassIn 6.0 重磅推出

ClassIn 6.0 明确了班级--课程--单元--活动的层级概念,下线了课节概念--所有课节都迁移为课堂,为此API对课节接口做了一系列兼容,保证原有课节接口仍按正常逻辑创建和修改课节(自动转为课堂),

对课节类接口调用及班级概念变化说明如下:

  • 原课节类接口包括:创建课节、修改课节信息,修改课节上台学生数,课节下添加学生,课节下删除学生接口,课节设置录课,直播回放。
  • 原有课节类接口仍然可以继续调用并创建和修改直播课,只是在app端不再显示为课节,而是显示为默认单元下的课堂活动。
  • 机构不必为此修改任何接口代码。但是建议有能力的机构改为调用LMS创建课堂活动系列接口取代原课节类接口。因为原有接口不再支持新功能,新参数等变化。
  • 新的API LMS类接口创建课堂活动流程,参考 创建一个直播课活动
  • 用户、班级、LMS、机构和云盘类接口内外部逻辑均保持不变。
  • 因为历史原因,所有接口跟班级以及班级ID相关的参数、在文档及代码里的名词都叫“course/courseID”,因为涉及代码,这个单词我们不再更改。默认就是班级的意思。 而6.0新增的班级下course课程这个名词和概念,暂时在API里并没有涉及。所有的活动和单元,都会创建到班级的主课程下。

这次接口兼容的细节包括

  • 历史数据迁移:班级所有的课节都迁移为课堂,可以在班级的默认课程--默认单元--课堂活动 下找到这些历史课节(已转化为课堂)。
  • 课节创建接口:继续可以调用,接口生成一个课堂活动,位于默认课程的默认单元下。仍然返回课节ID,可以用于后继的修改,删除等。
  • 涉及到课节的接口可以通过课节ID继续调用,会操作该课节ID对应的课堂活动。相关接口包括:修改课节信息/删除课节/修改台上人数/增删改课节标签/课节设置录课、直播、回放/修改课节锁定状态/获取课节直播回放地址
  • 添加/删除课节下学生接口:继续可以调用,作用跟之前一样,用于添加和删除课堂活动的插班生。
  • 课堂类接口创建的课堂,请勿使用课节类接口编辑和操作。以免产生数据不一致的问题。

另外,5月26日23点到5月27日6点会有停服升级维护。

届时ClassIn app、后台、API均不可使用。请机构合理安排平台接口调用和课节使用时间。谢谢支持

我们尽量保持API接口调用逻辑不变,如果您在使用中有遇到什么问题,请随时联系ClassIn技术支持。

关于新对接机构

我们建议使用LMS相关接口,用课堂相关接口来替代原来的课节接口。 比如 创建单元--创建课堂活动,来替代原来的创建课节。

5.4.11 2025年3月12日

消息订阅LMS活动相关的消息 新增以下数据:

  • 作业提交信息推送
  • 答题卡成绩推送
  • 作业成绩推送优化新增部分字段

5.4.10 2025年2月21日

消息订阅课节内实时推送消息 新增网页直播聊天消息推送,用户发送消息后触发实时推送

5.4.9 2025年2月20日

消息推送 课后汇总 新增字段“TotalNotDisabled”
新字段在 "End" -> "equipmentsEnd" -> UID -> "Camera" 和 "Microphone" 结构下
表示摄像头和麦克风处于开启状态的时间(不考虑是否在台上)

5.4.8 2025年2月18日

创建课节的时候如果课程下课节总数已经超过机构设置,会创建失败并返回错误码121601070 ,涉及接口:
创建课节
创建课节(多个)
创建课堂
创建新双师课

5.4.7 2024年12月19日

新增添加课程老师接口

优化部分课程课节相关接口对双师课的处理

5.4.6 2024年11月26日

5.4.5 2024年11月

5.4.4 2024年10月

测验结果消息
新增题目得分明细。 详细字段请看文档说明。

5.4.3 2024年9月

ClassIn下载按钮链接 更新js脚本地址。
代码里原js地址已不可用,我们用新的地址替换原地址,需要您进行更新。

5.4.2 2024年10月

云盘接口变化:eeo产品中,原云盘由学校资料改为组织云盘。适配如下

  • 原“学校资源”文件统一迁移到组织云盘--“学校资源”文件夹。但原文件夹和文件ID保持不变。之后接口上传的文件对应会传到组织云盘--学校资源相关目录
  • 上线之前由接口获取顶级文件夹 ID获取的ID,在上线数据迁移之后,不再是组织云盘的顶级ID,而是组织云盘-学校资料文件夹的ID。可以再次获取,得到组织云盘的顶级ID。
  • 如果机构尚未初始化组织云盘,第一次调用获取顶级文件夹 ID 接口时,将会自动初始化机构组织云盘。

5.4.1 2024年9月12日

新增修改新进学生、退出班级学生查看回放、活动权限的接口和参数

5.4 2024年9月12日

新增 LMS 系列接口。包括单元和活动通用接口,以及课堂活动相关接口。涉及改动有几点

5.3.3 2024年8月30日

新增废弃接口:

  • 修改教师授权云盘的课件资源:接口 updateTeacherCloudFolders 将于 2024-08-30 日后下线。

5.3.2 2024年7月31日

创建课程和修改课程:课程过期时间限制由1年内,改为5年内。
涉及以下接口:

5.3.1 2024年7月30日

因业务逻辑变更,消息订阅 - 客户端回放观看统计(cmd:ClientPlaybackDataDetail)将做如下改动:

(1)去除 TopProcess 、TotalLookCount、TotalLookTime 字段。

(2)新增 视频总时长(TotalDuration)、有效观看次数(ValidWatchCount)、最新详情LatestDetails->TriggerType 1,3,4, 分别表示开始观看、结束观看、超时自动推送字段。

  • 其中最新详情 LatestDeatils->TriggerType 当前仅支持“结束观看”,需要在9月份客户端新版本中才能支持“开始观看”。

5.3.0 2024年7月26日

新增LMS活动消息推送,包括两项内容

  • 作业成绩推送:在作业批阅后推送作业批阅者、学生和成绩(总分)
  • 测验成绩推送:在测验批阅后推送测验批阅者、学生和成绩(总分)

5.2.1 2024年4月24日

新增通过链接唤起 ClassIn 客户端后,直接进入班级LMS活动页面。详见 唤醒 ClassIn 客户端的最佳实践

3.44 2024年01月10日

消息订阅:课节内实时推送消息,退出教室Reason字段新增退出原因码:

  • 54:客户端本机重复登陆
  • 56:服务端与客户端网络连接中断
  • 60:被新登录的客户端挤下线
  • 101:按返回键退出(仅安卓设备)
  • 102:来电话退出
  • 111:App进入后台

3.43 2023年12月07日

客户端回放观看统计消息新增TotalLookVaildTime字段,即用户本次观看回放的实际观看覆盖时长,涉及页面如下:

3.42 2023年08月10日

创建课节(单个)创建课节(多个)修改课节信息 新增错误码:

  • 121601001 存在当前版本不支持的设置项
  • 121601002 操作成功,[在线教室]资源已超出用量,为防止业务受影响,请尽快联系客户经理
  • 121601003 您当月累计创建课节已达当月上限,无法继续创建,升级账号获取更多权益
  • 121601004 您当月累计创建课节已达当月上限,无法继续创建
  • 121601005 不支持设网页直播
  • 121601006 不支持设置录制现场
  • 121601007 台上人数参数错误
  • 121601008 不支持设置联席教师
  • 121601009 不支持设置网页回放
  • 121601010 不支持设置录课
  • 121601011 不支持设置双摄模式
  • 121601012 清晰度超出限制

3.41 2023年07月07日

一、 消息订阅课节实时推送中的进出教室字段新增ClientID字段,以便于用户通过双端登录后,区分主副端,涉及页面如下:
二、 消息订阅课后汇总中进出教室新增字段 Deputies,该字段代表副端(双端进入教室后,会出现该字段,默认原有的 Details 里只有主端的进出教室记录),目前仅双端登录,所以只会体现一个副端的数据,涉及页面如下:
三、 注册用户接口功能新增无论是否已注册用户,传入 addToSchoolMember 后都会将其添加到机构下,涉及页面如下:

3.40 2023年06月12日

一、 上传文件接口新增错误码 31000,表示存储已满,请删除部分文件或扩容
二、 直播聊天室免二次登录拼接域名由 www.eeo.cn 修改为 live.eeo.cn,拼接链接后缀由 .php 修改为 .html

3.39 2023年03月21日

一、对接最佳实践中心新增 唤醒ClassIn客户端方案,涉及页面如下:
二、新增数据同步说明,数据为单向同步,即您平台→eeo,eeo的操作数据不会反向同步至您平台;涉及页面如下:

3.38 2023年01月10日

一、新增课程学科字段subjectId,不传或传不符合规则的值则为空,该字段仅支持中小学后台课程;涉及接口如下:
二、lms活动只允许在ClassIn客户端操作,相关接口新增错误码:466=通过客户端-创建课堂产生的课节只能在客户端编辑,涉及接口如下:
三、新增对接最佳实践、对接常见问题QA,涉及页面如下:

3.37 2022年12月6日

新增邮箱账号,涉及接口修改如下:

注册用户注册用户(多个)添加学生添加老师接口:

  • 新增错误码:461=表示邮箱已注册
  • 新增参数:email

获取唤醒客户端并进入教室链接:

  • 网页唤起客户端不支持邮箱账号,如果邮箱账号没有绑定手机号,此接口会报错467,需要绑定手机号之后才能使用
  • 新增错误码:467=免密登录仅支持手机账号,请先绑定手机号

涉及消息订阅修改如下:

3.36 2022年11月20日

添加机构标签

  • 当错误码为353时,表示标签已经存在,新增返回对应标签ID;

3.35 2022年10月11日

创建课程创建课节(单个)创建课节(多个)、接口:

  • 新增错误码:460=课程或课节正在被其他请求创建(并发创建会遇到,建议调整频率后检查是否有重复数据产生)

课程下添加学生/旁听(多个)接口:

  • 新增错误码: 464=课程学生正在被其他请求创建(并发请求会遇到,建议调整频率)

3.34 2022年09月20日

新增 添加/修改/删除课程标签 接口:

添加/修改/删除课程标签,需要 SID,safekey,timeStamp,courseId,courseList。其中当标签数组 (labelIds) 为空时,表示删除课程下所有的标签;当课程下没有标签时,标签数组 (labelIds) 中填写标签 ID,表示给课程下添加标签;当课程下有标签 ID,标签数组 (labelIds) 中添加标签 ID,表示修改课程下标签。返回执行后的信息。注:每个课程下最多可添加10个标签

3.33 2022年06月08日

新增录制现场功能,涉及的接口修改如下:

创建课节(单个)创建课节(多个)修改课节信息课节设置录课、直播、回放(多个)接口:

  • 新增请求参数:recordScene,非必填,1开启录制现场。record开启时可开启。

3.32 2022年04月11日

新增多联席教师功能,涉及的接口修改如下:

创建课节(单个)创建课节(多个)修改课节信息接口:

  • 新增请求参数:assistantUids,格式[1000082,1000083],assistantUids和assistantUid只能传一个;
  • 新增错误码:21316=联席教师数据有重复,21317=联席教师数量超出限制;
  • 去掉330错误码。

3.31 2022年03月28日

消息订阅新增订阅项:

3.30 2022年01月18日

以下接口新增错误码:创建课节(单个)创建课节(多个)修改课节信息 新增判断课节的开始或结束时间是否跟 系统常规运维时间 有重叠,若重叠,则创建、编辑失败,此时返回454错误码;
相关错误码的定义为:454=课节起止时间与系统维护时间有重叠

消息订阅新增订阅项:

3.29 2022年01月05日

将“助教”更改为“联席教师”,接口assistantUid字段传输不做变更,只更新解释含义以及error_info中报错信息;

涉及以下接口:创建课节(单个)创建课节(多个)修改课节信息课程下添加学生/旁听(单个)课程下添加学生/旁听(多个)课节下添加学生(多个)更换课程老师课程下多个课节添加学生以及消息订阅中相关解释;

3.28 2021年11月22日

客户端上线更换手机号功能,消息订阅新增订阅项:更换账号手机号码

3.27 2021年11月11日

新增三个预分组接口:

3.26 2021年09月03日

以下接口新增注销相关的错误码:添加学生添加老师创建课程编辑课程创建课节(单个)创建课节(多个)修改课节信息课程下添加学生/旁听(单个)课程下添加学生/旁听(多个)课节下添加学生(多个)更换课程老师课程下多个课节添加学生获取唤醒客户端并进入教室链接
相关错误码的定义为:883=班主任账号已注销,884=老师账号已注销,885=联席教师账号已注销,886=学生账号已注销,887=旁听账号已注销,888=用户账号已注销

3.25 2021年08月18日

3.24 2021年07月31日

自2021年7月31日起,不再提供以下消息订阅类型的推送:

  • 课节内实时推送的消息 - 教室内IM文字聊天
  • 课节内实时推送的消息 - 教室内IM图片聊天

3.23 2021年07月22日

3.22 2021年05月08日

更改接口 创建课程 传参 allowAddFriend 不传值时的逻辑。

3.21 2021年04月23日

1)修改以下两个接口,新增传参 allowStudentModifyNickname 以支持设置“是否允许学生在群里修改其班级昵称”:

2)更改接口 编辑课程 对传参 folderId 的处理逻辑:

  • 如果该课程下未开课的课节绑定的云盘资源与课程下原有云盘资源相同,则同时更新此课节绑定的云盘资源。
  • 如果该课程下未开课的课节绑定的云盘资源与课程下原有云盘资源相同,则不更新此课节绑定的云盘资源。

3.20 2021年03月30日

自2021年6月1日起,接口 获取唤醒客户端并进入教室链接 将做如下调整:接口返回的URL将不再包含临时密钥authTicket了(翼鸥将根据用户账号逐步分批调整,6.30日全部完成调整),也就是说不再支持使用临时密钥authTicket免密登录唤起客户端。

此调整对您的API对接程序没有任何影响,只会影响您的用户在网页唤起后的操作体验,因此需要您的客服或者运营团队,提前与用户沟通此体验变化:
从2021-06-01日开始,用户首次网页唤起ClassIn客户端后,程序将停留在登录界面等待用户输入密码并点击“登录”,方能进入教室。
请注意:

  1. 对于移动端ClassIn软件会自动记住密码;对于PC ClassIn强烈建议用户在输入密码后勾选“记住密码”以便于下次唤起无须再次输入密码。
  2. 如果用户忘记密码,可以点击登录页面的“忘记密码”以找回密码。

3.19 2021年03月10日

1) 修改以下三个接口,传参seatNum支持传0,表示创建1V0课节,即台上只显示老师(注:未传seatNum或其值传空时表示创建1V6课节):

2) 修改以下两个接口,mainTeacherUid字段规则调整,不传以及传空则不设置/更新班主任,详情请参考接口描述:

3.18 2021年03月02日

新增接口 修改教师授权云盘的课件资源 以支持对教师的授权云盘下的课件资源进行授权。

3.17 2021年01月20日

修改以下三个接口,新增传参 teachMode 以支持设置教学模式为“智慧教室”的课节(课节的教学模式默认为“在线教室”),详情请参考接口描述:

3.16 2021年01月12日

修改以下三个接口,新增传参 isDc 以支持设置是否启用第二摄像头(副摄像头),详情请参考接口描述:

3.15 2021年01月05日

1) 下述接口将只支持传参uid,不再支持传参手机号码。涉及的接口包括:修改用户昵称修改用户密码停用老师启用老师更新课节教师对学生评价创建课程编辑课程创建课节(单个)创建课节(多个)修改课节信息课程下添加学生/旁听(单个)课程下删除学生/旁听(单个)课程下添加学生/旁听(多个)课程下删除学生/旁听(多个)课节下添加学生(多个)课节下删除学生(多个)更换课程老师移除课程老师课程下多个课节添加学生

请注意:接口 添加学生添加老师, 仅支持传参手机号码,不支持传参uid。

2)接口域名及协议头:

  • 所有接口 URL 域名请使用 https://api.eeo.cn, 如果您继续使用 https://www.eeo.cn 的话,则会收到 404 状态码;
  • 所有接口 URL 协议头请使用 https,如果您继续使用 http 方式的话,则会收到 403 状态码。

另外,为了便于后期新接口以及重要修改的通知,强烈建议您在 认证资料 里填写您的常用邮箱(入口:登录eeo.cn机构管理后台,点击左侧的认证资料页面进行填写)。

3.14 2020年11月30日

修改以下四个接口,课节新增支持两个参数的设置:watchByLogin-网页直播回放 和 allowUnloggedChat-允许未登录用户参与直播聊天和点赞,详情请参考接口描述:

3.13 2020年09月15日

消息订阅 课节内实时推送 新增订阅项 教室大黑板板书图片

3.12 2020年09月03日

接口 修改课节信息 支持上课中课节添加/更换/删除联席教师。返回错误码385描述更新,课节结束后不能修改联席教师。 参数规则课节内容下联席教师修改的时间限制更新,支持上课中课节添加/更换/删除联席教师。

3.11 2020年08月13日

接口 创建课程 支持使用学校设置的默认封面作为班级群的封面。

3.10 2020年08月04日

消息订阅 课节内实时推送 新增订阅项 启动录课详情

3.9 2020年06月01日

  • 修改接口:

    • 接口 课程下添加学生/旁听(单个)课程下添加学生/旁听(多个) 支持同步用户姓名至班级昵称,详情请参考接口描述。
    • 接口 课程下添加学生(多个)课节下添加学生(多个) 不再支持代注册(代注册指的是:传参的学生手机号码,如果不是ClassIn账号,支持自动注册。);
    • 课程/课节下添加学生的相关接口(如下四个接口),将不再支持将学生自动添加为机构学生,新增错误码 228 表示“机构下无此学生”。对一个学生或者老师进行排课的标准操作为:注册 --> 添加机构学生/老师 --> 排课。涉及的接口包括:
      • 课程下添加学生/旁听(单个): 请求参数 studentName 项由必填改为非必填。仅用于当identity为2(旁听身份)时,才使用请求参数studentName。当identity为2时,如果没有传此参的话,则使用手机号码作为旁听生的名字。当identity为1(学生身份)时,传了参数studentName也不会被使用。
      • 课程下添加学生/旁听(多个): 请求参数 studentJson 里的 name 项由必填改为非必填。仅用于当identity为2(旁听身份)时,才使用请求参数name。当identity为2时,如果没有传此参的话,则使用手机号码作为旁听生的名字。当identity为1(学生身份)时,传了参数studentJson里的name也不会被使用。
      • 课节下添加学生(多个): 删除了原请求参数中 studentJson 里的 name 项(传了不报错,但也不会使用)。
      • 课程下多个课节添加学生: 删除了原请求参数中 studentName 项(传了不报错,但也不会使用)。
  • 新增待废弃接口和订阅消息项(已从本文档中删除,详情请查看 Deprecation):

    • 接口 删除课程
    • 接口 修改用户信息,以及下线消息订阅 机构维度推送的消息 里的项目 用户修改昵称

3.8 2020年05月08日

  • 新增接口:
    • 接口 修改群成员的班级昵称 此接口用课程下所有学生和旁听生,在机构下的学生姓名,来修改群里学生和旁听生的 班级昵称。修改后,学生在客户端的 IM 班级群里,以及该课程下的教室里上课时,显示的名字均为学生姓名,而非用户昵称。此接口解决了,学生在ClassIn客户端修改用户昵称后,老师经常在群里和教室里上课时,对不上号的问题。
  • 修改接口:
    • 接口 创建课程编辑课程,新增课程设置项allowAddFriend,以设置是否允许班级成员相互添加好友。

3.7 2020年04月10日

3.6 2020年03月16日

新增待废弃接口:

3.5 2020年02月18日

消息订阅 课节内实时推送 新增订阅项 直播页面用户登录

注:更早的修改历史已存档。如需要请联系技术支持

results matching ""

    No results matching ""