好友列表

好友关系由服务端托管，支持搜索用户、备注、删除好友。

平台调用风格

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

接口一览​

操作语义传输返回
getFriends好友列表（含备注/在线/拉黑标记）。REST（客户端）[{userId:string,name?:string,avatarUrl?:string,remark?:string,online?:bool,blacklisted?:bool}]
searchUsers搜索用户（userId/name，大小写不敏感，排除自己）。REST（客户端）{users:[{userId:string,name:string,isFriend:bool,blacklisted:bool}], total:uint32}
setFriendRemark设置好友备注（<=64 字，空串清除）。REST（客户端）null
deleteFriend双向删除好友。REST（客户端）null

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

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
getFriendsgetFriendsgetFriendsgetFriendsgetFriendsgetFriends—func
searchUserssearchUserssearchUserssearchUserssearchUserssearchUsers—func
setFriendRemarksetFriendRemarksetFriendRemarksetFriendRemarksetFriendRemarksetFriendRemark—func
deleteFrienddeleteFrienddeleteFrienddeleteFrienddeleteFrienddeleteFriend—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 侧

getFriends​

好友列表（含备注/在线/拉黑标记）。

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

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

返回

[{userId:string,name?:string,avatarUrl?:string,remark?:string,online?:bool,blacklisted?:bool}] 成功返回的数据；失败时按错误码处理

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

searchUsers​

搜索用户（userId/name，大小写不敏感，排除自己）。

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

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

参数
参数类型说明
keywordstring必填；搜索关键词（大小写不敏感）
options{limit?:uint32}可选；选项对象（字段见类型列）：{ limit?:uint32 }
返回

{users:[{userId:string,name:string,isFriend:bool,blacklisted:bool}], total:uint32} 成功返回的数据；失败时按错误码处理

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

setFriendRemark​

设置好友备注（<=64 字，空串清除）。

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

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

参数
参数类型说明
friendIdstring必填；好友用户 ID
remarkstring必填；好友备注（<=64 字，空串清除）
返回

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

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

deleteFriend​

双向删除好友。

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

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

参数
参数类型说明
friendIdstring必填；好友用户 ID
返回

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

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

相关文档​