获取会话历史记录

用户与机器人的会话结束后,可以调用相关服务,获取会话历史记录。

接口描述

  • 获取当前用户、当前产品会话的历史记录

请求

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

请求header参数

参数 参数类型 参数约束 是否必传 示例值 描述
session-id 字符串 服务端返回,可从以下api中获取: - 开始新会话 - 会话超时,重启会话 C3D205E1B4C72BF451CDC326328786A5 索引用户信息的key

请求param参数

参数 参数类型 参数约束 是否必传 示例值 描述
robot 字符串 服务端获取 GCCP 机器人标识: 每次刚打开或者是切换机器人时, 从 获取机器人列表 接口获取
channel 整型 1/2/3/4/5/6 2 1.PC 2.公众号 3.网站 4.个人微信 5.小程序 6.APP
pageNumber 整型 整型 1 分页–第几页
pageSize 整型 整型 10 分页–每页数量(默认10)

请求成功返回的字段描述

返回字段 类型 示例值 描述
chatid 字符串 e0b475a4-eb98-49ee-b918-fedbed5dce31 会话ID
qid 整型 133256 问题的唯一标识
type 整型 3 问题的类型 : - 0为常规问题 - 1为人工问题 - 2为流程问题 - 3为表格问题
question 字符串 缀为GBQ4/GZB4/GTB4/GBG9/GPB9的文件要怎么打开 问题
questionTime 字符串 “2019-12-30 09:54:29” 提问时间
answer 字符串 计价GBQ4如何下载 答案
answerTime 字符串 “2019-12-30 09:55:01” 回答时间
flowItem 对象 返回字段类型示例值描述id整型558流程项id, 用于获取下一个流程项flowName字符串第一步流程项名称flowContent字符串安装GBQ4流程项内容linkContent字符串下一步下一个流程项的链接入口, 点击能够展示出下一个流程项 流程问题的流程项(type=2)

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

    {
	"code": 200,
	"message": "success",
	"result": [{
		"chatid": "e0b475a4-eb98-49ee-b918-fedbed5dce31",
		"qid": 364936,
		"type": 2,
		"question": "计价GBQ4.0如何查看安全文明施工费的费率?",
		"questionTime": "2019-12-30 09:54:29",
		"answer": "<p>方法一:点到措施项目界面,直接可以看到费率。</p><p><strong>备注:</strong>河北12定额计价,点击【安全生产、文明施工费】即可看到。</p>",
		"answerTime": "2019-12-30 09:54:29",
		"flowItem": {
			"flowContent": "<p>点击【导入导出】选择要导入的excel文件,导入即可。</p>",
			"id": 512,
			"flowName": "整体概述",
			"linkContent": "详细步骤"
		}
	}, {
		"chatid": "eeb98e5f-ccca-4272-a3c3-c1e2e79de38c",
		"qid": 391474,
		"type": 3,
		"question": "查询餐厅营业时间",		
		"questionTime": "2019-12-30 10:39:19",		
		"answer": "早九晚九",
		"answerTime": "2019-12-30 10:39:19",
		"flowItem": {}
	}],
	pageCount: 1
	pageNumber: 1
	pageSize: 10
	recordCount: 7
}
	

请求失败返回的数据

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

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

	{
    	"code": 400,
    	"message": "chatHistory.channel: value must be between 1 and 6"
	}

    {
        "code": 500,
		"message": "java.lang.IndexOutOfBoundsException"
    }
	
	{
		"code": 408,
		"message": "login error"
	}