退出当前程序时,关闭当前会话,调用相关服务,关闭会话。
接口描述
请求
GET http://apigate.hsifue.cn/api/front/close
请求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"
}
请求失败返回的数据
*请求失败返回的数据基本示例 * 查看其它状态码
{
"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"
}