蓝心九问
Bot接口会话

删除会话

接口描述

此接口用于删除指定会话及其所有消息记录。请谨慎使用此接口,删除操作不可逆。

基础信息

请求地址/conversations/{conversation_id}
请求域名• 办公网域名:http://jiuwen-api.vmic.xyz/v1 • IDC域名:http://jiuwen-api.vivo.lan:8080/v1
请求方法DELETE
接口说明删除会话。

请求参数

Request Header

参数取值说明
AuthorizationBearer {{API-SECRET-KEY}} 用于验证客户端身份的 API密钥。注意:请只替换红色部分!Bearer和密钥中间有一个空格,请勿删除!
Content-Typeapplication/json响应的HTTP内容类型。

Path Params

参数类型说明
conversation_idString会话ID

Request Body

参数类型是否必传默认值说明
userString是用户标识,由开发者定义规则,需保证用户标识在应用内唯一。

示例

Request

curl --location --request DELETE 'http://chato-console-test.vmic.xyz/v1/conversations/{conversation_id}' \
--header 'Authorization: Bearer {{API-SECRET-KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{ 
 "user": "abc-123"
}'

注意: 请只替换{{API-SECRET-KEY}}!Bearer和密钥中间有一个空格,请勿删除!

Response

{
  "result": "success"
}

On this page