> ## Documentation Index > Fetch the complete documentation index at: https://mintlify.com/NapNeko/NapCatQQ/llms.txt > Use this file to discover all available pages before exploring further. # Group API > NTQQGroupApi methods for managing groups and group members ## Overview The `NTQQGroupApi` class provides comprehensive methods for managing QQ groups, including group information, member management, permissions, and group settings. ## Group Information ### getGroups Get list of all groups the bot is in. ```typescript theme={null} async getGroups(forced: boolean = false) ``` Whether to force refresh from server Array of group objects **Example:** ```typescript theme={null} const groups = await core.apis.GroupApi.getGroups(true); groups.forEach(group => { console.log(`${group.groupName} (${group.groupCode})`); }); ``` ### fetchGroupDetail Get detailed information about a specific group. ```typescript theme={null} async fetchGroupDetail(groupCode: string) ``` Group code/ID Detailed group information object **Example:** ```typescript theme={null} const detail = await core.apis.GroupApi.fetchGroupDetail('123456789'); console.log('Group name:', detail.groupName); console.log('Member count:', detail.memberCount); ``` ### searchGroup Search for a group by group code. ```typescript theme={null} async searchGroup(groupCode: string) ``` Group code to search for Group information if found ## Group Members ### getGroupMember Get information about a specific group member. ```typescript theme={null} async getGroupMember( groupCode: string | number, memberUinOrUid: string | number ): Promise ``` Group code Member UIN or UID Group member object if found **Example:** ```typescript theme={null} const member = await core.apis.GroupApi.getGroupMember('123456789', 'u_abc123'); if (member) { console.log('Member card:', member.cardName); console.log('Member role:', member.role); } ``` ### getGroupMemberAll Get all members of a group. ```typescript theme={null} async getGroupMemberAll(groupCode: string, forced: boolean = false) ``` Group code Force refresh from server Object containing map of member UID to GroupMember ### getGroupMemberEx Get extended information about a group member. ```typescript theme={null} async getGroupMemberEx( groupCode: string, uid: string, forced: boolean = false, retry: number = 2 ): Promise ``` Group code Member UID Force refresh from server Number of retry attempts ### getMemberExtInfo Get extended member information including level and title. ```typescript theme={null} async getMemberExtInfo(groupCode: string, uin: string) ``` Group code Member UIN ## Member Management ### kickMember Kick members from a group. ```typescript theme={null} async kickMember( groupCode: string, kickUids: string[], refuseForever: boolean = false, kickReason: string = '' ) ``` Group code Array of member UIDs to kick Whether to permanently ban from rejoining Reason for kicking **Example:** ```typescript theme={null} await core.apis.GroupApi.kickMember( '123456789', ['u_member1', 'u_member2'], false, 'Violation of group rules' ); ``` ### banMember Mute/unmute group members. ```typescript theme={null} async banMember( groupCode: string, memList: Array<{ uid: string, timeStamp: number }> ) ``` Group code Array of objects with uid and mute duration in seconds (0 to unmute) **Example:** ```typescript theme={null} // Mute for 10 minutes await core.apis.GroupApi.banMember('123456789', [ { uid: 'u_member1', timeStamp: 600 } ]); // Unmute await core.apis.GroupApi.banMember('123456789', [ { uid: 'u_member1', timeStamp: 0 } ]); ``` ### banGroup Enable or disable mute all in a group. ```typescript theme={null} async banGroup(groupCode: string, shutUp: boolean) ``` Group code true to enable mute all, false to disable ### getGroupShutUpMemberList Get list of muted members in a group. ```typescript theme={null} async getGroupShutUpMemberList(groupCode: string): Promise ``` Group code Array of muted member information ### setMemberCard Set a member's group card (nickname in group). ```typescript theme={null} async setMemberCard( groupCode: string, memberUid: string, cardName: string ) ``` Group code Member UID New card name ### setMemberRole Set a member's role (admin/member). ```typescript theme={null} async setMemberRole( groupCode: string, memberUid: string, role: NTGroupMemberRole ) ``` Group code Member UID New role (admin or member) ## Group Settings ### setGroupName Change group name. ```typescript theme={null} async setGroupName(groupCode: string, groupName: string) ``` Group code New group name ### setGroupRemark Set remark/note for a group. ```typescript theme={null} async setGroupRemark(groupCode: string, remark: string) ``` Group code Remark text ### setGroupAvatar Set group avatar. ```typescript theme={null} async setGroupAvatar(groupCode: string, filePath: string) ``` Group code Path to image file ### setGroupAddOption Set group join options. ```typescript theme={null} async setGroupAddOption( groupCode: string, option: { addOption: number; groupQuestion?: string; groupAnswer?: string; } ) ``` Group code Join option: 4 (question + answer), 5 (question + admin approval) Question for joining (if addOption is 4 or 5) Answer to question (if addOption is 4) ## Group Requests ### getSingleScreenNotifies Get group join/invite notifications. ```typescript theme={null} async getSingleScreenNotifies( doubt: boolean, count: number ): Promise ``` Whether to get doubt/verification requests Number of notifications to retrieve Array of group notifications ### handleGroupRequest Handle group join/invite requests. ```typescript theme={null} async handleGroupRequest( doubt: boolean, notify: GroupNotify, operateType: NTGroupRequestOperateTypes, reason?: string ) ``` Whether this is a doubt request Group notification object Operation type (approve/reject) Reason for rejection (optional) ### clearGroupNotifiesUnreadCount Clear unread count for group notifications. ```typescript theme={null} async clearGroupNotifiesUnreadCount(doubt: boolean) ``` Whether to clear doubt notifications ## Group Actions ### quitGroup Leave a group. ```typescript theme={null} async quitGroup(groupCode: string) ``` Group code to leave ### quitGroupV2 Leave a group with option to delete local messages. ```typescript theme={null} async quitGroupV2( GroupCode: string, needDeleteLocalMsg: boolean ) ``` Group code to leave Whether to delete local messages ## Group Files ### creatGroupFileFolder Create a folder in group files. ```typescript theme={null} async creatGroupFileFolder( groupCode: string, folderName: string ) ``` Group code Name of folder to create ### delGroupFile Delete files from group. ```typescript theme={null} async delGroupFile( groupCode: string, files: Array ) ``` Group code Array of file IDs to delete ### delGroupFileFolder Delete a folder from group files. ```typescript theme={null} async delGroupFileFolder( groupCode: string, folderId: string ) ``` Group code Folder ID to delete ### getGroupFileCount Get file count for groups. ```typescript theme={null} async getGroupFileCount(groupCodes: Array) ``` Array of group codes ## Group Announcements ### publishGroupBulletin Publish a group announcement. ```typescript theme={null} async publishGroupBulletin( groupCode: string, content: string, picInfo?: { id: string, width: number, height: number }, pinned: number = 0, confirmRequired: number = 0 ) ``` Group code Announcement content Optional image information Whether to pin announcement Whether confirmation is required ### deleteGroupBulletin Delete a group announcement. ```typescript theme={null} async deleteGroupBulletin( groupCode: string, noticeId: string ) ``` Group code Notice ID to delete ### uploadGroupBulletinPic Upload image for group announcement. ```typescript theme={null} async uploadGroupBulletinPic( groupCode: string, imageurl: string ) ``` Group code Image URL or path ## Group Essence ### addGroupEssence Add a message to group essence. ```typescript theme={null} async addGroupEssence(groupCode: string, msgId: string) ``` Group code Message ID to add to essence ### removeGroupEssence Remove a message from group essence. ```typescript theme={null} async removeGroupEssence(groupCode: string, msgId: string) ``` Group code Message ID to remove from essence ### fetchGroupEssenceList Get list of essence messages. ```typescript theme={null} async fetchGroupEssenceList(groupCode: string) ``` Group code ## Utilities ### createGrayTip Create a gray tip message in group. ```typescript theme={null} async createGrayTip(groupCode: string, tip: string) ``` Group code Tip text to display ### getGroupRemainAtTimes Get remaining @all count for today. ```typescript theme={null} async getGroupRemainAtTimes(groupCode: string) ``` Group code ### getArkJsonGroupShare Get group share card in Ark JSON format. ```typescript theme={null} async getArkJsonGroupShare(groupCode: string): Promise ``` Group code Ark JSON string for group share