开始新会话

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

接口描述

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

请求

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

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

请求失败返回的数据

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

    {
        "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"
    }