置顶与免打扰

会话置顶在多端之间同步;免打扰会话不展示红点与角标,可保留数字。

平台调用风格

C ABI 约定:im_client_* 返回 int(0 成功,非 0 为 IDL 错误码);char** out_json 由库分配、调用方用 im_string_free 释放;char* out + size_t cap 为调用方缓冲区(0 成功 / -1 参数非法 / -2 缓冲区不足)。

接口一览​

操作语义传输返回
setConversationToTop会话置顶/取消。REST(客户端)null
setConversationNotificationLevel会话提醒级别:0 全部 / 1 仅提及 / 2 免打扰。REST(客户端)null

本页 2 个操作,其中 0 个在本平台绑定中声明了方法签名,其余为 C ABI 未暴露(见对应小节)。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
setConversationToTopsetConversationToTopsetConversationToTopsetConversationToTopsetConversationToTopsetConversationToTop—func
setConversationNotificationLevelsetConversationNotificationLevelsetConversationNotificationLevelsetConversationNotificationLevelsetConversationNotificationLevelsetConversationNotificationLevel—func

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

C ABI 未暴露

本页操作均未在正式 C ABI(include/im_sdk.h)中暴露。C ABI 当前覆盖 18 个操作:init / connect / disconnect / getConnectionStatus / getCurrentUserId / sendTextMessage / sendMessage / recallMessage / sendReadReceipt / getConversationList / getHistoryMessages / getGroupMembers / joinChatroom / leaveChatroom / getChatroomInfo / uploadFile / addEventListener / removeEventListener。其余能力请使用其它平台绑定,或通过服务端 Open API 完成。

替代路径说明
服务端 Open API会话模块接口:在服务端批量管理消息、会话、群组与用户
Web / Electron / Flutter / Android 绑定这些绑定覆盖全部 62 个语义 op;可通过服务端中转或由另一进程执行后回调 Native 侧

setConversationToTop​

会话置顶/取消。

本平台 C ABI 未暴露该方法
REST(客户端)幂等since 1.0.0

本操作未在 native C ABI(include/im_sdk.h)暴露;如需该能力,请使用 Web / Electron / Flutter / Android 绑定,或通过服务端 Open API 完成。

参数
参数类型说明
conversationTypeConversationType必填;会话类型枚举(ConversationType)
targetIdstring必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId
isTopbool必填;字段含义见类型定义
返回

null 无返回数据;成功与否通过错误码判断

错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

setConversationNotificationLevel​

会话提醒级别:0 全部 / 1 仅提及 / 2 免打扰。

本平台 C ABI 未暴露该方法
REST(客户端)幂等since 1.0.0

本操作未在 native C ABI(include/im_sdk.h)暴露;如需该能力,请使用 Web / Electron / Flutter / Android 绑定,或通过服务端 Open API 完成。

参数
参数类型说明
conversationTypeConversationType必填;会话类型枚举(ConversationType)
targetIdstring必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId
levelNotificationLevel必填;字段含义见类型定义
返回

null 无返回数据;成功与否通过错误码判断

错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

相关文档​