主题
撤回
消息
message.recallPLATFORM API
选择接入平台
平台选择会在 API 页面之间保留。下面始终展示该端真实公开入口。
调用参数
conversationIDString必填目标会话 ID,来自会话查询或创建单聊的返回结果。
serverMessageIDString必填服务端消息 ID,来自消息查询或发送回执。
mutationIDString必填本次写操作的幂等 ID;重试时保持不变。
expectedRevisionUInt64必填上一次查询返回的版本号,用于避免覆盖他人的新修改。
返回与后续处理
成功结果通过 onSuccess 返回,失败信息通过 onFailure 返回。方法本身返回可取消请求。
可复制代码
request = client.recall(
conversationID: conversationID,
serverMessageID: serverMessageID,
mutationID: mutationID,
expectedRevision: expectedRevision,
onSuccess: { value in
// 使用返回结果更新数据或页面
},
onFailure: { error in
// 按 error.stableCode 处理
}
)功能说明
message.recall 属于“消息”。上方平台选择器会显示当前端的真实方法名、参数和调用示例。
- 调用前提: 除非页面特别说明,该方法要求当前账号已经连接,输入也必须属于该账号。
- 详细规则: 查看本分类的参数和状态说明。
- 跨端提醒: 各端方法名遵循各自语言习惯,请直接复制当前平台的示例。
参数与调用方式
页面顶部会列出必填/可选参数、参数用途和可复制代码。iOS/macOS 默认使用 onSuccess/onFailure,Android 默认使用 Java CompletableFuture;Web、Electron 和小程序未提供的能力会明确显示“不支持”,不会给出无效示例。
需要幂等键或版本号的方法,请使用上一次成功查询返回的值;不要自行猜测或拼接。
返回、错误与取消
| 结果 | 应用怎么处理 |
|---|---|
| 成功 | 使用返回结果刷新当前数据或页面;收到后续事件时再重新查询。 |
invalid_argument | 检查空值、数组数量、重复 ID 和页面标注的版本参数。 |
invalid_state | 确认当前账号已连接,并且没有在登出或换号。 |
unsupported | 当前 SDK 或服务端版本没有此能力;提示升级,不要当成空结果。 |
request_cancelled | 停止当前等待;写操作再查询一次结果,避免重复提交。 |
完整错误字段见 模型、枚举与错误。