Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/devlikeapro/waha

WAHA - WhatsApp HTTP API (REST API) that you can configure in a click! Two engines: chromium-based WEBJS and pure-websocket NOWEB
https://github.com/devlikeapro/waha

ai-bot bot http-api python-bot whatsapp whatsapp-api whatsapp-automation whatsapp-bot whatsapp-chat whatsapp-web whatsapp-web-api

Last synced: 2 days ago
JSON representation

WAHA - WhatsApp HTTP API (REST API) that you can configure in a click! Two engines: chromium-based WEBJS and pure-websocket NOWEB

Awesome Lists containing this project

README 

        
# WAHA





  




**WAHA** - **W**hats**A**pp **H**TTP **A**PI (REST API) that you can install on your own server and run in less than 5 minutes!



[![Docker Pulls](https://img.shields.io/docker/pulls/devlikeapro/whatsapp-http-api)](https://hub.docker.com/r/devlikeapro/waha)



- Documentation: [https://waha.devlike.pro/](https://waha.devlike.pro/)

- Swagger Example: [https://waha.devlike.pro/swagger](https://waha.devlike.pro/swagger)



# Tables of Contents



- [Features](#features)

  * [Messages](#messages)

  * [Sessions](#sessions)

  * [Security](#security)

  * [Updates](#updates)

  * [Groups](#groups)

  * [Contacts](#contacts)

- [Quick start](#quick-start)

  * [Requirements](#requirements)

  * [Send your first message](#send-your-first-message)

    + [1. Download image](#1-download-image)

    + [2. Run WhatsApp HTTP API](#2-run-whatsapp-http-api)

    + [3. Start a new session](#3-start-a-new-session)

    + [4. Get and scan QR](#4-get-and-scan-qr)

    + [5. Get the screenshot](#5-get-the-screenshot)

    + [6. Send a text message](#6-send-a-text-message)

  * [What is next?](#what-is-next)



# Features



## Messages

- Send messages  

- Receive messages  

- Message replies  

- Send location  

- Receive location  

- React to messages  

- Send media (images/documents/files) 

- Send voice messages 

- Receive media (images/audio/video/documents) 

- Receive messages - webhook retries 



## Sessions

- Multi Device  

- Get the screenshot  

- Session saving (don't have to scan QR on every restart) 

- Single WhatsApp account running inside one container 

- Multiple WhatsApp account running inside one container 



## Security

- Swagger panel authentication 

- API authentication 



## Updates

- Bug fixes and updates come as soon as they are implemented. 



## Groups

- Create a group

- Get invite for group

- Modify group info (subject, description)

- Add group participants

- Kick group participants

- Promote/demote group participants



## Contacts

- Mute/unmute chats

- Block/unblock contacts

- Get contact info

- Get profile pictures

- Get presence (online\offline\typing) status



# 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!



{{< details "Why Docker?" >}}

Docker makes it easy to ship all-in-one solution with the runtime and dependencies. You don't have to worry about

language-specific libraries or chrome installation.



Also Docker makes installation and update processes so simple, just one command!

{{< /details >}}



## 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](https://docs.docker.com/get-docker/), let's download the image.



```bash

docker pull devlikeapro/waha

```



```bash

docker login -u devlikeapro -p {KEY}

docker pull devlikeapro/waha-plus

docker logout

```



Read more about how to get `PASSWORD` for [Plus Version →]({{< relref "plus-version" >}})



### 2. Run WhatsApp HTTP API



Run WhatsApp HTTP API:



```bash

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/](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:

```json

{

  "name": "default"

}

```



By using the request with `name` values you can start multiple session (WhatsApp accounts) inside the single docker container in Plus



### 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](http://localhost:3000/) 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:

```json

{

  "chatId": "[email protected]",

  "text": "Hi there!",

  "session": "default"

}

```



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



```bash

# 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!](https://waha.devlike.pro/docs/overview/introduction/)