在线授课接口定义.md
4.93 KB
接口定义
名词定义
- 在线授课必备消息
在线授课必须的公用群名、群Id(授课指令用)以及聊天室Room的Id(音视频聊天用)
听课学生基本信息 Id、头像、昵称、目标、学习统计(词汇量、阅读量、听力时长、口语时长)
授课教师基本信息 Id,头像,昵称
Base Url
http://192.168.0.111:8098 旧版链接
http://192.168.0.100:8098 新版链接 自动生成群id和chat_room_id,自动将学生老师加到群里
获取用户访问Qcloud的identifier和签名
/user/me接口中增加返回值:
...
"qcloud": {
"identifier": "5de6f7a36339ef5bedc3dc8741a1e222",
"sign": "eJxFkN1ugkAQRt*F2zZ12R8Xe4doG9BGjZLaK4K7g6yUFWElYNN3LxJMb8*ZLzPf-Fi75fYlLgolo9hEpJTWq4Ws5x5DU6gSojgxUHbYZoxhhB62hrJSZ90JjGxmY4LQv1QStFGJ6oNMwjjhMRkTMoGEHUAKIoXDqR3bgDEeMpU6dsMf8y-P38xWp0nwbXahDg*e66U34be6qjd1VmdN6gZzAQ5-aszeXI9*6i7eQK3VjE61TZcB359QkKD3URhePqdbslq3eSBu-LLw89Fjmcyivva9GL1fTgljgzQqh54zh3DGKB94LMT5qk1k2gL6P-3*AfZQX20_"
},
...
获取在线授课必备信息
说明:授课客户端需要获取在线授课必备消息和听课学生基本信息
接口地址:/teaching/student/info
Request Method: GET
Request Params:
参数名 | 是否必须 | 说明 | 参数类型 |
---|---|---|---|
work_order_id | 是 | 工单id | Long |
student_id | 是 | 测试时必填参数,此id应该根据work_order_id来获取 | Long |
teacher_id | 是 | 测试时必填参数,此id应该根据work_order_id来获取 | Long |
与工单中心对接后,则删除student_id 和 teacher_id 参数
调完这个接口,老师和学生就已经加到返回的群里了
腾讯云的用户identifier 为盒子鱼用户id的md5值
Response:
{
"student_info": {
"student_name": "孙尚香",
"student_id":12938,
"goal": "融入美国中学课堂",
"word_count": 2800,
"read_count": 23000,
"listen": "4小时43分",
"spoken": "3小时18分"
},
"group_name": "boxfish-class001",
"group_id": "@TGS#2AA4BQAEN",
"chat_room_id": "100001"
}
通知学生开始上课
说明:通知某次课程相应的学生准备上课,通过发送推送信息的方式通知给学生。推送的通知中应该包括在线授课必备消息和授课教师的基本信息
接口地址:/teaching/student/push :连接云数据库
/teaching/student/push_local :连接本地数据库
Request Method: GET
参数名 | 是否必须 | 说明 | 参数类型 |
---|---|---|---|
user_id | 否 | 用户id,即JPush别名,默认为 12938 | Long |
title | 否 | 推送的title,默认为"boxfish_push_test" | String |
production | 否 | 是否为正式环境,true为正式环境,false为测试环境 | boolean |
group_name | 否 | 群名称,默认是 boxfish-class001 | String |
group_id | 否 | 群id,默认是 @TGS#2AA4BQAEN | String |
chat_room_id | 否 | 默认是 100001 | Long |
推送json:
{
"figure_url": "http://wx.qlogo.cn/mmopen/PiajxSqBRaEJrztQnGAk8X1G2A0AfjvPRBdgLFOjxsM9AoicoOUrH3Yia3qY9uic5ibQO6wMkJ6bPUx15IN4Vrxv8CA/0",
"teacher_name": "喜洋洋老师",
"teacher_id": "5",
"group_name": "boxfish-class001",
"group_id": "@TGS#2AA4BQAEN",
"chat_room_id": "100001"
}
###课程结束接口 接口地址:/teaching/student/finish
Request Method: POST
参数名 | 是否必须 | 说明 | 参数类型 |
---|---|---|---|
lesson_id | 是 | 课程id | String |
teacher_id | 是 | 老师id | Long |
group_id | 是 | 群组id | Long |
返回值:
status code:200
###课程结束评价接口 接口地址:/teaching/evaluation
Request Method: POST
参数名 | 是否必须 | 说明 | 参数类型 |
---|---|---|---|
work_order_id | 是 | 工单id | Long |
score | 是 | 评分 | int |
evaluation | 否 | 评价 | String |
source_id | 是 | 评价人id | Long |
target_id | 是 | 被评价人id | Long |
###房间进入状态回调接口
接口地址:/teaching/callback/chat_room
请求方式:POST
Request参数:
参数名 | 是否必须 | 说明 | 参数类型 |
---|---|---|---|
work_order_id | 是 | 工单id | Long |
user_id | 是 | 用户id | Long |
chat_room_id | 是 | 房间号id | Long |
type | 是 | 用户类型 | STUDENT or TEACHER |
is_entered | 是 | 进入状态 | boolean true or false |
Response
......