浏览 SDKs · React Native
平台
SDKsReact Native

邀请用户加入群组

邀请一个或多个用户加入指定群组。

复制

邀请一个或多个用户加入指定群组。

await OpenIMSDK.inviteUserToGroup({
  groupID: 'group-001',
  reason: '邀请加入项目讨论组',
  userIDList: ['user-002', 'user-003'],
});

参数说明

参数类型必填含义
groupIDstring是目标群组 ID。
reasonstring是邀请说明;没有说明时传空字符串。
userIDListstring[]是要邀请的用户 ID 数组。

返回结果

调用完成后,加群邀请请求已提交成功。

受邀用户成功加入群组后,会触发 OnGroupMemberAdded 事件。客户端应以 groupID:userID 复合标识向成员列表添加新记录,并以 groupID 关联所属群组。完整事件监听说明见分页查询群成员。