IM即时通讯

好友关系

添加朋友

发起好友申请,请求添加对方为好友。

  • 调用接口:
await IMSDK.addFriend({
    toUserID: "userID",
    reqMsg: "str",
});

相关API请参考:

相关回调请参考:

获取收到的好友申请

获取收到的好友申请,可调用同意好友申请或拒绝好友申请处理申请

  • 调用接口:
const {data: reqList} = await IMSDK.getFriendReqListAsRecipient();

相关API请参考:

获取发出的好友申请

获取发出的好友申请状态

  • 调用接口:
const {data: reqList} = await IMSDK.getFriendReqListAsApplicant();

相关API请参考:

同意好友申请

同意对方添加自己为好友,会触发申请方的onFriendReqAccepted回调

  • 调用接口:
await IMSDK.acceptFriendReq({
    toUserID: "userID",
    handleMsg: "处理原因",
});

相关API请参考:

相关回调请参考:

拒绝好友申请

拒绝对方添加自己为好友,会触发申请方的OnFriendReqRejected回调

  • 调用接口:
await IMSDK.refuseFriendReq({
    toUserID: "userID",
    handleMsg: "处理原因",
});

相关API请参考:

相关回调请参考:

获取好友列表

  • 调用接口:
const {data: list} = await IMSDK.getFriendList()

相关API请参考:

获取好友信息

调用接口获取好友的头像、昵称信息,可批量获取

  • 调用接口:
const {data: list} = await IMSDK.getSpecifiedFriendsInfo(["userID1", "userID2"]);

相关API请参考:

检查是否好友关系

检验好友关系,判断是否在自己的好友列表中。

  • 调用接口:
const {data: friendshipInfoList} = await IMSDK.checkFriend(["userID1", "userID2"]);

相关API请参考:

设置好友备注

  • 调用接口:
await IMSDK.setFriendRemark({
    toUserID: "userID",
    remark: "备注昵称",
});

相关API请参考:

相关回调请参考:

删除好友

删除好友。好友关系是相互的,删除时将导致双方都互不为好友;删除好友并不会自动删除会话,如要删除会话,可以再调用删除会话的函数。

  • 调用接口:
await IMSDK.deleteFriend("userID");

相关API请参考:

相关回调请参考:

搜索本地好友

在自己的好友列表中通过关键词搜索。至少需指定一个搜索域;多个域之间是或的关系。

  • 调用接口:
const {data: searchResult} = await IMSDK.searchFriends({
    keywordList: ["关键词"],
    isSearchUserID: true,
    isSearchNickname: true,
    isSearchRemark: true,
})

相关API请参考: