消息协议

消息协议主要针对Web端集成方式iFLYHOME OS应用内Web应用以及iFLYHOME OS应用外Web应用。尽管两者在通信方式上不一致，但是采用的协议是通用的。 下面我们按照具体功能对具体协议协议进行了说明，并对应给出了每个功能具体的协议样例。

H5调用客户端的通用参数：

鉴权协议

通信协议字段

如果表格过长没有水平滚动条，请尝试刷新页面

协议示例

1. native_check_auth协议示例

   //请求协议
   {
   "appid" : "appidxxx",
   "token":"tokenxxx"
   }
   //返回协议
   { 
   "code":200, 
   "msg": "成功" 
   }
   

2. h5_check_auth_result协议示例

   //请求协议
   {
   "authCode": "200",
   "description":"授权成功"
   }
   

开放ASR语音识别协议

通信协议字段

如果表格过长没有水平滚动条，请尝试刷新页面

协议示例

1. native_open_asr协议示例

   //请求协议
   {
   "token":"tokenxxx",
   "appid" : "appidxxx",
   "progressive":true
   }
   //返回协议
   { 
   "code":200, 
   "msg": "成功" 
   }
   

2. native_update_asr协议示例

   //请求协议
   {
   "params" : "appidxxx",
   "token":"tokenxxx",
   "appid" : "123456"
   }
   //返回协议
   { 
   "code":200, 
   "msg": "成功" 
   }
   

3. native_op_asr_digital协议示例

   //请求协议
   {
   "support" : "1",
   "token":"服务端返回token",
   "appid" : "123456"
   }
   //返回协议
   { 
   "code":200, 
   "msg": "成功" 
   }
   

4. native_close_asr协议示例

   //请求协议
   {
   "token":"tokenxxx",
   "appid" : "appidxxx"
   }
   //返回协议
   { 
   "code":200, 
   "msg": "成功" 
   }
   

5. h5_send_asr_result协议示例

   //请求协议
   { 
   "text": "语音识别结果", 
   "token": "本次语音唯一标识" 
   }
   //返回协议
   { 
   "code":200,
   "msg": "成功",
   "data":{ 
    "asrToken" : "语音唯一id", 
    "handled": 是否处理 
    }
   }
   

开放TTS语音合成协议

通信协议字段

如果表格过长没有水平滚动条，请尝试刷新页面

协议示例

1. native_start_tts协议示例

   //请求协议
   {
   "appid" : "appidxxx",
   "token":"tokenxxx",
   "text":"需要合成的文本",
   "param":"{\"vcn\":\"x_xiaofeng\""}
   }
   //返回协议
   { 
   "code":200, 
   "msg": "成功" 
   }
   

2. native_cancel_tts协议示例

   //请求协议
   {
   "token":"tokenxxx",
   "appid" : "appidxxx"
   }
   //返回协议
   { 
   "code":200, 
   "msg": "成功" 
   }
   

3. h5_send_tts_status协议示例

   //请求协议
   {
   "ttsStatus":1, 
   "progress":"当前合成进度" 
   }
   

开放NLP语义理解协议

通信协议字段

如果表格过长没有水平滚动条，请尝试刷新页面

协议示例

1. native_open_nlp协议示例

   //请求协议
   {
   "services" : "stock`weather",
   "token":"tokenxxx",
   "appid" : "appidxxx"
   }
   //返回协议
   { 
   "code":200, 
   "msg": "成功" 
   }
   

2. native_update_nlp协议示例

   //请求协议
   {
   "params" : "场景id",
   "token":"tokenxxx",
   "appid" : "appidxxx"
   }
   //返回协议
   { 
   "code":200, 
   "msg": "成功" 
   }
   

3. native_close_nlp协议示例

   //请求协议
   {
   "token":"tokenxxx",
   "appid" : "appidxxx"
   }
   //返回协议
   { 
   "code":200, 
   "msg": "成功" 
   }
   

4. h5_send_nlp_result协议示例

   //请求协议
   { 
   "service": "weather",
   "token":"本次语义理解唯一标识",
   "semantic":"语义结果" 
   }
   //返回协议
   { 
   "code":200,
   "msg": "成功",
   "data":{ 
    "nlpToken" : "语音唯一id", 
    "handled": true 
    }
   }
   

开放中英文评测协议

通信协议字段

如果表格过长没有水平滚动条，请尝试刷新页面

【评测参数表格】

字段拼接规则：“language=xxx,category=xxx,result_level=xxx”
字段拼接示例：“language=zh_cn,category=read_chapter,result_level=complete”
其中xxx对应表格中可选值，表格如下：

其他定制化参数：新引擎中英文ent：”see_ch“、"see" ；少儿引擎参"group":"pupil" 详细参数字段参考：https://www.xfyun.cn/doc/mscapi/Android/androidevaluator.html#setparameter

【评测状态表格】

协议示例

1. native_open_ise协议示例

    //请求协议
    {
    "params":"language=en_us,category=read_word,result_level=complete",
    "token":"tokenxxx",
    "appid":"appidxxx"
    }
    //返回协议
    { 
    "code":200, 
    "msg": "成功" 
    }
   

2. native_set_ise_text协议示例

    //请求协议
    {
    "iseText":"评测的文本",
    "token":"tokenxxx",
    "appid":"appidxxx"
    }
    //返回协议
    { 
    "code":200, 
    "msg": "成功" 
    }
   

3. native_close_ise协议示例

    //请求协议
    {
    "token":"tokenxxx",
    "appid" : "appidxxx"
    }
    //返回协议
    { 
    "code":200, 
    "msg": "成功" 
    }
   

4. h5_send_ise_result协议示例

    //请求协议
    { 
    "iseStatus":"onEvalResult",
    "iseResult":"评测结果"
    }
   

开放UI事件协议

通信协议字段

如果表格过长没有水平滚动条，请尝试刷新页面

【UI事件状态】

协议示例

1. native_open_ui_event 协议示例

   //请求协议
   {
   "token":"tokenxxx",
   "appid":"appidxxx",
   "intercept":true
   }
   //返回协议
   { 
   "code":200, 
   "msg": "成功" 
   }
   

2. native_close_ise 协议示例

    //请求协议
    {
    "token":"tokenxxx",
    "appid" : "appidxxx"
    }
    //返回协议
    { 
    "code":200, 
    "msg": "成功" 
    }
   

3. h5_send_ui_status 协议示例

    //请求协议
    { 
    "uiStatus":"onVolume",
    "volume":1
    }
   

对话反馈协议

通信协议字段

如果表格过长没有水平滚动条，请尝试刷新页面

协议示例

1. native_feedback协议示例

    //请求协议
    {
    "appid" : "appidxxx",
    "token":"tokenxxx",
    "text":"需要反馈的文本",
    "needShowText":true,
    "needTts":true
    }
    //返回协议
    { 
    "code":200, 
    "msg": "成功" 
    }