人工监管功能相关服务

获取人工服务状态

开始使用前，调用相关服务，获取人工服务状态。

接口描述

• SSE(Server Send Event): 获取服务端推送的消息
• 用户登录成功之后, 必须调用此接口, 否则人工监管会失效
• 返回当前会话是否被监管的状态, 用于通知客户端去主动建立websocket连接,

请求

GET https://apigate.glodon.com/api/front/getStatus

请求param参数

参数	参数类型	参数约束	是否必传	示例值	描述
chatid	字符串	服务端获取	是	f29fcb25-c10c-4fcb -b9e5-0be6eb855b42	会话ID，同一会话ID可能包含多组问答, 从初始会话 开始新会话 api获取

请求成功返回的数据

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

返回字段	类型	示例值	描述
flag	整型	-1,0,1	-1：用户没有登录 0：用户登录没有被接管： 1：用户登录并且被接管, 需要主动建立websocket连接
peerChatid	字符串	qubb_1585391743424_human	接管该机器人会话的训练师会话ID
reOpenFlag	字符串	0,1	0：会话没有重连过： 1：会话进行过重连

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

	"data": {
		"flag": -1,
		"peerChatid":"qubb_1585391743424_human",
		"reOpenFlag":1
	}
	
	或
	
	"data": {
		"flag": 0,
		"peerChatid":"qubb_1585391743424_human",
		"reOpenFlag":0
	}
	
	或
	
	"data": {
		"flag": 1,
		"peerChatid":"qubb_1585391743424_human",
		"reOpenFlag":1
	}
	

建立websocket连接

开始使用前，调用相关服务，建立websocket连接，使得用户可以人工接管。

接口描述

• 建立websocket连接,用于人工接管

请求

GET https://apigate.glodon.com/api/front/monitor/websocket

请求param参数

参数	参数类型	参数约束	是否必传	示例值	描述
chatid	字符串	服务端获取	是	74139073-4cfd-449b -9479-7e2fb4895d4d	会话ID，同一会话ID可能包含多组问答, 从初始会话 开始新会话 api获取
robot	字符串	服务端获取	是	GCCP	机器人标识: 每次刚打开或者是切换机器人时, 从 获取机器人列表 接口获取
peerChatid	字符串	服务端获取	是	qubb_1578390845523_human	对端会话ID， 通过 根据算法匹配，获取答案 或 根据算法匹配，获取答案V2 获取
reOpenFlag	字符串	客戶端根据异常码设置	是	0	初次连接为0，客户端收到1006异常，进行重连为1

退出人工服务

开始人工服务前，调取相关服务，使得人工客服可选择退出人工服务

接口描述

• 3分钟未交互退出人工,回到和机器人交互
• 断网恢复后，退出人工,回到和机器人交互

请求

GET https://apigate.glodon.com/api/front/closeWebsocket

请求param参数

参数	参数类型	参数约束	是否必传	示例值	描述
chatid	字符串	服务端获取	是	74139073-4cfd-449b -9479-7e2fb4895d4d	会话ID，同一会话ID可能包含多组问答, 从初始会话 开始新会话 api获取
type	整型	1/2	是	1	1:长时间未交互退出人工 2:断网恢复后退出人工

请求成功返回的数据

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

    {
		"code": 200,
		"message": "success"
    }
	

请求失败返回的数据

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

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

	{
    	"code": 400,
    	"message": "closeWebsocket.type: value must be between 1 and 2"
	}

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