消息管理

支持消息撤回(默认 2 分钟窗口,可在控制台调整)与本地消息全文搜索。

平台调用风格

双语言同契约:Swift 用 async -> RcResult<T>(错误码在 RcResult.code,返回 null 的 op 用 RcResult<Void>);Objective-C 用 - (void)opWithParam:... completion:(void (^)(RcResult *))completion,回调在主线程投递。

接口一览​

操作语义传输返回
recallMessage撤回消息(仅发送者、撤回时限内)。成功后本地与对端收到 MESSAGE_RECALLED。WS 长连接Message
searchMessages在当前用户全部会话中搜索文本消息(倒序)。REST(客户端){messages:Message[], total:uint32}

本页 2 个操作,其中 2 个在本平台绑定中声明了方法签名。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
recallMessagerecallMessagerecallMessagerecallMessagerecallMessagerecallMessageim_client_recallfunc
searchMessagessearchMessagessearchMessagessearchMessagessearchMessagessearchMessages—func

方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。

recallMessage​

撤回消息(仅发送者、撤回时限内)。成功后本地与对端收到 MESSAGE_RECALLED。

func recallMessage(messageId: String) async -> RcResult<IMPMessage>
WS 长连接since 1.0.0
参数
参数类型说明
messageIdstring必填;消息 ID(服务端生成)
返回

Message 消息实体(messageId、seq、发送状态)

示例(Swift / Objective-C)​

let res = await client.recallMessage(messageId: "m_10001")
if res.code != 0 { print("IM 调用失败:\(res.msg ?? "")") }
[client recallMessageWithMessageId:@"m_10001" completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败:%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1004USER_NOT_FOUND客户端 / 参数 / 权限404否用户不存在
1022RECALL_EXPIRED客户端 / 参数 / 权限400否超过撤回时限
1023MESSAGE_ALREADY_RECALLED客户端 / 参数 / 权限400否消息已撤回
3001SDK_NOT_CONNECTEDSDK 本地0是长连接未就绪

searchMessages​

在当前用户全部会话中搜索文本消息(倒序)。

func searchMessages(options: IMPSearchMessagesOptions) async -> RcResult<IMPMessageSearchResult>
REST(客户端)since 1.0.0
参数
参数类型说明
options{keyword:string, limit?:uint32}必填;选项对象(字段见类型列):{ keyword:string, limit?:uint32 }
返回

{messages:Message[], total:uint32} 搜索结果与命中总数

示例(Swift / Objective-C)​

let res = await client.searchMessages(options: IMPSearchMessagesOptions(keyword: "你好"))
if res.code != 0 { print("IM 调用失败:\(res.msg ?? "")") }
[client searchMessagesWithOptions:@{ @"keyword": @"你好", @"limit": @0 } completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败:%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

相关文档​