AgentDelete - 删除AI客服
更新时间：2024-11-07
API访问域名
| 请求方式 | POST |
|---|---|
| base url | https://keyue.cloud.baidu.com |
| 后缀接口 | /open/v1/api/v3/agents/delete |
| Authentication | token为API Key |
说明
AI客服必须存在才能删除，已经上线的agent也不能删除，只能删除下线的agent
请求参数
Header参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| Content-Type | string | 是 | 内容类型 | 固定值：application/json |
| token | string | 是 | API KEY | 集成-API-API Key处获取。 详细获取方式参考：准备工作 |
| uid | string | 是 | 用户ID | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
| username | string | 是 | 用户名 | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
Parameter参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| agentId | string | 是 | AI agent的ID |
Body参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| agentName | string | 是 | agent名称 | |
| id | string | 是 | AI agent的ID |
响应参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| time | integer | 是 | 时间 | 1722239381781 |
| data | null | 是 | 数据 | null |
| code | integer | 是 | 状态码 | 200 |
| msg | string | 是 | 状态信息 | OK |
请求示例
curl --location 'http://keyue-test.cloud.baidu.com/open/v1/api/v3/agents/delete?agentId=44017630-81dd-4d92-992e-2b94fd5b7126' \
--header 'token: 7f3894e7-01d8-4e2e-88d0-ef437ffd3f63' \
--header 'uid: dd6283a283df42998bab14607e23f38d' \
--header 'username: xxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"agentName": "QAZgood",
"id": "44017630-81dd-4d92-992e-2b94fd5b7126"
}'响应示例
{
"time": 1722239381781,
"data": null,
"code": 200,
"msg": "OK"
}{
"msg": "AI客服不存在，请刷新页面重试",
"tip": "",
"code": 4000604,
"requestId": "054c3f38c02e467d90c5f914a95495a8"
}
{
"msg": "AI客服当前状态不可删除",
"tip": "",
"code": 4007281,
"requestId": "326d90296b3e483691caf99efd672ad1"
}