chong

思维课程json

  1 +> env.url: `https`://api[api-online.test].boxfish.cn
  2 +>
  3 +> notes:
  4 +>
  5 + * `默认所有接口都要携带token` access_token
  6 +
  7 +# 课程json全能思维课IM
  8 + * URL {env.url}/omnipotent/student/{lesson}
  9 + * `GET` Method
  10 + * path 参数:
  11 + * request 参数:
  12 +
  13 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  14 + |-------------|--------|------|----------|------|
  15 + | lesson | String | Y |课程id| |
  16 +
  17 + * response:
  18 +
  19 + http code 404 课程不存在
  20 +
  21 + http code 200
  22 +
  23 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  24 + |-------------|--------|------|----------|------|
  25 + | omnipotent_im | List | N |课程消息对象| |
  26 +
  27 + * 消息对象
  28 +
  29 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  30 + |-------------|--------|------|----------|------|
  31 + | action | Long | Y |动作| |
  32 + | text| String | Y | 文案| |
  33 +
  34 + * 单词消息
  35 +
  36 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  37 + |-------------|--------|------|----------|------|
  38 + |omnipotent_words_word_spell | String | Y |单词拼写| |
  39 + |omnipotent_words_word_read_recite | String | Y |单词读背| |
  40 + |omnipotent_words_sentence_spell | String | N |句子拼写| |
  41 + |omnipotent_words_sentence_read_recite | String | N |句子读背| |
  42 +
  43 + ```json
  44 + {
  45 + "omnipotent_im": [{
  46 + "action": "omnipotent_words_word_spell",
  47 + "text": "开始拼单词"
  48 + },
  49 + {
  50 + "action": "omnipotent_words_word_read_recite",
  51 + "text": "开始单词练习"
  52 + },
  53 + {
  54 + "action": "omnipotent_words_sentence_spell",
  55 + "text": "开始拼写语块"
  56 + },
  57 + {
  58 + "action": "omnipotent_words_sentence_read_recite",
  59 + "text": "开始语块练习"
  60 + }
  61 + ]
  62 + }
  63 +
  64 + ```
  65 +
  66 + * 发音消息
  67 +
  68 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  69 + |-------------|--------|------|----------|------|
  70 + |omnipotent_phonics_english_content_spell | String | N |拼写| |
  71 + |omnipotent_phonics_english_content_read_recite | String | Y |读背| |
  72 +
  73 + ```json
  74 + {
  75 + "omnipotent_im": [
  76 + {
  77 + "action": "omnipotent_phonics_english_content_spell",
  78 + "text": "开始拼写语块"
  79 + },
  80 + {
  81 + "action": "omnipotent_phonics_english_content_read_recite",
  82 + "text": "开始语块练习"
  83 + }
  84 + ]
  85 + }
  86 + ```
  87 +
  88 + * 语法消息
  89 +
  90 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  91 + |-------------|--------|------|----------|------|
  92 + |omnipotent_grammar_sentence_spell | String | N |拼写| |
  93 + |omnipotent_grammar_sentence_read_recite | String | Y |读背| |
  94 +
  95 + ```json
  96 + {
  97 + "omnipotent_im": [
  98 + {
  99 + "action": "omnipotent_grammar_sentence_spell",
  100 + "text": "开始拼写语块"
  101 + },
  102 + {
  103 + "action": "omnipotent_grammar_sentence_read_recite",
  104 + "text": "开始语块练习"
  105 + }
  106 + ]
  107 + }
  108 + ```
  109 + * 图片短对话消息
  110 +
  111 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  112 + |-------------|--------|------|----------|------|
  113 + |omnipotent_image_short_dialog_spell_N | String | N |拼写,n是数组下标 从0开始| |
  114 + |omnipotent_image_short_dialog_read_recite_N | String | Y |读背,n是数组下标 从0开始| |
  115 +
  116 + ```json
  117 + {
  118 + "omnipotent_im": [{
  119 + "action": "omnipotent_image_short_dialog_spell_0",
  120 + "text": "开始拼对话第1句"
  121 + },
  122 + {
  123 + "action": "omnipotent_image_short_dialog_read_recite_0",
  124 + "text": "开始对话第1句练习"
  125 + },
  126 + {
  127 + "action": "omnipotent_image_short_dialog_spell_1",
  128 + "text": "开始拼对话第2句"
  129 + },
  130 + {
  131 + "action": "omnipotent_image_short_dialog_read_recite_1",
  132 + "text": "开始对话第2句练习"
  133 + }
  134 + ]
  135 + }
  136 + ```
  137 + * 视频短对话消息
  138 +
  139 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  140 + |-------------|--------|------|----------|------|
  141 + |omnipotent_video_short_dialog_read_recite_N | String | Y |读背,n是数组下标 从0开始| |
  142 +
  143 + ```json
  144 + {
  145 + "omnipotent_im": [{
  146 + "action": "omnipotent_article_choice_question",
  147 + "text": "开始文章问题选择题"
  148 + },
  149 + {
  150 + "action": "omnipotent_long_dialog_read_0",
  151 + "text": "开始文章第一段练习"
  152 + },
  153 + {
  154 + "action": "omnipotent_long_dialog_read_1",
  155 + "text": "开始文章第二段练习"
  156 + },
  157 + {
  158 + "action": "omnipotent_long_dialog_read_2",
  159 + "text": "开始文章第三段练习"
  160 + }
  161 + ]
  162 + }
  163 + ```
  164 +
  165 + * 长对话消息
  166 +
  167 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  168 + |-------------|--------|------|----------|------|
  169 + |omnipotent_article_choice_question | String | N |文章问题| |
  170 + |omnipotent_long_dialog_read_N | String | Y |读背,n是数组下标 从0开始| |
  171 +
  172 + ```json
  173 + {
  174 + "omnipotent_im": [{
  175 + "action": "omnipotent_video_short_dialog_read_recite_0",
  176 + "text": "开始对话第1句练习"
  177 + },
  178 + {
  179 + "action": "omnipotent_video_short_dialog_read_recite_1",
  180 + "text": "开始对话第2句练习"
  181 + }
  182 + ]
  183 + }
  184 + ```
  185 + * 文章消息
  186 +
  187 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  188 + |-------------|--------|------|----------|------|
  189 + |omnipotent_article_choice_question | String | N |文章问题| |
  190 + |omnipotent_article_spell_N | String | Y |拼写,n是数组下标 从0开始| |
  191 + |omnipotent_article_spell_read_N | String | Y |读背,n是数组下标 从0开始| |
  192 +
  193 + ```json
  194 + {
  195 + "omnipotent_im": [{
  196 + "action": "omnipotent_article_choice_question",
  197 + "text": "开始文章问题选择题"
  198 + },
  199 + {
  200 + "action": "omnipotent_article_spell_0",
  201 + "text": "开始拼写第一段文章"
  202 + },
  203 + {
  204 + "action": "omnipotent_article_spell_read_0",
  205 + "text": "开始文章第一段练习"
  206 + },
  207 + {
  208 + "action": "omnipotent_article_spell_1",
  209 + "text": "开始拼写第二段文章"
  210 + },
  211 + {
  212 + "action": "omnipotent_article_spell_read_1",
  213 + "text": "开始文章第二段练习"
  214 + },
  215 + {
  216 + "action": "omnipotent_article_spell_2",
  217 + "text": "开始拼写第三段文章"
  218 + },
  219 + {
  220 + "action": "omnipotent_article_spell_read_2",
  221 + "text": "开始文章第三段练习"
  222 + },
  223 + {
  224 + "action": "omnipotent_article_spell_3",
  225 + "text": "开始拼写第四段文章"
  226 + },
  227 + {
  228 + "action": "omnipotent_article_spell_read_3",
  229 + "text": "开始文章第四段练习"
  230 + }
  231 + ]
  232 + }
  233 +```