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

邀请用户加入群组

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

复制

具备邀请权限的群主或管理员可以调用邀请用户加入群组接口。客户端可以根据当前成员的 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 已完成邀请请求,不代表被邀请用户已经立即出现在群成员列表中。根据群组加群策略,邀请可能需要被邀请人同意或管理员审批;只有当新成员真正加入群组并收到群成员加入事件后,再将其按 groupID:userID 加入成员列表。完整成员事件监听与处理逻辑请参考分页查询群成员。