API 参考
在线调试

撤回/删除聊天室历史消息

更新时间: 2024/07/17 16:53:41

功能描述

该接口可以在聊天室撤回或删除一条消息。

该接口通过 notification_enabled 是否下发通知来判定是撤回消息还是删除消息。

  • notification_enabled=true,表示该操作为撤回聊天室消息,撤回后服务端会下发撤回消息的通知,且可以设置 notification_extension 通知扩展字段。
  • notification_enabled=false,表示该操作为删除聊天室消息,删除后服务端不会下发相关通知。

调用频率

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

请求

URL

DELETE https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/messages/:{message_client_id}

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

路径参数

参数名称 类型 是否必选 描述
room_id Long 必选 聊天室 ID。
message_client_id String 必选 消息客户端 ID。

查询参数

参数名称 类型 是否必选 描述
operator_id String 必选 操作者账号 ID。
sender_id String 必选 发送聊天室消息的账号 ID。
create_time Long 必选 消息发送时间戳。
notification_enabled Boolean 必选 该操作是否需要发送通知。true:下发通知,对应撤回聊天室消息;false:不下发通知,对应删除聊天室消息。
notification_extension String 可选 消通知扩展字段,JSON 格式,长度上限 1024 位字符,仅对消息撤回生效,即只有 notification_enabled =true 时,该字段才有效。例如:"{"k":"v"}"。

响应

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
113410 聊天室服务未开通 chatroom service disabled
113404 聊天室不存在 chatroom not exist
113406 聊天室已关闭 chatroom closed
500 服务器内部错误 internal server error
此文档是否对你有帮助?
有帮助
去反馈
  • 功能描述
  • 调用频率
  • 请求
  • URL
  • Header
  • 路径参数
  • 查询参数
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码