浏览 SDKs · uni-app / uni-app x
平台
SDKsuni-app / uni-app x

邀请用户加入群组

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

复制

有权限的群主或管理员可以调用 inviteUserToGroup()。客户端可以根据当前成员的 roleLevel 控制入口,但最终权限仍由 OpenIMServer 校验。

参数说明

参数类型是否必填说明
groupIDstring目标群组 ID。
reasonstring邀请说明;没有说明时传空字符串。
userIDListstring[]待邀请的用户 ID;调用前应去重。
import { inviteUserToGroup } from '@/uni_modules/unix-openim-sdk'

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

Promise 成功表示 SDK 已完成邀请请求,不代表所有用户已经出现在成员列表。根据群组策略,邀请可能需要后续处理;只有成员真正加入并收到 onGroupMemberAdded() 后,才将其加入成员列表。成员事件见分页查询群成员