该接口用于删除指定会话。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求

URL

DELETE https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}

Header

请求 Header 的参数说明请参见请求 Header。

路径参数

参数名称	类型	是否必选	描述	示例
conversation_id	String	必选	需要删除的会话 ID，若传入的会话 ID 不存在会返回 414 错误码。	单聊会话：Accid1|1|Accid2 高级群会话：Accid1|2|tid 超大群会话：Accid1|3|tid

查询参数

参数名称	类型	是否必选	描述
clear_message	Boolean	可选	是否同步删除会话对应的历史消息。 true：同步删除历史消息。 false：只删除会话，保留历史消息。

响应

Header

响应 Header 的参数说明请参见响应 Header。

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是

响应体示例

json{
  "code": 200,
  "msg": "success",
  "data": {}
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
102404	用户不存在	account not exist
500	服务器内部错误	internal server error