全能课程控制消息.md 7.17 KB

env.url: https://api[api-online.test].boxfish.cn

notes:

  • 默认所有接口都要携带token access_token

课程json全能思维课IM

  • URL {env.url}/omnipotent/student/{lesson}
  • GET Method
  • path 参数:
  • request 参数:

    参数名 类型 必填 说明 示例
    lesson String Y 课程id
  • response:

    http code 404 课程不存在

    http code 200

    参数名 类型 必填 说明 示例
    omnipotent_im List N 课程消息对象
    • 消息对象
    参数名 类型 必填 说明 示例
    action Long Y 动作
    text String Y 文案
  • 单词消息

    参数名 类型 必填 说明 示例
    omnipotent_words_word_spell String Y 单词拼写
    omnipotent_words_word_read_recite String Y 单词读背
    omnipotent_words_sentence_spell String N 句子拼写
    omnipotent_words_sentence_read_recite String N 句子读背
   {
        "omnipotent_im": [{
                "action": "omnipotent_words_word_spell",
                "text": "开始拼单词"
            },
            {
                "action": "omnipotent_words_word_read_recite",
                "text": "开始单词练习"
            },
            {
                "action": "omnipotent_words_sentence_spell",
                "text": "开始拼写语块"
            },
            {
                "action": "omnipotent_words_sentence_read_recite",
                "text": "开始语块练习"
            }
        ]
   }

  • 发音消息

    参数名 类型 必填 说明 示例
    omnipotent_phonics_english_content_spell String N 拼写
    omnipotent_phonics_english_content_read_recite String Y 读背
   {
        "omnipotent_im": [
            {
                "action": "omnipotent_phonics_english_content_spell",
                "text": "开始拼写语块"
            },
            {
                "action": "omnipotent_phonics_english_content_read_recite",
                "text": "开始语块练习"
            }
        ]
   }
  • 语法消息

    参数名 类型 必填 说明 示例
    omnipotent_grammar_sentence_spell String N 拼写
    omnipotent_grammar_sentence_read_recite String Y 读背
   {
        "omnipotent_im": [
            {
                "action": "omnipotent_grammar_sentence_spell",
                "text": "开始拼写语块"
            },
            {
                "action": "omnipotent_grammar_sentence_read_recite",
                "text": "开始语块练习"
            }
        ]
   }
  • 图片短对话消息

    参数名 类型 必填 说明 示例
    omnipotent_image_short_dialog_spell_N String N 拼写,n是数组下标 从0开始
    omnipotent_image_short_dialog_read_recite_N String Y 读背,n是数组下标 从0开始
    {
        "omnipotent_im": [{
                "action": "omnipotent_image_short_dialog_spell_0",
                "text": "开始拼对话第1句"
            },
            {
                "action": "omnipotent_image_short_dialog_read_recite_0",
                "text": "开始对话第1句练习"
            },
            {
                "action": "omnipotent_image_short_dialog_spell_1",
                "text": "开始拼对话第2句"
            },
            {
                "action": "omnipotent_image_short_dialog_read_recite_1",
                "text": "开始对话第2句练习"
            }
        ]
      }
  • 视频短对话消息

    参数名 类型 必填 说明 示例
    omnipotent_video_short_dialog_read_recite_N String Y 读背,n是数组下标 从0开始
    {
        "omnipotent_im": [{
                "action": "omnipotent_video_short_dialog_read_recite_0",
                "text": "开始对话第1句练习"
            },
            {
                "action": "omnipotent_video_short_dialog_read_recite_1",
                "text": "开始对话第2句练习"
            }
        ]
    }
  • 长对话消息

    参数名 类型 必填 说明 示例
    omnipotent_article_choice_question String N 文章问题
    omnipotent_long_dialog_read_N String Y 读背,n是数组下标 从0开始
      {
        "omnipotent_im": [{
                    "action": "omnipotent_video_short_dialog_read_recite_0",
                    "text": "开始对话第1句练习"
                    },
                    {
                    "action": "omnipotent_video_short_dialog_read_recite_1",
                    "text": "开始对话第2句练习"
                    },
                    {
                    "action": "omnipotent_video_short_dialog_read_recite_2",
                    "text": "开始对话第3句练习"
                    },
                    {
                    "action": "omnipotent_video_short_dialog_read_recite_3",
                    "text": "开始对话第4句练习"
                    },
                    {
                    "action": "omnipotent_video_short_dialog_read_recite_4",
                    "text": "开始对话第5句练习"
                    },
                    {
                    "action": "omnipotent_video_short_dialog_read_recite_5",
                    "text": "开始对话第6句练习"
                    }
        ]
    }
    
  • 文章消息

    参数名 类型 必填 说明 示例
    omnipotent_article_choice_question String N 文章问题
    omnipotent_article_spell_N String Y 拼写,n是数组下标 从0开始
    omnipotent_article_spell_read_N String Y 读背,n是数组下标 从0开始
     {
        "omnipotent_im": [{
                "action": "omnipotent_article_choice_question",
                "text": "开始文章问题选择题"
            },
            {
                "action": "omnipotent_article_spell_0",
                "text": "开始拼写第一段文章"
            },
            {
                "action": "omnipotent_article_spell_read_0",
                "text": "开始文章第一段练习"
            },
            {
                "action": "omnipotent_article_spell_1",
                "text": "开始拼写第二段文章"
            },
            {
                "action": "omnipotent_article_spell_read_1",
                "text": "开始文章第二段练习"
            },
            {
                "action": "omnipotent_article_spell_2",
                "text": "开始拼写第三段文章"
            },
            {
                "action": "omnipotent_article_spell_read_2",
                "text": "开始文章第三段练习"
            },
            {
                "action": "omnipotent_article_spell_3",
                "text": "开始拼写第四段文章"
            },
            {
                "action": "omnipotent_article_spell_read_3",
                "text": "开始文章第四段练习"
            }
        ]
       }