Relevant source files

The following files were used as context for generating this wiki page: - [src/Socket/groups.ts](https://github.com/WhiskeySockets/Baileys/blob/main/src/Socket/groups.ts) - [src/Types/GroupMetadata.ts](https://github.com/WhiskeySockets/Baileys/blob/main/src/Types/GroupMetadata.ts) - [src/Socket/communities.ts](https://github.com/WhiskeySockets/Baileys/blob/main/src/Socket/communities.ts) - [src/Socket/chats.ts](https://github.com/WhiskeySockets/Baileys/blob/main/src/Socket/chats.ts) - [WAProto/WAProto.proto](https://github.com/WhiskeySockets/Baileys/blob/main/WAProto/WAProto.proto) - [src/Types/Message.ts](https://github.com/WhiskeySockets/Baileys/blob/main/src/Types/Message.ts)

# Groups Management The Groups Management module in Baileys provides the core logic for interacting with WhatsApp groups and communities. It handles the creation, modification, and retrieval of group metadata, as well as participant management and administrative controls. This system is built upon a WebSocket-based architecture that communicates with WhatsApp servers using BinaryNodes (encoded protobufs). The module extends the base chat functionality, allowing developers to manage lifecycle events such as joining via invite links, promoting members to administrators, updating group descriptions, and handling community-specific structures like linked subgroups. Sources: [src/Socket/groups.ts](), [src/Socket/communities.ts](), [src/Types/GroupMetadata.ts]() ## Architecture and Core Logic Groups Management is implemented through the `makeGroupsSocket` factory function, which enhances a base chat socket with group-specific capabilities. It relies on `iq` (Information Query) stanzas with the `w:g2` namespace to perform operations on the server. ### Group Query Mechanism Most group operations follow a standard request-response pattern where an `iq` node of type `get` or `set` is sent to a group JID or the general group server (`@g.us`). ```mermaid flowchart TD A[Client Request] --> B{Action Type} B -- get --> C[IQ Query Type: get] B -- set --> D[IQ Query Type: set] C --> E[WhatsApp Server] D --> E E --> F[BinaryNode Response] F --> G[Extract Metadata/Result] ``` The query mechanism is the backbone for fetching metadata and performing administrative tasks. Sources: [src/Socket/groups.ts:16-25]() ### Group Metadata Structure Group data is encapsulated in the `GroupMetadata` interface. This structure tracks essential group properties, including ownership, participant lists, and security settings. | Field | Type | Description | | :--- | :--- | :--- | | `id` | `string` | The unique JID of the group (e.g., `12345@g.us`). | | `subject` | `string` | The display name of the group. | | `owner` | `string` | JID of the group creator. | | `participants` | `GroupParticipant[]` | Array of members and their admin status. | | `restrict` | `boolean` | If true, only admins can modify group settings. | | `announce` | `boolean` | If true, only admins can send messages. | | `isCommunity` | `boolean` | Indicates if the group is a parent community. | Sources: [src/Types/GroupMetadata.ts:18-53]() ## Participant Management The system supports several actions to manage members within a group, defined by the `ParticipantAction` type: `add`, `remove`, `promote`, `demote`, and `modify`. ```mermaid sequenceDiagram participant User as Client Application participant Sock as GroupsSocket participant WA as WhatsApp Server User->>Sock: groupParticipantsUpdate(jid, [u1, u2], 'promote') Sock->>WA: ...... WA-->>Sock: Sock-->>User: [{status: "200", jid: "u1"}] ``` Administrative actions return a status code for each participant affected, where "200" typically signifies success. Sources: [src/Socket/groups.ts:117-130](), [src/Types/GroupMetadata.ts:10]() ## Communities and Linked Groups Baileys implements Community support through `makeCommunitiesSocket`. Communities act as umbrella structures that can contain multiple subgroups. ### Key Community Features * **Parent-Child Relationships:** Subgroups are linked to a parent community via the `linkedParent` property. * **Membership Approval:** Communities often utilize a `membership_approval_mode` where admins must approve join requests. * **Subgroup Creation:** Specific methods exist for creating groups directly linked to a community. ### Data Model for Communities ```mermaid erDiagram COMMUNITY ||--o{ SUBGROUP : contains COMMUNITY { string id string subject boolean isCommunity } SUBGROUP { string id string linkedParent boolean isCommunityAnnounce } PARTICIPANT }|--|| SUBGROUP : belongs_to ``` Sources: [src/Socket/communities.ts:116-160](), [src/Types/GroupMetadata.ts:38-46]() ## Invite Systems Groups and Communities support two primary invite methods: URL-based codes and V4 (Direct) invites. ### Invite Operations 1. **Invite Codes:** The socket can request a temporary join code (`groupInviteCode`) or revoke an existing one (`groupRevokeInvite`). 2. **V4 Invites:** Direct invites sent to users that include an expiration timestamp and an admin signature. 3. **Joining:** The `groupAcceptInvite` method is used for joining via a code, while `groupAcceptInviteV4` handles direct message-based invites. Sources: [src/Socket/groups.ts:149-195](), [WAProto/WAProto.proto:1159-1168]() ## Group Settings and Controls Administrators can toggle various group-wide flags to control member behavior. These are handled via `groupSettingUpdate` and `groupToggleEphemeral`. | Setting | Function | Binary Tag | | :--- | :--- | :--- | | Announcement Mode | Restricts messaging to admins. | `announcement` / `not_announcement` | | Locked Mode | Restricts settings changes to admins. | `locked` / `unlocked` | | Member Add Mode | Controls if members can add others. | `admin_add` / `all_member_add` | | Ephemeral Messages | Sets auto-delete duration. | `ephemeral` | Sources: [src/Socket/groups.ts:219-236]() ## Summary Groups Management in Baileys is a robust implementation of the WhatsApp Group G2 protocol. By leveraging `BinaryNode` queries and the `WAProto` definitions, it provides a comprehensive API for managing both standard groups and complex community hierarchies. The system ensures state consistency by emitting `groups.update` events whenever participating groups are fetched or "dirty" bits are cleared by the server. Sources: [src/Socket/groups.ts:63-75](), [src/Socket/chats.ts:1063-1075]()