全部文档

获取智能提示的问题

用户与机器人交互前，调用相关服务，使用户在会话前获取智能提示的相关问题。

接口描述

  • 用户输入问题时，实时获取智能提示的相关问题，包括：
    - 常规问题
    - 流程问题
    - 表格问题

请求

GET http://apigate.hsifue.cn/api/front/questionTips

请求param参数

参数 参数类型 参数约束 是否必传 示例值 描述
robot 字符串 服务端获取 是 GCCP 机器人标识: 每次刚打开或者是切换机器人时, 从 获取机器人列表 接口获取
question 字符串 最大长度500 是 GBQ4如何使用 用户输入的问题
channel 整型 1/2/3/4/5/6 是 2 1.PC 2.公众号 3.网站 4.个人微信 5.小程序 6.APP

请求成功返回的数据

请求成功返回字段描述

返回字段类型示例值描述highlight字符串后缀为< span class=\"highlight\">GBQ4< /span>/
GZB4的文件要怎么打开？智能提示的问题，其中匹配的部分被高亮设置question字符串后缀为GBQ4/GZB4的文件要怎么打开？智能提示的问题type整型2当前问题的类型 ：
- 0为常规问题
- 1为人工问题
- 2为流程问题
- 3为表格问题qid整型133256当前问题的唯一标识

请求成功返回的数据基本示例

    {
    "code": 200,
    "message": "success",
    "result": {
        "tips": [
            {
                "highlight": "后缀为<span class=\"highlight\">GBQ4</span>/GZB4/GTB4/GBG9/GPB9的文件要怎么打开？",
                "question": "后缀为GBQ4/GZB4/GTB4/GBG9/GPB9的文件要怎么打开？",                 
                "type": 2,                   
                "qid": 205534
                
            },
            {
                "highlight": "后缀为<span class=\"highlight\">GBQ4</span>/GZB4/GTB4/GBG9/GPB9的文件要怎么打开？",
                "question": "后缀为GBQ4/GZB4/GTB4/GBG9/GPB9的文件要怎么打开？",                 
                "type": 0,                   
                "qid": 205534
            }
        ]
    }
}

请求失败返回的数据

请求失败返回的数据基本示例 查看其它状态码

    {
        "code": 400,
		"message": "Required parameter 'question' is not present"
    }

	{
    	"code": 400,
    	"message": "questionTips.robot: value must be get from server"
	}

	{
    	"code": 400,
    	"message": "questionTips.question: Length exceeds the max value [500]"
	}

    {
        "code": 500,
		"message": "java.lang.ClassCastException"
    }