IM即时通讯

群成员管理

获取群成员列表

获取指定群的群成员信息。调用者必须加入此群才可调用;由于是从 APP 本地获取,一次建议最大10000。

  • 调用接口:
const {data: memberList} = await IMSDK.getGrpMemberList({
    groupID: "groupID",
    filter: 0,
    offset: 0,
    count: 10,
})

相关API请参考:

获取群内指定群成员信息

获取群内指定的群成员信息,仅本群成员可调用。

  • 调用接口:
  const { data: memberList } = await IMSDK.getSpecifiedGrpMembersInfo({
  groupID: "groupID",
  userIDList: ["userID"],
});

相关API请参考:

加入群组

申请加入群组,根据进群验证选项确定申请进群结果。

  • 调用接口:
await IMSDK.joinGrp({
    groupID: "groupID";
    reqMsg: "申请信息";
    joinSource: 3;
})

相关API请参考:

相关回调请参考:

获取发出的入群申请列表

用户可获取自己发出的入群申请列表来查看申请状态

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

相关API请参考:

获取收到的入群申请列表

群主或管理员可获取成员的入群申请列表进行同意入群申请或拒绝入群申请操作

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

相关API请参考:

同意入群申请

群主或管理员调用接口可同意成员的入群申请,会触发申请方的onGrpReqAccepted回调

  • 调用接口:
await IMSDK.acceptGrpReq({
    groupID: "groupID",
    fromUserID: "userID",
    handleMsg: "处理消息",
})

相关API请参考:

相关回调请参考:

拒绝入群申请

群主或管理员调用接口可拒绝成员的入群申请,会触发申请方的onGrpReqRejected回调

  • 调用接口:
await IMSDK.refuseGrpReq({
    groupID: "groupID",
    fromUserID: "userID",
    handleMsg: "处理消息",
})

相关API请参考:

相关回调请参考:

邀请入群

群组成员可邀请其他用户加入群组,无须对方同意,支持批量邀请。

  • 调用接口:
IMSDK.inviteUserToGrp({
    groupID: "groupID",
    reason: "邀请原因",
    userIDList: ["userID1", "userID2"],
});

相关API请参考:

相关回调请参考:

踢出群

把群成员从群组中移除。群主和群管理员可移除普通成员,群主可移除管理员和普通成员。

  • 调用接口:
await IMSDK.kickGrpMember({
    groupID: "groupID",
    reason: "踢出原因",
    userIDList: ["userID1", "userID2"]
})

相关API请参考:

相关回调请参考:

设置群成员昵称

群主可以修改管理员和普通成员的昵称,管理员可以修改普通成员的昵称。

  • 调用接口:
await IMSDK.setGrpMemberInfo({
    groupID: "groupID",
    userID: "userID",
    nickname: "newNickname",
});

相关API请参考:

相关回调请参考:

禁言群成员

群主可以禁言管理员和普通成员,管理员可以禁言普通成员。

  • 调用接口:
await IMSDK.changeGrpMemberMute({
    groupID: "groupID",
    userID: "userID",
    mutedSeconds: 10*60,
})

相关API请参考:

修改群成员身份

群主可以修改管理员和普通成员的身份,管理员可以修改普通成员的身份。

  • 调用接口:
await IMSDK.setGrpMemberInfo({
    groupID: "groupID",
    userID: "userID",
    roleLevel: 60,
});

相关API请参考:

相关回调请参考:

搜索群成员

通过关键词搜索某个群的群成员。至少指定搜索UserID、搜索昵称中的一个搜索方式。

  • 调用接口:
const {data: memberList} = await IMSDK.searchGrpMembers({
    groupID: "groupID"
    keywordList: ["关键词"],
    isSearchUserID: true,
    isSearchMemberNickname: true,
    offset: 0,
    count: 10,
})

相关API请参考: