在线授课接口定义.md
1.63 KB
接口定义
名词定义
- 在线授课必备消息
在线授课必须的公用群名、群Id(授课指令用)以及聊天室Room的Id(音视频聊天用)
听课学生基本信息 Id、头像、昵称、目标、学习统计(词汇量、阅读量、听力时长、口语时长)
授课教师基本信息 Id,头像,昵称
测试数据信息
公共群测试信息
- 公共群名:"boxfish-class001"
- 公共群Id:"@TGS#2AA4BQAEN"
- 音视频聊天室Id 100001
获取在线授课必备信息
说明:授课客户端需要获取在线授课必备消息和听课学生基本信息
接口地址:/teaching/student/info
Request Method: GET
Request Params:
参数名 | 是否必须 | 说明 |
---|---|---|
Response:
{
"student_info": {
"student_name": "孙尚香",
"student_id":12938,
"goal": "融入美国中学课堂",
"word_count": 2800,
"read_count": 23000,
"listen": "4小时43分",
"chat": "3小时18分"
},
"group_name": "boxfish-class001",
"group_id": "@TGS#2AA4BQAEN",
"chat_room_id": "100001"
}
通知学生开始上课
说明:通知某次课程相应的学生准备上课,通过发送推送信息的方式通知给学生。推送的通知中应该包括在线授课必备消息和授课教师的基本信息
接口地址:/teaching/student/course
Request Method: POST
Request Params:
参数名 | 是否必须 | 说明 |
---|---|---|
Response:
...