在线状态

查询单用户/批量用户的在线状态；支持多端在线聚合。

平台调用风格

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

接口一览​

操作语义传输返回
getOnlineStatus查询单个用户在线状态。REST（客户端）{userId:string, online:bool, sessionCount:uint32}
getOnlineStatusBatch批量在线状态（<=100）。REST（客户端）{items:[{userId:string,online:bool,sessionCount:uint32}]}

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

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
getOnlineStatusgetOnlineStatusgetOnlineStatusgetOnlineStatusgetOnlineStatusgetOnlineStatus—func
getOnlineStatusBatchgetOnlineStatusBatchgetOnlineStatusBatchgetOnlineStatusBatchgetOnlineStatusBatchgetOnlineStatusBatch—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 侧

getOnlineStatus​

查询单个用户在线状态。

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

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

参数
参数类型说明
userIdstring必填；用户 ID
返回

{userId:string, online:bool, sessionCount:uint32} 单用户在线状态

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

getOnlineStatusBatch​

批量在线状态（<=100）。

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

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

参数
参数类型说明
userIdsstring[]必填；用户 ID 列表（批量接口通常有上限）
返回

{items:[{userId:string,online:bool,sessionCount:uint32}]} 批量在线状态

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

相关文档​