浏览 SDKs · HarmonyOS
平台
SDKsHarmonyOS商业版

创建群组

创建群组并配置初始管理员和普通成员。

复制

创建群组时提供初始群资料、普通成员列表和管理员列表。当前接口不通过参数另行指定群主;创建完成后,以返回群资料中的 ownerUserID 为准。

参数说明

参数类型是否必填说明
groupNamestring群名称。
adminUserIDsstring[]初始管理员用户 ID;没有管理员时传空数组。
memberUserIDsstring[]初始普通成员用户 ID;没有普通成员时传空数组。
groupIDstring由业务预先指定的群组 ID;通常省略并由服务端生成。
notificationstring初始群公告。
introductionstring初始群简介。
faceURLstring群头像地址。
needVerificationGroupNeedVerification入群验证策略。
lookMemberInfoGroupLookMemberInfo成员资料查看权限。
applyMemberFriendGroupApplyMemberFriend群内添加好友权限。
exstring群组扩展字符串。

成员列表应先去重,并确保管理员和普通成员列表没有交集。

import sdk, { CreateGroupReq, CreateGroupResp } from '@openimsdk/imsdk';

const request: CreateGroupReq = {
  groupName: '项目讨论组',
  faceURL: 'https://example.com/group.png',
  adminUserIDs: ['user_002'],
  memberUserIDs: ['user_003', 'user_004'],
};
const response: CreateGroupResp = await sdk.createGroup(request);
openGroupPage(response.groupInfo.groupID);

Promise 成功后返回新建的 IMGroup。可以立即用于群资料页;收到加入群组事件后,再按 groupID 合并已加入群组列表。完整监听见群组概览