End - 对话结束
更新时间：2024-11-04
API访问域名
| 请求方式 | POST | 说明 |
|---|---|---|
| url | https://api-ngd.baidu.com | AI客服发布后的请求地址 |
| 后缀接口 | /core/v5/end |
说明
当用户主动取消本次对话时，用于主动结束对话流程。
请求参数
Header参数
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| token | string | 是 | bot_access_token | access_token: access_token是bot的属性，通过bot管理列表获取 |
| ACTIVE | boolean | 否 | 调用环境 | online/offline 分别代表线上环境和测试环境公有云环境该参数不生效 |
Body参数
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| sessionId | string | 是 | 会话ID | 用于标识本轮会话的唯一ID，传入需要结束对话的sessionId |
响应参数
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| time | integer | 是 | 时间 | 时间戳 |
| data | object | 是 | 数据 | 数据 |
| data / end | boolean | 是 | 对话是否结束 | true代表结束对话成功， false代表结束对话失败 |
| code | integer | 是 | 状态码 | 200为成功 |
| msg | string | 是 | 状态信息 | OK为正常 |
请求示例
Bash
1curl --location 'https://keyue.cloud.baidu.com/online/core/v5/end'
2--header 'token: xxxx'
3--header 'Content-Type: application/json'
4--data '{
5 "sessionId": "ecb95fcc-0e49-4ab0-b026-c20a8aac1585"
6}'响应示例
成功示例
1{
2 "time": 1713927667141,
3 "data": {
4 "end": true
5 },
6 "code": 200,
7 "msg": "OK"
8}