会话列表
获取会话列表与单个会话详情;会话按置顶优先、更新时间倒序排列。
平台调用风格
双语言同契约:Swift 用 async -> RcResult<T>(错误码在 RcResult.code,返回 null 的 op 用 RcResult<Void>);Objective-C 用 - (void)opWithParam:... completion:(void (^)(RcResult *))completion,回调在主线程投递。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
getConversationList | 会话列表:置顶优先、按 updatedAt 倒序;含未读/提及/草稿/免打扰。 | REST(客户端) | Conversation[] |
getConversation | 单会话详情。 | REST(客户端) | Conversation |
本页 2 个操作,其中 2 个在本平台绑定中声明了方法签名。
跨端方法名
| 操作 | Android | Web | Electron | macOS | Flutter | Native (C ABI) | iOS |
|---|---|---|---|---|---|---|---|
getConversationList | getConversationList | getConversationList | getConversationList | getConversationList | getConversationList | im_client_conversation_list | func |
getConversation | getConversation | getConversation | getConversation | getConversation | getConversation | — | func |
方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。
getConversationList
会话列表:置顶优先、按 updatedAt 倒序;含未读/提及/草稿/免打扰。
func getConversationList() async -> RcResult<[IMPConversation]>返回
Conversation[] 会话列表(置顶优先、updatedAt 倒序;含未读/提及/草稿/免打扰)
示例(Swift / Objective-C)
let res = await client.getConversationList()
if res.code != 0 { print("IM 调用失败:\(res.msg ?? "")") }[client getConversationListWithCompletion:^(IMPOSResult *result) {
if (result.code != 0) { NSLog(@"IM 调用失败:%ld %@", (long)result.code, result.msg); }
}];该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。
getConversation
单会话详情。
func getConversation(conversationType: IMPConversationType, targetId: String) async -> RcResult<IMPConversation>参数
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 必填;会话类型枚举(ConversationType) |
targetId | string | 必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId |
返回
Conversation 会话实体(未读数、置顶、草稿、免打扰)
示例(Swift / Objective-C)
let res = await client.getConversation(conversationType: .privateChat, targetId: "user2")
if res.code != 0 { print("IM 调用失败:\(res.msg ?? "")") }[client getConversationWithConversationType:1 /* 单聊 */ targetId:@"user2" completion:^(IMPOSResult *result) {
if (result.code != 0) { NSLog(@"IM 调用失败:%ld %@", (long)result.code, result.msg); }
}];错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南