会话标签与分组

按业务维度（例如「工作」「校务」「订单」）把会话挂到标签上：标签增删改查、会话批量挂载/摘除、标签内分页与未读汇总、标签内置顶。标签是服务端状态，多端共享。

平台调用风格

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

接口一览​

操作语义传输返回
createConversationTag创建会话标签（tagName ≤16；单用户 ≤20 个，超出抛 1031）。REST（客户端）ConversationTag
updateConversationTag重命名会话标签。REST（客户端）ConversationTag
deleteConversationTag删除会话标签（同时清除标签内会话引用）。REST（客户端）void
getConversationTags获取全部会话标签（含会话数量）。REST（客户端）ConversationTag[]
addConversationsToTag把会话加入标签（≤100/次，幂等；≤1000/标签，超出抛 1033）。REST（客户端）{added:int, existing:int, conversationCount:int}
removeConversationsFromTag把会话移出标签（≤100/次，幂等）。REST（客户端）{removed:int, conversationCount:int}
getConversationsFromTagByPage分页获取标签内会话（含置顶/未读数/最后消息时间）。REST（客户端）{total:int, items:ConversationTagConversation[]}
getTagsFromConversation查询某个会话所属的标签列表。REST（客户端）ConversationTag[]
getUnreadCountByTag标签内未读汇总（消息总数 + 有未读的会话数）。REST（客户端）{unreadCount:int, unreadConversations:int, conversationCount:int}
setConversationToTopInTag标签内置顶/取消置顶会话（同步会话会话级置顶状态）。REST（客户端）void

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

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
createConversationTagcreateConversationTagcreateConversationTagcreateConversationTagcreateConversationTagcreateConversationTag—func
updateConversationTagupdateConversationTagupdateConversationTagupdateConversationTagupdateConversationTagupdateConversationTag—func
deleteConversationTagdeleteConversationTagdeleteConversationTagdeleteConversationTagdeleteConversationTagdeleteConversationTag—func
getConversationTagsgetConversationTagsgetConversationTagsgetConversationTagsgetConversationTagsgetConversationTags—func
addConversationsToTagaddConversationsToTagaddConversationsToTagaddConversationsToTagaddConversationsToTagaddConversationsToTag—func
removeConversationsFromTagremoveConversationsFromTagremoveConversationsFromTagremoveConversationsFromTagremoveConversationsFromTagremoveConversationsFromTag—func
getConversationsFromTagByPagegetConversationsFromTagByPagegetConversationsFromTagByPagegetConversationsFromTagByPagegetConversationsFromTagByPagegetConversationsFromTagByPage—func
getTagsFromConversationgetTagsFromConversationgetTagsFromConversationgetTagsFromConversationgetTagsFromConversationgetTagsFromConversation—func
getUnreadCountByTaggetUnreadCountByTaggetUnreadCountByTaggetUnreadCountByTaggetUnreadCountByTaggetUnreadCountByTag—func
setConversationToTopInTagsetConversationToTopInTagsetConversationToTopInTagsetConversationToTopInTagsetConversationToTopInTagsetConversationToTopInTag—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 侧

createConversationTag​

创建会话标签（tagName ≤16；单用户 ≤20 个，超出抛 1031）。

本平台 C ABI 未暴露该方法
REST（客户端）since 1.2.0

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

参数
参数类型说明
tagNamestring必填；字段含义见类型定义
options{tagId?:string}可选；选项对象（字段见类型列）：{ tagId?:string }
返回

ConversationTag 成功返回的数据；失败时按错误码处理

错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1031TAG_LIMIT_EXCEEDED客户端 / 参数 / 权限400否单用户会话标签数超过上限（20）

updateConversationTag​

重命名会话标签。

本平台 C ABI 未暴露该方法
REST（客户端）幂等since 1.2.0

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

参数
参数类型说明
tagIdstring必填；字段含义见类型定义
tagNamestring必填；字段含义见类型定义
返回

ConversationTag 成功返回的数据；失败时按错误码处理

错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1032TAG_NOT_FOUND客户端 / 参数 / 权限404否标签不存在

deleteConversationTag​

删除会话标签（同时清除标签内会话引用）。

本平台 C ABI 未暴露该方法
REST（客户端）幂等since 1.2.0

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

