用户咨询流程性问题前,获取相关服务,使用户能够获取到指定流程问题的各个流程项。
接口描述
请求
GET http://apigate.hsifue.cn/api/front/flowItem
请求header参数
| 参数 | 参数类型 | 参数约束 | 是否必传 | 示例值 | 描述 |
|---|---|---|---|---|---|
| session-id | 字符串 | 服务端返回,可从以下api中获取: - 开始新会话 - 会话超时,重启会话 | 否 | C3D205E1B4C72BF451CDC326328786A5 | 索引用户信息的key |
请求param参数
| 参数 | 参数类型 | 参数约束 | 是否必传 | 示例值 | 描述 |
|---|---|---|---|---|---|
| robot | 字符串 | 服务端获取 | 是 | GCCP | 机器人标识: 每次刚打开或者是切换机器人时, 从 获取机器人列表 接口获取 |
| chatid | 字符串 | 服务端获取 | 是 | 74139073-4cfd-449b -9479-7e2fb4895d4d | 会话ID,同一会话ID可能包含多组问答, 从初始会话 开始新会话 api获取 |
| channel | 整型 | 1/2/3/4/5/6 | 是 | 2 | 1.PC 2.公众号 3.网站 4.个人微信 5.小程序 6.APP |
| id | 整型 | 服务端获取 | 是 | 1668 | 流程项ID,用于点击时查询下一个流程项, 从如下接口的返回结果中获取: - 获取Top热门问题 - 获取智能提示的问题 - 根据问题id,获取答案 - 根据算法匹配,获取答案 - 根据算法匹配,获取答案V2 - 根据问题id,获取关联问题答案 |
请求成功返回的数据
请求成功返回数据字段描述
| 返回字段 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| question | 字符串 | 缀为GBQ4/GZB4/GTB4/GBG9/GPB9的文件要怎么打开 | 问题 |
| initialQuestion | 字符串 | 计价GBQ4如何下载 | 初始问题,用于问题学习 |
| flowItem | 对象 | 返回字段类型示例值描述id整型558流程项id, 用于获取下一个流程项flowName字符串第一步流程项名称flowContent字符串安装GBQ4流程项内容linkContent字符串下一步下一个流程项的链接入口, 点击能够展示出下一个流程项 | 流程问题的流程项(type=2) |
请求成功返回的数据基本示例
{
"code": 200,
"message": "success",
"result": {
"flowItem": {
"id": 480,
"flowName": "2",
"flowContent": "<p>2</p>",
"linkContent": "2"
},
"question": "我要进行流程问题测试2",
"initialQuestion": "我要进行流程问题测试2"
}
}
请求失败返回的数据
请求失败返回数据基本示例 查看其它状态码
{
"code": 400,
"message": "Required parameter 'id' is not present"
}
{
"code": 400,
"message": "flowItem.id: value must be a number"
}
{
"code": 400,
"message": "flowItem.channel: value must be between 1 and 6"
}
{
"code": 500,
"message": "java.lang.NullPointerException"
}