服务端 API

撤回消息

使用 撤回消息 从业务服务端调用 OpenIM 消息 REST 接口，按会话 ID 和 Seq 撤回一条已发送消息。撤回成功后，相关客户端会收到撤回同步事件。

请先在接入准备中配置 API 地址和 Token；接口参数通过请求头和 JSON 请求体传递。

HTTP 请求

POST {API_ADDRESS}/msg/revoke_msg

请求示例

curl --request POST "${API_ADDRESS}/msg/revoke_msg" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "conversationID": "si_user_001_user_002",
  "seq": 128,
  "userID": "user_001"
}'

安全提示：管理员 Token 只能保存在业务服务端或 OpenIM Chat 服务端，不能下发到客户端或写入前端代码。

参数

此接口通过请求头传入链路追踪信息和鉴权凭证，通过 JSON 请求体传递业务参数。

请求头

Header	是否必填	类型	说明
operationID	是	string	每次请求的唯一链路追踪 ID，建议由后端生成并写入日志。
token	是	string	APP 管理员 Token 或具备该用户访问权限的用户 Token；仅保存在可信后端服务中。
Content-Type: application/json	是	string	请求体为 JSON 时必须设置。

请求体

{
  "conversationID": "si_user_001_user_002",
  "seq": 128,
  "userID": "user_001"
}

参数名	是否必填	类型	说明
conversationID	是	string	目标会话 ID。
seq	是	int	要撤回消息的 Seq。
userID	是	string	撤回操作者用户 ID。

响应

请求被 OpenIM 正常处理时通常返回 200 OK。业务是否成功以响应体中的 errCode 为准；errCode === 0 表示成功，非 0 表示业务错误。

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": ""
}

响应参数

参数名	类型	说明
errCode	int	业务错误码，0 表示成功。
errMsg	string	错误简要信息，成功时通常为空。
errDlt	string	错误详细信息，成功时通常为空。

错误

如果请求失败，OpenIM 返回错误对象。更多错误码说明见错误码。

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

错误场景	可能原因	处理方式
鉴权失败	`token` 缺失、过期，或调用账号没有该接口权限。	重新获取有效 Token，并在可信后端调用接口。
链路追踪困难	`operationID` 缺失或在大量请求中重复使用。	为每次请求生成独立 `operationID`，并在服务端日志中保留。
参数校验失败	请求体字段类型、必填字段或消息内容结构不符合接口要求。	对照请求体参数表和限制说明检查字段。

权限和限制

撤回指定消息，并向相关用户同步撤回通知。
conversationID、seq 和 userID 必填。
操作者必须具备撤回该消息的权限。
建议在业务侧记录撤回操作者、原因和原消息定位信息，便于审计。

HTTP 请求

请求示例

参数

请求头

请求体

响应

响应参数

错误

权限和限制

相关页面