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

调用频率

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

请求信息

请求 URL

DELETE https://{endpoint}/im/v2/conversations/actions/conversation_ids

请求 URL 中的 {endpoint} 代表服务地址域名，您可以根据用户服务区域选择中国大陆和海外服务地址，并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

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

查询参数

参数名称	类型	是否必选	说明	示例
conversation_ids	String	是	需要删除的会话 ID 列表。该值是由多个经过 URL 编码后的会话 ID 组成，以逗号分隔，一次最多删除 100 个会话。 如果提供的会话列表中某个会话 ID 不存在，则返回删除成功的会话列表以及删除失败的会话列表。 批量删除的会话必须属于同一个用户账号。即只能批量删除某一用户账号的多个会话。	account_id1|1|account_id2,account_id1|2|team_id,account_id1|3|team_id
clear_message	Boolean	否	是否同步删除会话对应的历史消息。 true：同步删除历史消息。 false（默认）：只删除会话，保留历史消息。	true

响应信息

响应头参数

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

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
success_list	Array of strings	删除成功的会话 ID 列表。	否
- failed_list	Array of objects	删除失败的会话信息列表。	否
conversation_id	String	会话 ID。	否
error_code	Integer	删除失败的错误码。	否
error_msg	String	删除失败的提示信息。	否

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "success_list": [
            "account_id1|1|account_id2",
            "account_id1|2|team_id",
            "account_id1|3|team_id"
        ],
        "failed_list": [
            {
                "conversation_id": "account_id1|1|account_id2",
                "error_code": 102404,
                "error_msg": "error"
            }
        ]
    }
}

错误码

本文仅列举部分业务接口错误码，完整列表请参考客户端 API 错误码。

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