好友请求

好友请求全流程:发起、查询、接受、拒绝;对方同意后双方好友列表实时更新。

平台调用风格

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

接口一览​

操作语义传输返回
sendFriendRequest发起好友申请;已是好友/已有 pending → 1003;被拉黑 → 1011。REST(客户端)FriendRequest
getFriendRequests好友申请列表(incoming/outgoing,pending/all)。REST(客户端)FriendRequest[]
acceptFriendRequest同意申请,双向建立好友关系。REST(客户端)FriendRequest
rejectFriendRequest拒绝申请。REST(客户端)FriendRequest

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

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
sendFriendRequestsendFriendRequestsendFriendRequestsendFriendRequestsendFriendRequestsendFriendRequest—func
getFriendRequestsgetFriendRequestsgetFriendRequestsgetFriendRequestsgetFriendRequestsgetFriendRequests—func
acceptFriendRequestacceptFriendRequestacceptFriendRequestacceptFriendRequestacceptFriendRequestacceptFriendRequest—func
rejectFriendRequestrejectFriendRequestrejectFriendRequestrejectFriendRequestrejectFriendRequestrejectFriendRequest—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 侧

sendFriendRequest​

发起好友申请;已是好友/已有 pending → 1003;被拉黑 → 1011。

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

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

参数
参数类型说明
toUserIdstring必填;接收方用户 ID
messagestring可选;字段含义见类型定义
返回

FriendRequest 好友申请实体

错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1004USER_NOT_FOUND客户端 / 参数 / 权限404否用户不存在
1011BLOCKED客户端 / 参数 / 权限403否已被对方拉黑或你已拉黑对方

getFriendRequests​

好友申请列表(incoming/outgoing,pending/all)。

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

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

参数
参数类型说明
options{type?:'incoming'|'outgoing', status?:'pending'|'all'}可选;选项对象(字段见类型列):{ type?:'incoming'|'outgoing', status?:'pending'|'all' }
返回

FriendRequest[] 好友申请列表

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

acceptFriendRequest​

同意申请,双向建立好友关系。

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

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

参数
参数类型说明
requestIdstring必填;好友申请 ID
返回

FriendRequest 好友申请实体

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

rejectFriendRequest​

拒绝申请。

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

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

参数
参数类型说明
requestIdstring必填;好友申请 ID
返回

FriendRequest 好友申请实体

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

相关文档​