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

邀请用户入群

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

复制

群主和管理员可以在 OpenIMServer 授予的权限范围内管理群成员。客户端可以根据成员资料中的 roleLevel 控制操作入口,但服务端仍负责最终权限校验。

参数说明

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

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

提交前应先对 userIDList 去重。邀请原因可能对目标用户可见,不要写入 Token 等敏感信息。

Promise 成功表示服务端接受了邀请请求,不代表所有用户已经出现在成员列表。需要审核时可能先产生申请事件;成员真正加入后再按 onGroupMemberAdded 合并。成员事件的完整监听见分页查询群成员