End - 对话结束
更新时间：2024-11-05
API访问域名
| 请求方式 | POST | 说明 |
|---|---|---|
| online base url | https://keyue.cloud.baidu.com/online | AI客服发布后的请求地址 |
| offline base url | https://keyue.cloud.baidu.com | AI客服测试调试地址 |
| 后缀接口 | /core/v5/end | |
| Authentication | token为API Key |
说明
当用户主动取消本次对话时，用于主动结束对话流程。
请求参数
Header参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| Content-Type | string | 是 | 内容类型 | 固定值：application/json |
| token | string | 是 | API KEY | 集成-API-API Key处获取。 详细获取方式参考：准备工作 |
| uid | string | 是 | 用户ID | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
| username | string | 是 | 用户名 | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
Body参数
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| sessionId | string | 是 | 会话ID | 用于标识本轮会话的唯一ID，传入需要结束对话的sessionId |
响应参数
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| time | integer | 是 | 时间 | 时间戳 |
| data | object | 是 | 数据 | 数据 |
| data / end | boolean | 是 | 对话是否结束 | true代表结束对话成功， false代表结束对话失败 |
| code | integer | 是 | 状态码 | 200为成功 |
| msg | string | 是 | 状态信息 | OK为正常 |
请求示例
curl --location 'https://keyue.cloud.baidu.com/online/core/v5/end'
--header 'token: xxxx'
--header 'Content-Type: application/json'
--data '{
"sessionId": "ecb95fcc-0e49-4ab0-b026-c20a8aac1585"
}'响应示例
{
"time": 1713927667141,
"data": {
"end": true
},
"code": 200,
"msg": "OK"
}