# pedroslopez/whatsapp-web.js

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/pedroslopez-whatsapp-web-js).**

21,210 stars · 4,854 forks · JavaScript · apache-2.0

## Links

- GitHub: https://github.com/pedroslopez/whatsapp-web.js
- Homepage: https://wwebjs.dev
- awesome-repositories: https://awesome-repositories.com/repository/pedroslopez-whatsapp-web-js.md

## Topics

`api` `bot` `bot-api` `hacktoberfest` `whatsapp` `whatsapp-api` `whatsapp-bot` `whatsapp-web` `whatsapp-web-api`

## Description

This project is a Node.js framework designed for headless browser automation, enabling the creation of automated messaging clients. It functions by controlling a headless browser instance to programmatically interact with the messaging interface, allowing developers to simulate user sessions and manage complex chat workflows.

The library distinguishes itself through its comprehensive session management and event-driven architecture. It supports persistent authentication by serializing session data to local or remote storage, ensuring that automated clients can maintain continuous connectivity across restarts without requiring repeated manual pairing. By hooking into real-time messaging events and DOM mutations, the framework allows for the execution of automated tasks triggered by incoming data streams.

Beyond basic messaging, the project provides extensive administrative and analytical capabilities. It includes tools for managing group and channel membership, synchronizing chat history, and performing administrative actions on contact profiles. The framework also handles media processing, including the conversion of files into platform-specific formats like stickers, and supports advanced interaction features such as poll creation, interactive button transmission, and user activity simulation.

The repository provides a complete environment for building and monitoring automated communication bots, including diagnostic utilities for tracking system health and connection status.

## Tags

### Networking & Communication

