在线调试
删除会话中的漫游和历史消息
更新时间: 2024/08/21 18:09:42
该接口用于删除会话内(包括单聊、高级群、超大群会话)全部的历史消息和漫游消息。
可选择:
- 删除会话内所有漫游消息。
- 删除会话内所有历史消息。
- 删除会话所有历史消息,同时删除漫游消息。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求
URL
DELETE https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}/messages
Header
请求 Header 的参数说明请参见 请求 Header。
路径参数
参数名称 | 类型 | 是否必选 | 描述 | 示例 |
---|---|---|---|---|
conversation_id |
String | 必选 | 会话 ID。会话 ID 需要用户自行拼装,拼装规则:owner_id|conversation_type|other_id 或owner_id|conversation_type|team_id
|
单聊会话:Accid1|1|Accid2 高级群会话: Accid1|2|tid 超大群会话: Accid1|3|tid |
查询参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
type |
Integer | 必选 | 删除消息的操作类型。1:删除会话内所有漫游消息;2:删除会话内所有历史消息;3:删除会话所有历史消息,同时删除漫游消息。 |
响应
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 |
此文档是否对你有帮助?