# 会话相关服务

# 开始新会话

启动机器人程序，则会话开始，调用相关服务：开始新会话。

接口描述

  • 返回一个新的chatid,表示一个新的会话开始
  • 会话结束时必须调用close接口, 否则会造成资源的泄漏, 人工监管的异常等

请求

GET https://apigate.glodon.com/api/front/initChat
1

请求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

请求成功返回的数据

请求成功返回数据字段描述

返回字段 类型 示例值 描述
chatid 字符串 6055031c-3280-4550-8458-e71d9d48291e 当前会话的唯一标识
tag 整型 0/1 0标识的是小达,1标识的是云问，PC端使用，无需关注
session-id 字符串 C3D205E1B4C72BF451CDC326328786A5 服务端索引用户信息的key

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

    	{
		"code": 200,
		"message": "success",
		"result": {
			"chatid": "6055031c-3280-4550-8458-e71d9d48291e",
			"tag": 0,
			"session-id": "DF162FEC3A2DA4B17DBEEB02B4FA7ACC"
		}
	}
1
2
3
4
5
6
7
8
9

请求失败返回的数据

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

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

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

    {
        "code": 500,
		"message": "java.lang.IndexOutOfBoundsException"
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 会话超时，重启会话

超过设定时间用户未与机器人交互，关闭当前会话。调用相关服务，关闭会话。 用户再次与机器人交互时，开启新会话。调用相关服务，会话超时，重启会话。

接口描述

  • 会话超时关闭后，用户再次与机器人交互后，重启会话
  • 会话结束时必须调用close接口, 否则会造成资源的泄漏, 人工监管的异常等

请求

GET https://apigate.glodon.com/api/front/restartChat
1

请求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

请求成功返回的数据

请求成功返回数据字段描述:

返回字段 类型 示例值 描述
chatid 字符串 6055031c-3280-4550-8458-e71d9d48291e 当前会话的唯一标识
tag 整型 0/1 0标识的是小达,1标识的是云问，PC端使用，无需关注
session-id 字符串 C3D205E1B4C72BF451CDC326328786A5 服务端索引用户信息的key

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

    	{
		"result": {
			"chatid": "a6daf7eb-6c3b-42b8-9f39-eb93f42171ff",
			"tag": 1,
			"session-id": "DF162FEC3A2DA4B17DBEEB02B4FA7ACC"
		},
		"code": 200,
		"message": "success"
	}
1
2
3
4
5
6
7
8
9
10

请求失败返回的数据

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

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

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

    {
        "code": 500,
		"message": "java.lang.IndexOutOfBoundsException"
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 获取会话历史记录

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

接口描述

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

请求

GET https://apigate.glodon.com/api/front/chatHistory
1

请求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
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

请求失败返回的数据

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

    {
        "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"
	}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# 关闭会话

退出当前程序时，关闭当前会话，调用相关服务，关闭会话。

接口描述

  • 关闭人工监管、接管；移除缓存的用户信息

请求

GET https://apigate.glodon.com/api/front/close
1

请求header参数

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

请求param参数

参数 参数类型 参数约束 是否必传 示例值 描述
chatid 字符串 服务端获取 是 74139073-4cfd-449b -9479-7e2fb4895d4d 会话ID，同一会话ID可能包含多组问答, 从初始会话 开始新会话 api获取
robot 字符串 服务端获取 是 GCCP 机器人标识: 每次刚打开或者是切换机器人时, 从 获取机器人列表 接口获取
type 整型 0/1 是 1 0:不清除用户缓存，1:清除用户缓存 （目前仅限“退出程序”时，传1）

请求成功返回的数据

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

    {
		"code": 200,
		"message": "success"
    }
1
2
3
4
5

请求失败返回的数据

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

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

	{
    	"code": 400,
    	"message": "close.type: value must be 0 or 1"
	}

    {
        "code": 500,
		"message": "java.lang.IndexOutOfBoundsException"
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14

← 机器人配置 →

  • 在线客服

  • 意见反馈