参数
参数类型说明
tagIdstring必填；字段含义见类型定义
返回

void 成功返回的数据；失败时按错误码处理

错误码
错误码名称分类HTTP可重试说明
1032TAG_NOT_FOUND客户端 / 参数 / 权限404否标签不存在

getConversationTags​

获取全部会话标签（含会话数量）。

本平台 C ABI 未暴露该方法
REST（客户端）幂等since 1.2.0

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

返回

ConversationTag[] ConversationTag 列表

该操作未声明专属错误码；失败时按 SDK 通用错误处理，见 状态码。

addConversationsToTag​

把会话加入标签（≤100/次，幂等；≤1000/标签，超出抛 1033）。

本平台 C ABI 未暴露该方法
REST（客户端）幂等since 1.2.0

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

参数
参数类型说明
tagIdstring必填；字段含义见类型定义
conversationsConversationRef[]必填；字段含义见类型定义
返回

{added:int, existing:int, conversationCount:int} 成功返回的数据；失败时按错误码处理

错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1032TAG_NOT_FOUND客户端 / 参数 / 权限404否标签不存在
1033TAG_CONVERSATION_LIMIT_EXCEEDED客户端 / 参数 / 权限400否标签内会话数超过上限（1000）

removeConversationsFromTag​

把会话移出标签（≤100/次，幂等）。

本平台 C ABI 未暴露该方法
REST（客户端）幂等since 1.2.0

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

参数
参数类型说明
tagIdstring必填；字段含义见类型定义
conversationsConversationRef[]必填；字段含义见类型定义
返回

{removed:int, conversationCount:int} 成功返回的数据；失败时按错误码处理

错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1032TAG_NOT_FOUND客户端 / 参数 / 权限404否标签不存在

getConversationsFromTagByPage​

分页获取标签内会话（含置顶/未读数/最后消息时间）。

本平台 C ABI 未暴露该方法
REST（客户端）幂等since 1.2.0

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

参数
参数类型说明
tagIdstring必填；字段含义见类型定义
options{offset?:uint32, limit?:uint32}可选；选项对象（字段见类型列）：{ offset?:uint32, limit?:uint32 }
返回

{total:int, items:ConversationTagConversation[]} 成功返回的数据；失败时按错误码处理

错误码
错误码名称分类HTTP可重试说明
1032TAG_NOT_FOUND客户端 / 参数 / 权限404否标签不存在

getTagsFromConversation​

查询某个会话所属的标签列表。

本平台 C ABI 未暴露该方法
REST（客户端）幂等since 1.2.0

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

参数
参数类型说明
conversationTypeConversationType必填；会话类型枚举（ConversationType）
targetIdstring必填；目标会话 ID：单聊为对方 userId，群聊为 groupId，聊天室为 chatroomId
返回

ConversationTag[] ConversationTag 列表

该操作未声明专属错误码；失败时按 SDK 通用错误处理，见 状态码。

getUnreadCountByTag​

标签内未读汇总（消息总数 + 有未读的会话数）。

本平台 C ABI 未暴露该方法
REST（客户端）幂等since 1.2.0

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

参数
参数类型说明
tagIdstring必填；字段含义见类型定义
返回

{unreadCount:int, unreadConversations:int, conversationCount:int} 成功返回的数据；失败时按错误码处理

错误码
错误码名称分类HTTP可重试说明
1032TAG_NOT_FOUND客户端 / 参数 / 权限404否标签不存在

setConversationToTopInTag​

标签内置顶/取消置顶会话（同步会话会话级置顶状态）。

本平台 C ABI 未暴露该方法
REST（客户端）幂等since 1.2.0

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

参数
参数类型说明
tagIdstring必填；字段含义见类型定义
conversationTypeConversationType必填；会话类型枚举（ConversationType）
targetIdstring必填；目标会话 ID：单聊为对方 userId，群聊为 groupId，聊天室为 chatroomId
topbool必填；字段含义见类型定义
返回

void 成功返回的数据；失败时按错误码处理

错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1034CONVERSATION_NOT_FOUND客户端 / 参数 / 权限404否会话不存在（标签内置顶等操作要求会话已在标签内）

相关文档​