docs / developer-docs

Go to a project
Toggle navigation Toggle navigation pinning
chong
9cefb9f8 1 parent 76d988d4

点名

Inline Side-by-side
Showing 2 changed files with 233 additions and 0 deletions
... ... @@ -15,6 +15,7 @@
| lesson | String | Y |课程id| |
| text | String | Y |朗读文本| |
| clazz_id | String | Y |课堂id| |
| record_url | String | Y |录音地址| |
| page | String | Y |第几页 |
| completion_grade | String | Y |成绩| [A_PLUS,A,B,C,D] |
... ...
> env.url: `https`://api[api-online.test].boxfish.cn
>
> notes:
>
* `默认所有接口都要携带token` access_token
# 老师随机连线
* URL {env.url}/omnipotent/thinking/clazz/roll/call
* PUT Method
* path 参数:
* request 参数:
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| clazz_id | String | Y |课堂id| |
| clazz_small_id | Long | Y |班级id| |
| size | int | Y |人数| |
* response：
http code 200
```json
{
"call_id": "OTC-CALL-D8BDCD205C964DFB8A34CDE8FCB544E2",
"users": [
{
"user_id": 100000008016,
"user_real_name": "西松在",
"user_english_name": "Young",
"figure_url": "https://avatars.boxfish.cn/user/100000008016/figure/1566442828.jpg"
},
{
"user_id": 100000008754,
"user_real_name": "Henry",
"user_english_name": "Rachael",
"figure_url": "https://avatars.boxfish.cn/user/100000008754/figure/1573097244.jpg",
}
]
}
```
# 老师下线学生，下线单个学生
* URL {env.url}/omnipotent/thinking/clazz/roll/call
* DELETE Method
* path 参数:
* request 参数:
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| clazz_id | String | Y |课堂id| |
| user_id | Long | N |学生id| |
当指定 user_id 的时候，会下线所有在线学生
* response：
http code 200
# 学生上线更新状态
* URL {env.url}/user/omnipotent/thinking/clazz/roll/call
* PUT Method
* path 参数:
* request 参数:
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| clazz_id | String | Y |课堂id| |
| user_id | Long | N |学生id| |
当指定 user_id 的时候，会下线所有在线学生
* response：
http code 200
# 成绩查询接口
* URL {env.url}/omnipotent/thinking/clazz/lesson/{courseId}/plus/completion
* GET Method
* path 参数:
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| courseId | String | Y |课程id| |
* request 参数:
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| clazz_id | String | Y |课堂id| |
| page | String | Y |all 全部 ，0 第几页 ||
* response：
* A+榜
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| top | List | Y |用户排行| |
| call | Object | Y | 点名信息 | |
call
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| call_id | String | Y |点名id| |
| users | List | Y |上线用户信息 | |
user
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| user_id | String | Y |用户id| |
| user_real_name | String | Y |用户姓名 | |
| user_english_name | String | N |用户英文名，外教课时展示 | |
| figure_url | String | N |用户头像 | |
| completion_grade_list | List | N | | |
| silence | boolean | Y |是否被禁言 | [true，false] |
| disable_camera | boolean | Y |是否被禁用摄像头 | [true，false] |
```json
{
"top": [{
"silence": false,
"clazzTotalCompletion": 0,
"user_id": 100000008016,
"user_real_name": "西松在",
"user_english_name": "Young",
"figure_url": "https://avatars.boxfish.cn/user/100000008016/figure/1566442828.jpg",
"completion_A_PLUS": 0,
"user_clazz_gem": 0,
"completion_grade_list": [],
"disable_camera": false,
"record_completion_score": 0,
"clazz_completion_score": 0,
"clazz_paper_rate_score": "未完成",
"clazz_reading_completion": "未提交"
},
{
"silence": false,
"clazzTotalCompletion": 0,
"user_id": 100000004990,
"user_real_name": "syj",
"user_english_name": "test",
"completion_A_PLUS": 0,
"user_clazz_gem": 0,
"completion_grade_list": [],
"disable_camera": false,
"record_completion_score": 0,
"clazz_completion_score": 0,
"clazz_paper_rate_score": "未完成",
"clazz_reading_completion": "未提交"
},
{
"silence": false,
"clazzTotalCompletion": 0,
"user_id": 100000007866,
"user_real_name": "坤少",
"user_english_name": "Jerry",
"figure_url": "https://avatars.boxfish.cn/user/100000007866/figure/1544409519.jpg",
"completion_A_PLUS": 0,
"user_clazz_gem": 0,
"completion_grade_list": [],
"disable_camera": false,
"record_completion_score": 0,
"clazz_completion_score": 0,
"clazz_paper_rate_score": "未完成",
"clazz_reading_completion": "未提交"
},
{
"silence": false,
"clazzTotalCompletion": 0,
"user_id": 100000008754,
"user_real_name": "Henry",
"user_english_name": "Rachael",
"figure_url": "https://avatars.boxfish.cn/user/100000008754/figure/1573097244.jpg",
"completion_A_PLUS": 0,
"user_clazz_gem": 0,
"completion_grade_list": [],
"disable_camera": false,
"record_completion_score": 0,
"clazz_completion_score": 0,
"clazz_paper_rate_score": "未完成",
"clazz_reading_completion": "未提交"
}
],
"call": {
"call_id": "OTC-CALL-D8BDCD205C964DFB8A34CDE8FCB544E2",
"users": [{
"silence": false,
"clazzTotalCompletion": 0,
"user_id": 100000008016,
"user_real_name": "西松在",
"user_english_name": "Young",
"figure_url": "https://avatars.boxfish.cn/user/100000008016/figure/1566442828.jpg",
"completion_A_PLUS": 0,
"user_clazz_gem": 0,
"disable_camera": false,
"record_completion_score": 0.0,
"clazz_completion_score": 0.0,
"clazz_paper_rate_score": "未完成",
"clazz_reading_completion": "未提交"
},
{
"silence": false,
"clazzTotalCompletion": 0,
"user_id": 100000008754,
"user_real_name": "Henry",
"user_english_name": "Rachael",
"figure_url": "https://avatars.boxfish.cn/user/100000008754/figure/1573097244.jpg",
"completion_A_PLUS": 0,
"user_clazz_gem": 0,
"disable_camera": false,
"record_completion_score": 0.0,
"clazz_completion_score": 0.0,
"clazz_paper_rate_score": "未完成",
"clazz_reading_completion": "未提交"
},
{
"silence": false,
"clazzTotalCompletion": 0,
"user_id": 100000004990,
"user_real_name": "syj",
"user_english_name": "test",
"completion_A_PLUS": 0,
"user_clazz_gem": 0,
"disable_camera": false,
"record_completion_score": 0.0,
"clazz_completion_score": 0.0,
"clazz_paper_rate_score": "未完成",
"clazz_reading_completion": "未提交"
}
]
}
}
```
\ No newline at end of file
... ...