好友请求

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

平台调用风格

回调式(callback-last):有返回数据用 ResultCallback<T>,无返回数据用 OperationCallback;所有回调在主线程投递。

接口一览​

操作语义传输返回
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。

sendFriendRequest(toUserId: String, message: String? = null, callback: ResultCallback<FriendRequest>)
REST(客户端)since 1.0.0
参数
参数类型说明
toUserIdstring必填;接收方用户 ID
messagestring可选;字段含义见类型定义
返回

FriendRequest 好友申请实体

示例
Kotlin
client.sendFriendRequest(
    toUserId = "user2",
    callback = object : ResultCallback<FriendRequest> {
        override fun onSuccess(result: FriendRequest) { /* 处理返回数据 */ }
        override fun onError(error: IMError) { /* 处理 error.code */ }
    },
)
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1004USER_NOT_FOUND客户端 / 参数 / 权限404否用户不存在
1011BLOCKED客户端 / 参数 / 权限403否已被对方拉黑或你已拉黑对方

getFriendRequests​

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

getFriendRequests(options: FriendRequestQuery? = null, callback: ResultCallback<List<FriendRequest>>)
REST(客户端)since 1.0.0
参数
参数类型说明
options{type?:'incoming'|'outgoing', status?:'pending'|'all'}可选;选项对象(字段见类型列):{ type?:'incoming'|'outgoing', status?:'pending'|'all' }
返回

FriendRequest[] 好友申请列表

示例
Kotlin
client.getFriendRequests(
    callback = object : ResultCallback<List<FriendRequest>> {
        override fun onSuccess(result: List<FriendRequest>) { /* 处理返回数据 */ }
        override fun onError(error: IMError) { /* 处理 error.code */ }
    },
)
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

acceptFriendRequest​

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

acceptFriendRequest(requestId: String, callback: ResultCallback<FriendRequest>)
REST(客户端)since 1.0.0
参数
参数类型说明
requestIdstring必填;好友申请 ID
返回

FriendRequest 好友申请实体

示例
Kotlin
client.acceptFriendRequest(
    requestId = "req_1001",
    callback = object : ResultCallback<FriendRequest> {
        override fun onSuccess(result: FriendRequest) { /* 处理返回数据 */ }
        override fun onError(error: IMError) { /* 处理 error.code */ }
    },
)
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

rejectFriendRequest​

拒绝申请。

rejectFriendRequest(requestId: String, callback: ResultCallback<FriendRequest>)
REST(客户端)since 1.0.0
参数
参数类型说明
requestIdstring必填;好友申请 ID
返回

FriendRequest 好友申请实体

示例
Kotlin
client.rejectFriendRequest(
    requestId = "req_1001",
    callback = object : ResultCallback<FriendRequest> {
        override fun onSuccess(result: FriendRequest) { /* 处理返回数据 */ }
        override fun onError(error: IMError) { /* 处理 error.code */ }
    },
)
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

相关文档​