- [Messaging Automation Clients](https://awesome-repositories.com/f/networking-communication/messaging-automation-clients.md) — Builds automated messaging bots that interact with messaging platforms by simulating user sessions and managing chat workflows.
- [Group Administration Tools](https://awesome-repositories.com/f/networking-communication/group-administration-tools.md) — Updates group metadata including subjects, descriptions, and messaging permissions to control group behavior and access for all members. ([source](https://docs.wwebjs.dev/GroupChat.html))
- [Messaging Interfaces](https://awesome-repositories.com/f/networking-communication/messaging-interfaces.md) — Provides programmatic control over the messaging interface to simulate user actions and manage chat states. ([source](https://docs.wwebjs.dev/ProductMetadata.html))
- [Messaging Automation](https://awesome-repositories.com/f/networking-communication/communication-platforms-services/messaging-notification-systems/messaging-automation.md) — Enables automated user interactions by exchanging text, media, and location data programmatically. ([source](https://docs.wwebjs.dev/index.html))
- [Client Session Management](https://awesome-repositories.com/f/networking-communication/network-reliability-diagnostics/connection-session-management/client-session-management.md) — Authenticates and maintains persistent connections to messaging accounts to enable continuous automated communication without manual re-login. ([source](https://docs.wwebjs.dev/ProductMetadata.html))
- [Messaging Channel Management](https://awesome-repositories.com/f/networking-communication/messaging-channel-management.md) — Provides administrative controls for managing channel settings, notification preferences, and participant interaction rules within automated messaging environments. ([source](https://docs.wwebjs.dev/Channel.html))
- [Participant Management](https://awesome-repositories.com/f/networking-communication/communication-protocols-architectures/communication-paradigms/group-membership-management/participant-management.md) — Adds, removes, promotes, or demotes group members by their identifiers to maintain group membership. ([source](https://docs.wwebjs.dev/GroupChat.html))
- [Interactive Polls](https://awesome-repositories.com/f/networking-communication/interactive-polls.md) — Creates and sends structured poll messages with selectable options for participant voting. ([source](https://docs.wwebjs.dev/Poll.html))
- [Invitation Processing](https://awesome-repositories.com/f/networking-communication/invite-link-management/invitation-link-management/invitation-processing.md) — Joins groups automatically by processing invite links to enable seamless participation. ([source](https://docs.wwebjs.dev/Message.html))
- [Message Synchronization](https://awesome-repositories.com/f/networking-communication/message-synchronization.md) — Synchronizes past message history to enable programmatic analysis and archival. ([source](https://docs.wwebjs.dev/Chat.html))
- [Membership Request Handling](https://awesome-repositories.com/f/networking-communication/communication-protocols-architectures/communication-paradigms/group-membership-management/membership-request-handling.md) — Lists and approves or rejects pending requests from users attempting to join a group. ([source](https://docs.wwebjs.dev/GroupChat.html))
- [Contact Management](https://awesome-repositories.com/f/networking-communication/contact-management.md) — Fetches profile information including status updates, formatted phone numbers, country codes, and profile picture URLs for any contact. ([source](https://docs.wwebjs.dev/))

### Development Tools & Productivity

- [Headless Browser Automation](https://awesome-repositories.com/f/development-tools-productivity/headless-browser-automation.md) — Controls a headless browser instance to programmatically navigate the messaging interface and execute manual user actions.
- [Label-Based Chat Filtering](https://awesome-repositories.com/f/development-tools-productivity/chat-based-administration-interfaces/label-based-chat-filtering.md) — Fetches all chat threads associated with specific labels to filter and process conversations based on assigned categories. ([source](https://docs.wwebjs.dev/Label.html))

### Security & Cryptography

- [Session Authentication](https://awesome-repositories.com/f/security-cryptography/session-authentication.md) — Initializes client connections, handles pairing code authentication, and manages session logout or state resets to maintain secure access. ([source](https://docs.wwebjs.dev/Client.html))
- [Stateful Session Persistence](https://awesome-repositories.com/f/security-cryptography/identity-access-management/session-management/stateful-session-persistence.md) — Serializes browser authentication cookies and local storage data to disk to maintain persistent sessions across application restarts.
- [External Database Persistence](https://awesome-repositories.com/f/security-cryptography/identity-access-management/session-management/stateful-session-persistence/external-database-persistence.md) — Stores authentication session data in external databases to maintain persistent connections across multiple server instances or application restarts. ([source](https://docs.wwebjs.dev/RemoteAuth.html))

### Web Development

- [Messaging Frameworks](https://awesome-repositories.com/f/web-development/asynchronous-messaging-frameworks/messaging-frameworks.md) — Provides a runtime environment for executing programmatic communication tasks and managing persistent messaging sessions.

### System Administration & Monitoring

- [Event Monitoring](https://awesome-repositories.com/f/system-administration-monitoring/event-monitoring.md) — Provides real-time event listeners for incoming messages and status updates to trigger automated workflows. ([source](https://docs.wwebjs.dev/window.WWebJS.html))
- [Browser Debugging Protocols](https://awesome-repositories.com/f/system-administration-monitoring/browser-debugging-protocols.md) — Communicates with the browser engine to inject scripts, intercept network traffic, and observe real-time events within the page.
- [Health Monitoring](https://awesome-repositories.com/f/system-administration-monitoring/health-monitoring.md) — Tracks operational status, connection states, and device metadata to ensure system health. ([source](https://docs.wwebjs.dev/Client.html))

### User Interface & Experience

- [Browser-Based Interface Bridges](https://awesome-repositories.com/f/user-interface-experience/ui-control-interfaces/browser-based-interface-bridges.md) — Maps high-level programmatic commands to low-level browser actions to manipulate UI components and messaging states directly.
- [UI Control Interfaces](https://awesome-repositories.com/f/user-interface-experience/ui-control-interfaces.md) — Offers programmatic control over the visibility and state of UI elements to navigate the messaging interface. ([source](https://docs.wwebjs.dev/InterfaceController.html))
- [Chat Organization](https://awesome-repositories.com/f/user-interface-experience/chat-organization.md) — Associates specific labels with chat threads to organize conversations and manage workflows effectively. ([source](https://docs.wwebjs.dev/Label.html))
- [Interactive Message Components](https://awesome-repositories.com/f/user-interface-experience/interactive-message-components.md) — Transmits interactive buttons within messages to trigger specific actions or responses. ([source](https://docs.wwebjs.dev/Buttons.html))

### Business & Productivity Software

- [Engagement Automation](https://awesome-repositories.com/f/business-productivity-software/engagement-automation.md) — Automates replies, reactions, and poll participation to maintain engagement in chat threads. ([source](https://docs.wwebjs.dev/index.html))
- [Group Management](https://awesome-repositories.com/f/business-productivity-software/group-management.md) — Joins groups, updates configuration settings, and performs participant administration including adding, removing, or changing member roles. ([source](https://docs.wwebjs.dev/))
- [Messaging Channel Administration](https://awesome-repositories.com/f/business-productivity-software/messaging-channel-administration.md) — Invites, promotes, demotes, and transfers ownership of channels to other users to delegate management tasks and maintain channel operations. ([source](https://docs.wwebjs.dev/Channel.html))
- [Real-time Monitoring](https://awesome-repositories.com/f/business-productivity-software/real-time-monitoring.md) — Monitors live communication streams and platform activities to enable automated responses and logging. ([source](https://docs.wwebjs.dev/Client.html))
- [Contact Management](https://awesome-repositories.com/f/business-productivity-software/contact-management.md) — Retrieves contact details and profile images while updating user status messages or blocking and muting specific conversations. ([source](https://docs.wwebjs.dev/index.html))
- [Invitation Management](https://awesome-repositories.com/f/business-productivity-software/group-management/invitation-management.md) — Retrieves, revokes, or regenerates group invite codes to control how new members join. ([source](https://docs.wwebjs.dev/GroupChat.html))
- [Membership Administration](https://awesome-repositories.com/f/business-productivity-software/group-management/membership-administration.md) — Joins groups via invitations and performs administrative tasks such as adding, removing, or modifying participant roles. ([source](https://docs.wwebjs.dev/index.html))
- [Product Catalogs](https://awesome-repositories.com/f/business-productivity-software/product-catalogs.md) — Stores and retrieves item details including pricing, quantities, and media assets to facilitate automated inventory or commerce interactions. ([source](https://docs.wwebjs.dev/Product.html))
- [Business Profiles](https://awesome-repositories.com/f/business-productivity-software/business-profiles.md) — Retrieves profile information including status, country codes, phone numbers, and profile picture URLs for professional business accounts. ([source](https://docs.wwebjs.dev/BusinessContact.html))
- [Customer Interaction Histories](https://awesome-repositories.com/f/business-productivity-software/customer-interaction-histories.md) — Adds, edits, or retrieves internal notes associated with specific chats to track customer details or interaction history for future reference. ([source](https://docs.wwebjs.dev/PrivateChat.html))
- [Group Identity Management](https://awesome-repositories.com/f/business-productivity-software/group-management/group-identity-management.md) — Updates group subjects, descriptions, or profile pictures to reflect current group status. ([source](https://docs.wwebjs.dev/GroupChat.html))
- [Channel Lifecycle Management](https://awesome-repositories.com/f/business-productivity-software/messaging-channel-administration/channel-lifecycle-management.md) — Removes created channels from the platform to terminate their existence and clear all associated data from the system. ([source](https://docs.wwebjs.dev/Channel.html))

### Data & Databases

- [Chat History Synchronization](https://awesome-repositories.com/f/data-databases/data-engineering-infrastructure/data-persistence-storage/data-storage/metadata-state-management/chat-history-synchronization.md) — Fetches, clears, or synchronizes message history to ensure local state reflects the current conversation status at all times. ([source](https://docs.wwebjs.dev/GroupChat.html))

### Software Engineering & Architecture

- [Event-Driven Messaging Hooks](https://awesome-repositories.com/f/software-engineering-architecture/software-architecture/architectural-patterns/reactive-messaging/reactive-event-driven-systems/event-driven-messaging-hooks.md) — Listens for incoming data streams and DOM mutations to trigger automated workflows upon specific messaging platform events.
- [Asynchronous Task Queues](https://awesome-repositories.com/f/software-engineering-architecture/asynchronous-task-queues.md) — Manages the flow of outgoing media and text packets to ensure reliable delivery while maintaining non-blocking execution of tasks.

### Testing & Quality Assurance

- [User Interaction Simulation](https://awesome-repositories.com/f/testing-quality-assurance/automation-interaction-tools/user-interaction-simulation.md) — Simulates human presence by marking messages as seen and mimicking typing or recording states. ([source](https://docs.wwebjs.dev/Chat.html))

### Artificial Intelligence & ML

- [Chat Interaction Controls](https://awesome-repositories.com/f/artificial-intelligence-ml/chat-interaction-controls.md) — Controls bot behaviors by reacting to messages, voting in polls, and managing chat settings. ([source](https://docs.wwebjs.dev/))
- [Chat History APIs](https://awesome-repositories.com/f/artificial-intelligence-ml/chat-history-apis.md) — Manages chat thread states including archiving, deleting, and muting conversations. ([source](https://docs.wwebjs.dev/Chat.html))
- [Context Retrieval Systems](https://awesome-repositories.com/f/artificial-intelligence-ml/context-retrieval-systems.md) — Retrieves historical conversation data and shared group context for automated processing. ([source](https://docs.wwebjs.dev/PrivateContact.html))

### Graphics & Multimedia

- [Sticker Converters](https://awesome-repositories.com/f/graphics-multimedia/media-processing-analysis/media-manipulation/media-processing/sticker-converters.md) — Transforms images or videos into specific formats required for messaging platform stickers. ([source](https://docs.wwebjs.dev/Util.html))