whatsapp-web.js

Fri, 05 Sep 2025 15:27:32 +0800

pedroslopez/whatsapp-web.js

About

A WhatsApp API client that connects through the WhatsApp Web browser app

The library works by launching the WhatsApp Web browser application and managing it using Puppeteer to create an instance of WhatsApp Web, thereby mitigating the risk of being blocked. The WhatsApp API client connects through the WhatsApp Web browser app, accessing its internal functions. This grants you access to nearly all the features available on WhatsApp Web, enabling dynamic handling similar to any other Node.js application.

[!IMPORTANT] It is not guaranteed you will not be blocked by using this method. WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn’t be considered totally safe.

Installation

The module is now available on npm! npm i whatsapp-web.js

[!NOTE] Node v18+ is required.

QUICK STEPS TO UPGRADE NODE

Windows

Manual

Just get the latest LTS from the official node website.

npm

1
2

sudo npm install -g n
sudo n stable

Choco

`1`	`choco install nodejs-lts`

Winget

`1`	`winget install OpenJS.NodeJS.LTS`

Ubuntu / Debian

1
2

curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - &&\
sudo apt-get install -y nodejs

Example usage

const { Client } = require('whatsapp-web.js');

const client = new Client();

client.on('qr', (qr) => {
    // Generate and scan this code with your phone
    console.log('QR RECEIVED', qr);
});

client.on('ready', () => {
    console.log('Client is ready!');
});

client.on('message', msg => {
    if (msg.body == '!ping') {
        msg.reply('pong');
    }
});

client.initialize();

Take a look at example.js for another examples with additional use cases.
For further details on saving and restoring sessions, explore the provided Authentication Strategies.

Supported features

Feature	Status
Multi Device	✅
Send messages	✅
Receive messages	✅
Send media (images/audio/documents)	✅
Send media (video)	✅ (requires Google Chrome)
Send stickers	✅
Receive media (images/audio/video/documents)	✅
Send contact cards	✅
Send location	✅
Send buttons	❌ (DEPRECATED)
Send lists	❌ (DEPRECATED)
Receive location	✅
Message replies	✅
Join groups by invite	✅
Get invite for group	✅
Modify group info (subject, description)	✅
Modify group settings (send messages, edit info)	✅
Add group participants	✅
Kick group participants	✅
Promote/demote group participants	✅
Mention users	✅
Mention groups	✅
Mute/unmute chats	✅
Block/unblock contacts	✅
Get contact info	✅
Get profile pictures	✅
Set user status message	✅
React to messages	✅
Create polls	✅
Channels	✅
Vote in polls	🔜
Communities	🔜

Something missing? Make an issue and let us know!

Contributing

Feel free to open pull requests; we welcome contributions! However, for significant changes, it’s best to open an issue beforehand. Make sure to review our contribution guidelines before creating a pull request. Before creating your own issue or pull request, always check to see if one already exists!

Supporting the project

You can support the maintainer of this project through the links below

Support via GitHub Sponsors
Support via PayPal
Sign up for DigitalOcean and get $200 in credit when you sign up (Referral)

Disclaimer

This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates. The official WhatsApp website can be found at whatsapp.com. “WhatsApp” as well as related names, marks, emblems and images are registered trademarks of their respective owners. Also it is not guaranteed you will not be blocked by using this method. WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn’t be considered totally safe.

License

Licensed under the Apache License, Version 2.0 (the “License”);
you may not use this project except in compliance with the License.
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

telegram-search

Wed, 28 May 2025 15:29:34 +0800

groupultra/telegram-search

Telegram Search

English | 快速开始

一个功能强大的 Telegram 聊天记录搜索工具，支持向量搜索和语义匹配。基于 OpenAI 的语义向量技术，让你的 Telegram 消息检索更智能、更精准。

欢迎 PR 贡献！
由于项目处于快速迭代阶段，可能会出现数据库不兼容的情况，建议定期备份数据。

💖 赞助者

🚀 快速开始

安装步骤

克隆仓库：

1
2

git clone https://github.com/GramSearch/telegram-search.git
cd telegram-search

安装依赖：

`1`	`pnpm install`

配置环境：

`1`	`cp config/config.example.yaml config/config.yaml`

启动数据库容器：

`1`	`docker compose up -d`

同步数据库表结构：

`1`	`pnpm run db:migrate`

启动服务：

# 启动后端服务
pnpm run dev:server

# 启动前端界面
pnpm run dev:frontend

访问 http://localhost:3333 即可打开搜索界面。

Messages on Producthunt daily