Apache License 2.0

项目介绍

devlikeapro/waha 是一个托管在 GitHub 上的开源项目,主要使用 TypeScript 编写,采用 Apache License 2.0 许可证,目前获得 7.8k 个 Star、1.9k 次 Fork。

仓库全名
devlikeapro/waha
开源许可证
Apache License 2.0
Star 数
7.8k
Fork 数
1.9k
未关闭 Issue
466

README 摘要

WAHA WAHA - WhatsApp HTTP API (REST API) that you can install on your own server and run in less than 5 minutes! Documentation: https://waha.devlike.pro/ Dashboard Example: https://waha.devlike.pro/dashboard Swagger Example: https://waha.devlike.pro/swagger Tables of Contents Quick start Requirements Send your first message 1. Download image 2. Run WhatsApp HTTP API 3. Start a new session 4. Get and scan QR 5. Get…

完整内容见 GitHub 原始 README 或本页 。

常见问题

waha 用什么语言开发?

主要使用 TypeScript 编写,采用 Apache License 2.0 许可证,目前有 7.8k 个 Star。

waha 可以免费商用吗?

仓库采用 Apache License 2.0 许可证,可免费使用与修改,商业使用请遵守许可证条款(例如保留版权声明与许可声明)。

如何获取 waha 的源码?

可以直接克隆仓库:git clone https://github.com/devlikeapro/waha.git,默认分支为 core;安装与运行步骤见仓库 README。

waha 最近还在维护吗?

仓库最近一次更新为 1 天前,当前有 466 个未关闭 Issue;Star 数为 7.8k,可作为社区活跃度的参考。

语言占比

Dockerfile
HTML
JavaScript
Makefile
Python
Shell
TypeScript

Release

README

WAHA

WAHA - WhatsApp HTTP API (REST API) that you can install on your own server and run in less than 5 minutes!

Docker Pulls

Tables of Contents

Quick start

Requirements

Only thing that you must have - installed docker. Please follow the original instruction how to install docker ->.

When you are ready - come back and follows the below steps to send the first text message to WhatsApp via HTTP API!

Send your first message

Let’s go over steps that allow you to send your first text message via WhatsApp HTTP API!

1. Download image

Assuming you have installed Docker, let’s download the image.

docker pull devlikeapro/waha

Looking for WAHA Plus? It’s now part of the main devlikeapro/waha image - all Plus features are included. Read more: WAHA 2026.6 - Plus is now Core

2. Run WhatsApp HTTP API

Run WhatsApp HTTP API:

docker run -it --rm -p 3000:3000/tcp --name waha devlikeapro/waha

# It prints logs and the last line must be
# WhatsApp HTTP API is running on: http://[::1]:3000

Open the link in your browser http://localhost:3000/ and you’ll see API documentation (Swagger).

3. Start a new session

To start a new session you should have your mobile phone with installed WhatsApp application close to you.

Please go and read how what we’ll need to a bit later: How to log in - the instruction on WhatsApp site

When your ready - find POST /api/sessions, click on Try it out, then Execute a bit below.

The example payload:

{
  "name": "default"
}

By using the request with different name values you can start multiple sessions (WhatsApp accounts) inside the single docker container.

4. Get and scan QR

Find GET /api/screenshot and execute it, it shows you QR code.

Scan the QR with your cell phone’s WhatsApp app.

5. Get the screenshot

Execute GET /api/screenshot after a few seconds after scanning the QR - it’ll show you the screenshot of you Whatsapp instance. If you can get the actual screenshot - then you’re ready to start sending messages!

6. Send a text message

Let’s send a text message - find POST /api/sendText in swagger and change chatId this way: use a phone international phone number without + symbol and add @c.us at the end.

For phone number 12132132131 the chatId is [email protected].

The example payload:

{
  "chatId": "[email protected]",
  "text": "Hi there!",
  "session": "default"
}

Also, you can use curl and send POST request like this:

# Phone without +
export PHONE=12132132130
curl -d "{\"chatId\": \"${PHONE}@c.us\", \"text\": \"Hello from WhatsApp HTTP API\" }" -H "Content-Type: application/json" -X POST http://localhost:3000/api/sendText

What is next?

Go and read the full documentation!

Development

Start the project

  1. Clone the repository
  2. Make sure you’re using node>=22 (check .nvmrc to get the version)
  3. Install the whatsapp-rust-bridge prerequisites:
# Bun runtime used by whatsapp-rust-bridge prepare scripts
curl -fsSL https://bun.sh/install | bash -s -- bun-v1.3.9

# Rust nightly toolchain used for whatsapp-rust-bridge
curl -fsSL https://sh.rustup.rs | bash -s -- -y --default-toolchain nightly-2026-01-30
rustup target add wasm32-unknown-unknown
cargo install wasm-pack --vers 0.14.0 --locked
  1. Run the following commands:
# Install dependencies
yarn install
# Fetch and compile proto files
yarn gows:proto
# Run
yarn start
# open http://localhost:3000

评论

暂无评论