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

申请加入群组

提交入群申请,或在群组无需审核时直接加入。

复制

向指定群组发起加入请求。是否需要管理员审核由群组的 needVerification 配置决定,joinSource 记录用户发起申请的来源途径。

参数说明

参数类型是否必填说明
groupIDstring是目标群组 ID。
reqMsgstring是申请说明;没有说明时传空字符串。
joinSourceOpenIMGroupJoinSource是入群途径,取值见下表。
exstring否业务扩展字符串。
枚举值数值含义
OpenIMGroupJoinSourceAdmin1由管理员添加;通常用于管理流程,不作为普通用户自助入口。
OpenIMGroupJoinSourceInvitation2通过邀请加入。
OpenIMGroupJoinSourceSearch3通过搜索加入。
OpenIMGroupJoinSourceQRCode4通过二维码加入。
import {
  OpenIMGroupJoinSourceSearch,
  joinGroup,
} from '@/uni_modules/unix-openim-sdk'

await joinGroup({
  groupID: groupID,
  reqMsg: '申请加入项目讨论组',
  joinSource: OpenIMGroupJoinSourceSearch,
})

Promise 成功表示入群请求已发送至服务端。若该群开启了入群验证,调用成功不代表当前用户已成为群成员,须等待管理员审核;审核通过并收到群组加入事件后,按 groupID 更新已加入群组列表。完整群组事件监听见群组概览。

无需审核时也建议以加入事件或重新查询的结果确认最终成员状态,不要仅根据按钮操作修改本地权限。