好友请求

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

平台调用风格

双语言同契约：Swift 用 async -> RcResult<T>（错误码在 RcResult.code，返回 null 的 op 用 RcResult<Void>）；Objective-C 用 - (void)opWithParam:... completion:(void (^)(RcResult *))completion，回调在主线程投递。

接口一览​

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

本页 4 个操作，其中 4 个在本平台绑定中声明了方法签名。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
sendFriendRequestsendFriendRequestsendFriendRequestsendFriendRequestsendFriendRequestsendFriendRequest—func
getFriendRequestsgetFriendRequestsgetFriendRequestsgetFriendRequestsgetFriendRequestsgetFriendRequests—func
acceptFriendRequestacceptFriendRequestacceptFriendRequestacceptFriendRequestacceptFriendRequestacceptFriendRequest—func
rejectFriendRequestrejectFriendRequestrejectFriendRequestrejectFriendRequestrejectFriendRequestrejectFriendRequest—func

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

sendFriendRequest​

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

func sendFriendRequest(toUserId: String, message: String?) async -> RcResult<IMPFriendRequest>
REST（客户端）since 1.0.0
参数
参数类型说明
toUserIdstring必填；接收方用户 ID
messagestring可选；字段含义见类型定义
返回

FriendRequest 好友申请实体

示例（Swift / Objective-C）​

let res = await client.sendFriendRequest(toUserId: "user2", message: nil)
if res.code != 0 { print("IM 调用失败：\(res.msg ?? "")") }
[client sendFriendRequestWithToUserId:@"user2" message:nil completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败：%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1004USER_NOT_FOUND客户端 / 参数 / 权限404否用户不存在
1011BLOCKED客户端 / 参数 / 权限403否已被对方拉黑或你已拉黑对方

getFriendRequests​

好友申请列表（incoming/outgoing，pending/all）。

func getFriendRequests(options: IMPFriendRequestQuery?) async -> RcResult<[IMPFriendRequest]>
REST（客户端）since 1.0.0
参数
参数类型说明
options{type?:'incoming'|'outgoing', status?:'pending'|'all'}可选；选项对象（字段见类型列）：{ type?:'incoming'|'outgoing', status?:'pending'|'all' }
返回

FriendRequest[] 好友申请列表

示例（Swift / Objective-C）​

let res = await client.getFriendRequests(options: nil)
if res.code != 0 { print("IM 调用失败：\(res.msg ?? "")") }
[client getFriendRequestsWithOptions:nil completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败：%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

acceptFriendRequest​

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

func acceptFriendRequest(requestId: String) async -> RcResult<IMPFriendRequest>
REST（客户端）since 1.0.0
参数
参数类型说明
requestIdstring必填；好友申请 ID
返回

FriendRequest 好友申请实体

示例（Swift / Objective-C）​

let res = await client.acceptFriendRequest(requestId: "req_1001")
if res.code != 0 { print("IM 调用失败：\(res.msg ?? "")") }
[client acceptFriendRequestWithRequestId:@"req_1001" completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败：%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

rejectFriendRequest​

拒绝申请。

func rejectFriendRequest(requestId: String) async -> RcResult<IMPFriendRequest>
REST（客户端）since 1.0.0
参数
参数类型说明
requestIdstring必填；好友申请 ID
返回

FriendRequest 好友申请实体

示例（Swift / Objective-C）​

let res = await client.rejectFriendRequest(requestId: "req_1001")
if res.code != 0 { print("IM 调用失败：\(res.msg ?? "")") }
[client rejectFriendRequestWithRequestId:@"req_1001" completion:^(IMPOSResult *result) {
    if (result.code != 0) { NSLog(@"IM 调用失败：%ld %@", (long)result.code, result.msg); }
}];
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

相关文档​