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 @@ @@ -15,6 +15,7 @@
15 | lesson | String | Y |课程id| | 15 | lesson | String | Y |课程id| |
16 | text | String | Y |朗读文本| | 16 | text | String | Y |朗读文本| |
17 | clazz_id | String | Y |课堂id| | 17 | clazz_id | String | Y |课堂id| |
  18 + | record_url | String | Y |录音地址| |
18 | page | String | Y |第几页 | 19 | page | String | Y |第几页 |
19 | completion_grade | String | Y |成绩| [A_PLUS,A,B,C,D] | 20 | completion_grade | String | Y |成绩| [A_PLUS,A,B,C,D] |
20 21
  1 +> env.url: `https`://api[api-online.test].boxfish.cn
  2 +>
  3 +> notes:
  4 +>
  5 + * `默认所有接口都要携带token` access_token
  6 +
  7 +# 老师随机连线
  8 + * URL {env.url}/omnipotent/thinking/clazz/roll/call
  9 + * PUT Method
  10 + * path 参数:
  11 + * request 参数:
  12 +
  13 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  14 + |-------------|--------|------|----------|------|
  15 + | clazz_id | String | Y |课堂id| |
  16 + | clazz_small_id | Long | Y |班级id| |
  17 + | size | int | Y |人数| |
  18 + * response：
  19 + http code 200
  20 +
  21 + ```json
  22 + {
  23 + "call_id": "OTC-CALL-D8BDCD205C964DFB8A34CDE8FCB544E2",
  24 + "users": [
  25 + {
  26 + "user_id": 100000008016,
  27 + "user_real_name": "西松在",
  28 + "user_english_name": "Young",
  29 + "figure_url": "https://avatars.boxfish.cn/user/100000008016/figure/1566442828.jpg"
  30 + },
  31 + {
  32 + "user_id": 100000008754,
  33 + "user_real_name": "Henry",
  34 + "user_english_name": "Rachael",
  35 + "figure_url": "https://avatars.boxfish.cn/user/100000008754/figure/1573097244.jpg",
  36 +
  37 + }
  38 + ]
  39 +}
  40 + ```
  41 +
  42 +# 老师下线学生，下线单个学生
  43 + * URL {env.url}/omnipotent/thinking/clazz/roll/call
  44 + * DELETE Method
  45 + * path 参数:
  46 + * request 参数:
  47 +
  48 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  49 + |-------------|--------|------|----------|------|
  50 + | clazz_id | String | Y |课堂id| |
  51 + | user_id | Long | N |学生id| |
  52 +
  53 + 当指定 user_id 的时候，会下线所有在线学生
  54 + * response：
  55 + http code 200
  56 +
  57 +
  58 +# 学生上线更新状态
  59 + * URL {env.url}/user/omnipotent/thinking/clazz/roll/call
  60 + * PUT Method
  61 + * path 参数:
  62 + * request 参数:
  63 +
  64 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  65 + |-------------|--------|------|----------|------|
  66 + | clazz_id | String | Y |课堂id| |
  67 + | user_id | Long | N |学生id| |
  68 +
  69 + 当指定 user_id 的时候，会下线所有在线学生
  70 + * response：
  71 + http code 200
  72 +
  73 +# 成绩查询接口
  74 + * URL {env.url}/omnipotent/thinking/clazz/lesson/{courseId}/plus/completion
  75 + * GET Method
  76 + * path 参数:
  77 +
  78 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  79 + |-------------|--------|------|----------|------|
  80 + | courseId | String | Y |课程id| |
  81 +
  82 + * request 参数:
  83 +
  84 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  85 + |-------------|--------|------|----------|------|
  86 + | clazz_id | String | Y |课堂id| |
  87 + | page | String | Y |all 全部 ，0 第几页 ||
  88 +
  89 + * response：
  90 + * A+榜
  91 +
  92 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  93 + |-------------|--------|------|----------|------|
  94 + | top | List | Y |用户排行| |
  95 + | call | Object | Y | 点名信息 | |
  96 +
  97 + call
  98 +
  99 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  100 + |-------------|--------|------|----------|------|
  101 + | call_id | String | Y |点名id| |
  102 + | users | List | Y |上线用户信息 | |
  103 +
  104 + user
  105 +
  106 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  107 + |-------------|--------|------|----------|------|
  108 + | user_id | String | Y |用户id| |
  109 + | user_real_name | String | Y |用户姓名 | |
  110 + | user_english_name | String | N |用户英文名，外教课时展示 | |
  111 + | figure_url | String | N |用户头像 | |
  112 + | completion_grade_list | List | N | | |
  113 + | silence | boolean | Y |是否被禁言 | [true，false] |
  114 + | disable_camera | boolean | Y |是否被禁用摄像头 | [true，false] |
  115 +
  116 +
  117 + ```json
  118 + {
  119 + "top": [{
  120 + "silence": false,
  121 + "clazzTotalCompletion": 0,
  122 + "user_id": 100000008016,
  123 + "user_real_name": "西松在",
  124 + "user_english_name": "Young",
  125 + "figure_url": "https://avatars.boxfish.cn/user/100000008016/figure/1566442828.jpg",
  126 + "completion_A_PLUS": 0,
  127 + "user_clazz_gem": 0,
  128 + "completion_grade_list": [],
  129 + "disable_camera": false,
  130 + "record_completion_score": 0,
  131 + "clazz_completion_score": 0,
  132 + "clazz_paper_rate_score": "未完成",
  133 + "clazz_reading_completion": "未提交"
  134 + },
  135 + {
  136 + "silence": false,
  137 + "clazzTotalCompletion": 0,
  138 + "user_id": 100000004990,
  139 + "user_real_name": "syj",
  140 + "user_english_name": "test",
  141 + "completion_A_PLUS": 0,
  142 + "user_clazz_gem": 0,
  143 + "completion_grade_list": [],
  144 + "disable_camera": false,
  145 + "record_completion_score": 0,
  146 + "clazz_completion_score": 0,
  147 + "clazz_paper_rate_score": "未完成",
  148 + "clazz_reading_completion": "未提交"
  149 + },
  150 + {
  151 + "silence": false,
  152 + "clazzTotalCompletion": 0,
  153 + "user_id": 100000007866,
  154 + "user_real_name": "坤少",
  155 + "user_english_name": "Jerry",
  156 + "figure_url": "https://avatars.boxfish.cn/user/100000007866/figure/1544409519.jpg",
  157 + "completion_A_PLUS": 0,
  158 + "user_clazz_gem": 0,
  159 + "completion_grade_list": [],
  160 + "disable_camera": false,
  161 + "record_completion_score": 0,
  162 + "clazz_completion_score": 0,
  163 + "clazz_paper_rate_score": "未完成",
  164 + "clazz_reading_completion": "未提交"
  165 + },
  166 + {
  167 + "silence": false,
  168 + "clazzTotalCompletion": 0,
  169 + "user_id": 100000008754,
  170 + "user_real_name": "Henry",
  171 + "user_english_name": "Rachael",
  172 + "figure_url": "https://avatars.boxfish.cn/user/100000008754/figure/1573097244.jpg",
  173 + "completion_A_PLUS": 0,
  174 + "user_clazz_gem": 0,
  175 + "completion_grade_list": [],
  176 + "disable_camera": false,
  177 + "record_completion_score": 0,
  178 + "clazz_completion_score": 0,
  179 + "clazz_paper_rate_score": "未完成",
  180 + "clazz_reading_completion": "未提交"
  181 + }
  182 + ],
  183 + "call": {
  184 + "call_id": "OTC-CALL-D8BDCD205C964DFB8A34CDE8FCB544E2",
  185 + "users": [{
  186 + "silence": false,
  187 + "clazzTotalCompletion": 0,
  188 + "user_id": 100000008016,
  189 + "user_real_name": "西松在",
  190 + "user_english_name": "Young",
  191 + "figure_url": "https://avatars.boxfish.cn/user/100000008016/figure/1566442828.jpg",
  192 + "completion_A_PLUS": 0,
  193 + "user_clazz_gem": 0,
  194 + "disable_camera": false,
  195 + "record_completion_score": 0.0,
  196 + "clazz_completion_score": 0.0,
  197 + "clazz_paper_rate_score": "未完成",
  198 + "clazz_reading_completion": "未提交"
  199 + },
  200 + {
  201 + "silence": false,
  202 + "clazzTotalCompletion": 0,
  203 + "user_id": 100000008754,
  204 + "user_real_name": "Henry",
  205 + "user_english_name": "Rachael",
  206 + "figure_url": "https://avatars.boxfish.cn/user/100000008754/figure/1573097244.jpg",
  207 + "completion_A_PLUS": 0,
  208 + "user_clazz_gem": 0,
  209 + "disable_camera": false,
  210 + "record_completion_score": 0.0,
  211 + "clazz_completion_score": 0.0,
  212 + "clazz_paper_rate_score": "未完成",
  213 + "clazz_reading_completion": "未提交"
  214 + },
  215 + {
  216 + "silence": false,
  217 + "clazzTotalCompletion": 0,
  218 + "user_id": 100000004990,
  219 + "user_real_name": "syj",
  220 + "user_english_name": "test",
  221 + "completion_A_PLUS": 0,
  222 + "user_clazz_gem": 0,
  223 + "disable_camera": false,
  224 + "record_completion_score": 0.0,
  225 + "clazz_completion_score": 0.0,
  226 + "clazz_paper_rate_score": "未完成",
  227 + "clazz_reading_completion": "未提交"
  228 + }
  229 + ]
  230 + }
  231 +}
  232 + ```