[core] pin node:20-bullseye

Fix #105

.dockerignore

@@ -1,5 +1,5 @@
 Dockerfile
-.sessions
+.*sessions
 files
 venv
 .wwebjs_auth
@@ -11,6 +11,7 @@ examples
 # compiled output
 /dist
 /node_modules
+.yarn
 
 # Logs
 logs

.eslintrc.js

@@ -1,27 +1,32 @@
 module.exports = {
-    parser: '@typescript-eslint/parser',
-    parserOptions: {
-        project: 'tsconfig.json',
-        sourceType: 'module',
-    },
-    plugins: ['@typescript-eslint/eslint-plugin'],
-    extends: [
-        'plugin:@typescript-eslint/eslint-recommended',
-        'plugin:@typescript-eslint/recommended',
-        'prettier',
-        'prettier/@typescript-eslint',
-    ],
-    root: true,
-    env: {
-        node: true,
-        jest: true,
-    },
-    rules: {
-        '@typescript-eslint/interface-name-prefix': 'off',
-        '@typescript-eslint/explicit-function-return-type': 'off',
-        '@typescript-eslint/explicit-module-boundary-types': 'off',
-        '@typescript-eslint/no-explicit-any': 'off',
-        "@typescript-eslint/ban-ts-ignore": "off",
-        "@typescript-eslint/ban-ts-comment": "off"
-    },
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: "tsconfig.json",
+    sourceType: "module"
+  },
+  plugins: [
+    "@typescript-eslint/eslint-plugin",
+    "simple-import-sort"
+  ],
+  extends: [
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    "prettier/@typescript-eslint"
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true
+  },
+  rules: {
+    "simple-import-sort/imports": "error",
+    "simple-import-sort/exports": "error",
+    "@typescript-eslint/interface-name-prefix": "off",
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/ban-ts-ignore": "off",
+    "@typescript-eslint/ban-ts-comment": "off",
+  }
 };

.github/clear-gh-runs.sh

@@ -0,0 +1,18 @@
+# Idea from
+# https://stackoverflow.com/a/65539398/6753144
+#
+
+OWNER=devlikeapro
+REPO=whatsapp-http-api-plus
+
+# list workflows
+gh api -X GET /repos/$OWNER/$REPO/actions/workflows | jq '.workflows[] | .name,.id'
+
+# copy the ID of the workflow you want to clear and set it
+WORKFLOW_ID=40218610
+
+# list runs
+gh api -X GET /repos/$OWNER/$REPO/actions/workflows/$WORKFLOW_ID/runs --paginate | jq '.workflow_runs[] | .id'
+
+# delete runs
+gh api -X GET /repos/$OWNER/$REPO/actions/workflows/$WORKFLOW_ID/runs --paginate | jq '.workflow_runs[] | .id' | xargs -I{} gh api -X DELETE /repos/$OWNER/$REPO/actions/runs/{} --silent

.github/workflows/build.yaml

@@ -13,6 +13,11 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+        with:
+          platforms: 'amd64'
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
 
@@ -33,12 +38,11 @@ jobs:
           password: ${{ secrets.DOCKER_TOKEN }}
 
       - name: Build and push
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v4
         with:
           context: .
           file: Dockerfile
+          platforms: 'amd64'
           push: ${{ github.ref_type == 'tag' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
-          cache-from: type=gha
-          cache-to: type=gha

.github/workflows/pages.yml

@@ -29,8 +29,9 @@ jobs:
       - name: Upload folder
         uses: actions/upload-artifact@v2
         with:
+          path: docs/site/public
           name: public
-          path: public
+          retention-days: 5
 
   deploy-github-pages:
     needs: build

.gitignore

@@ -1,8 +1,11 @@
-.sessions
+.yarn
+.*sessions
+tokens
 files
 venv
 .wwebjs_auth
 test.js
+.wwebjs_cache
 
 # compiled output
 /dist

.pre-commit-config.yaml

@@ -1,4 +1,19 @@
 repos:
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: 'v2.7.1'
+    hooks:
+      - id: prettier
+        types_or: [ javascript, ts ]
+        files: |
+          (?x)^(
+              src/.*|
+          )$
+  - repo: https://github.com/Lucas-C/pre-commit-hooks-nodejs
+    rev: v1.1.2
+    hooks:
+      - id: markdown-toc
+        name: README.md
+        files: ^README.md$
   - repo: local
     hooks:
       - id: no-plus-in-core
@@ -6,9 +21,9 @@ repos:
         language: pygrep
         entry: 'plus'
         files: |
-            (?x)^(
-                src/api/.*|
-                src/core/.*|
-                src/structures/.*|
-                src/config.service.ts|
-            )$          
+          (?x)^(
+              src/api/.*|
+              src/core/.*|
+              src/structures/.*|
+              src/config.service.ts|
+          )$

.yarnrc

@@ -0,0 +1 @@
+network-timeout 60000

.yarnrc.yml

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-3.6.1.cjs

CHANGELOG.md

@@ -0,0 +1,2 @@
+# Changelog
+You can find changelog on [the changelog page](https://waha.devlike.pro/docs/help/changelog/)

Dockerfile

@@ -1,34 +1,56 @@
 #
 # Build
 #
-FROM node:18 as build
+FROM node:20-bullseye as build
+ENV PUPPETEER_SKIP_DOWNLOAD=True
 
 # npm packages
 WORKDIR /src
 COPY package.json .
-COPY package-lock.json .
-RUN npm install
+COPY yarn.lock .
+RUN yarn set version 3.6.1
+RUN yarn install
 
 # App
 WORKDIR /src
 ADD . /src
-RUN npm run build && find ./dist -name "*.d.ts" -delete
+RUN yarn install
+RUN yarn build && find ./dist -name "*.d.ts" -delete
 
 #
 # Final
 #
-FROM node:18 as release
+FROM node:20-bullseye as release
+ENV PUPPETEER_SKIP_DOWNLOAD=True
+ARG USE_BROWSER=chromium
 
-# Install Chrome
+# Install fonts
 RUN apt-get update  \
-    && apt-get install -y wget gnupg \
-    && wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \
-    && sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' \
-    && apt-get update \
-    && apt-get install -y google-chrome-stable fonts-ipafont-gothic fonts-wqy-zenhei fonts-thai-tlwg fonts-kacst fonts-freefont-ttf \
+    && apt-get install -y fonts-ipafont-gothic fonts-wqy-zenhei fonts-thai-tlwg fonts-kacst fonts-freefont-ttf \
       --no-install-recommends \
     && rm -rf /var/lib/apt/lists/*
 
+# Install Chromium
+RUN if [ "$USE_BROWSER" = "chromium" ]; then \
+        apt-get update  \
+        && apt-get update \
+        && apt-get install -y chromium \
+          --no-install-recommends \
+        && rm -rf /var/lib/apt/lists/*; \
+    fi
+
+# Install Chrome
+RUN if [ "$USE_BROWSER" = "chrome" ]; then \
+        apt-get update  \
+        && apt-get install -y wget gnupg \
+        && wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \
+        && sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' \
+        && apt-get update \
+        && apt-get install -y google-chrome-stable \
+          --no-install-recommends \
+        && rm -rf /var/lib/apt/lists/*; \
+    fi
+
 # Attach sources, install packages
 WORKDIR /app
 COPY package.json ./
@@ -37,4 +59,4 @@ COPY --from=build /src/dist ./dist
 
 # Run command, etc
 EXPOSE 3000
-CMD npm run start:prod
+CMD yarn start:prod

Makefile

@@ -1,14 +1,8 @@
 build:
 	docker build . -t devlikeapro/whatsapp-http-api
 
-run:
-	docker run \
-		--rm -d \
-		-p 127.0.0.1:3000:3000/tcp \
-		-v `pwd`/.sessions:/app/.sessions \
-		-e WHATSAPP_HOOK_URL=https://httpbin.org/post \
-		-e WHATSAPP_HOOK_EVENTS=* \
-		--name whatsapp-http-api devlikeapro/whatsapp-http-api
+build-plus:
+	docker build . -t devlikeapro/whatsapp-http-api-plus
 
 stop:
 	docker stop whatsapp-http-api
@@ -19,5 +13,16 @@ clean: stop
 push:
 	docker push devlikeapro/whatsapp-http-api
 
+for-swagger:
+	WHATSAPP_SWAGGER_CONFIG_ADVANCED=true npm run start
+
 update-swagger:
 	wget http://localhost:3000/-json -O ./docs/site/static/swagger/openapi.json
+
+update-dependencies:
+	. ${NVM_DIR}/nvm.sh && nvm exec yarn up whatsapp-web.js@https://github.com/pedroslopez/whatsapp-web.js
+	. ${NVM_DIR}/nvm.sh && nvm exec yarn up @adiwajshing/baileys@github:WhiskeySockets/Baileys
+	. ${NVM_DIR}/nvm.sh && nvm exec yarn up venom-bot
+
+start-proxy:
+	docker run --rm -d --name squid-container -e TZ=UTC -p 3128:3128 ubuntu/squid:5.2-22.04_beta

README.md

@@ -9,9 +9,33 @@
 - Documentation: [https://waha.devlike.pro/](https://waha.devlike.pro/)
 - Swagger Example: [https://waha.devlike.pro/swagger](https://waha.devlike.pro/swagger)
 
-## Features
+# Tables of Contents
 
-### Messages
+<!-- toc -->
+
+- [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)
+
+<!-- tocstop -->
+
+# Features
+
+## Messages
 - Send messages  
 - Receive messages  
 - Message replies  
@@ -24,34 +48,160 @@
 - Receive media (images/audio/video/documents) 
 - Receive messages - webhook retries 
 
-### Sessions
+## 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
+## Security
+- Swagger panel authentication 
 - API authentication 
 
-### Updates
+## Updates
 - Bug fixes and updates come as soon as they are implemented. 
-- One month delay in bug fixes and updates. 
 
-
-### Groups [soon]
-- Join groups by invite
+## Groups
+- Create a group
 - 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
 
-### Contacts [soon]
-- Mention users
+## Contacts
 - Mute/unmute chats
 - Block/unblock contacts
 - Get contact info
 - Get profile pictures
-- Set user status message
+- Get presence (online\offline\typing) status
+
+# Quick start
+
+## Requirements
+
+Only thing that you must have - installed docker. Please follow the original
+instruction <a href="https://docs.docker.com/get-docker/" target="_blank" rel="noopener">how to install docker -></a>.
+
+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.
+
+![](./docs/site/content/en/docs/overview/quick-start//images/versions/core.png) For Core version the command is
+
+```bash
+docker pull devlikeapro/whatsapp-http-api
+```
+
+![](./docs/site/content/en/docs/overview/quick-start//images/versions/plus.png) For Plus version, we use login to get the image before:
+
+```bash
+docker login -u devlikeapro -p {PASSWORD}
+docker pull devlikeapro/whatsapp-http-api-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 whatsapp-http-api devlikeapro/whatsapp-http-api
+
+# 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).
+
+![](./docs/site/content/en/docs/overview/quick-start/swagger.png)
+
+### 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:
+<a href="https://faq.whatsapp.com/381777293328336/?helpref=hc_fnav" target="_blank">
+How to log in - the instruction on WhatsApp site
+</a>
+
+When your ready - find `POST /api/session/start`, click on **Try it out**, then **Execute** a bit below.
+
+
+The example payload:
+```json
+{
+  "name": "default"
+}
+```
+
+![](./docs/site/content/en/docs/overview/quick-start/session-start.png)
+
+By using the request with `name` values you can start multiple session (WhatsApp accounts) inside the single docker container in Plus
+![](./docs/site/content/en/docs/overview/quick-start//images/versions/plus.png) version and only one account in Core ![](./docs/site/content/en/docs/overview/quick-start//images/versions/core.png) version.
+
+Read more about [multiple sessions →]({{< relref "/docs/how-to/sessions" >}})
+
+### 4. Get and scan QR
+
+Find `GET /api/screenshot` and execute it, it shows you QR code.
+
+![](./docs/site/content/en/docs/overview/quick-start/qr.png)
+
+**Scan the QR with your cell phone's WhatsApp app.**
+
+![](./docs/site/content/en/docs/overview/quick-start/scan-qr-phone.png)
+
+### 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!
+
+![](./docs/site/content/en/docs/overview/quick-start/screenshot.png)
+
+### 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  `12132132131@c.us`.
+
+The example payload:
+```json
+{
+  "chatId": "12132132130@c.us",
+  "text": "Hi there!",
+  "session": "default"
+}
+```
+![](./docs/site/content/en/docs/overview/quick-start/send-text.png)
+
+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/)
+

docker-compose.yaml

@@ -0,0 +1,32 @@
+version: '3'
+services:
+  whatsapp-http-api:
+    image: devlikeapro/whatsapp-http-api
+    container_name: whatsapp-http-api
+    ports:
+      - "3000:3000/tcp"
+    environment:
+      # Environment variables from https://waha.devlike.pro/docs/how-to/config/
+      - WHATSAPP_HOOK_URL=https://httpbin.org/post
+      - WHATSAPP_HOOK_EVENTS=message
+      - WHATSAPP_DEFAULT_ENGINE=WEBJS
+    restart: always
+
+  whatsapp-http-api-plus:
+    image: devlikeapro/whatsapp-http-api-plus
+    container_name: whatsapp-http-api-plus
+    ports:
+      - "3000:3000/tcp"
+    volumes:
+      - "./.sessions:/app/.sessions"
+    environment:
+      # Environment variables from https://waha.devlike.pro/docs/how-to/config/
+      - WHATSAPP_RESTART_ALL_SESSIONS=True
+      - WHATSAPP_HOOK_URL=https://httpbin.org/post
+      - WHATSAPP_HOOK_EVENTS=message
+      - WHATSAPP_DEFAULT_ENGINE=WEBJS
+      - WHATSAPP_API_KEY=321
+      - WHATSAPP_SWAGGER_USERNAME=admin
+      - WHATSAPP_SWAGGER_PASSWORD=123
+      - WHATSAPP_API_HOSTNAME=localhost
+    restart: always

docs/site/config/_default/config.toml

@@ -1,4 +1,4 @@
-baseurl = "https://doks-child-theme.netlify.app/"
+baseurl = "https://waha.devlike.pro/"
 canonifyURLs = false
 disableAliases = true
 disableHugoGeneratorInject = true

docs/site/config/_default/menus/menus.en.toml

@@ -19,42 +19,81 @@
 
 [[main]]
   name = "Documentation"
+  identifier = "docs"
   url = "/docs/overview/introduction/"
-# url = "/docs/1.0/overview/introduction/"
   weight = 10
 
-#[[main]]
-#  name = "Blog"
-#  url = "/blog/"
-#  weight = 20
+[[main]]
+  name = "Introduction"
+  weight = 11
+  url = "/docs/overview/introduction"
+  parent = "docs"
 
 [[main]]
-  name = "Get Plus"
-  weight = 30
-  identifier = "get-plus"
-  url = ""
+  name = "Quick Start"
+  weight = 12
+  url = "/docs/overview/introduction"
+  parent = "docs"
 
 
+[[main]]
+  name = "Send messages"
+  weight = 14
+  url = "/docs/how-to/send-messages"
+  parent = "docs"
+
+[[main]]
+  name = "Receive Messages"
+  weight = 15
+  url = "/docs/how-to/receive-messages"
+  parent = "docs"
+
+[[main]]
+  name = "How to guides"
+  weight = 20
+  url = "/docs/how-to"
+  parent = "docs"
+
+[[main]]
+  name = "Swagger ->"
+  weight = 99
+  url = "https://waha.devlike.pro/swagger"
+  parent = "docs"
+
+[[main]]
+  name = "WAHA Plus"
+  weight = 30
+  identifier = "waha-plus"
+
 [[main]]
   name = "About WAHA Plus"
-  weight = 40
-  identifier = "plus-version"
+  weight = 10
   url = "/docs/how-to/plus-version"
-  parent = "get-plus"
+  parent = "waha-plus"
 
 [[main]]
   name = "Get on Boosty ->"
   weight = 50
-  identifier = "boosty"
   url = "https://boosty.to/wa-http-api"
-  parent = "get-plus"
+  parent = "waha-plus"
 
 [[main]]
   name = "Get on Patreon ->"
   weight = 60
-  identifier = "patreon"
   url = "https://patreon.com/wa_http_api"
-  parent = "get-plus"
+  parent = "waha-plus"
+
+[[main]]
+  name = "Examples"
+  weight = 20
+  identifier = "examples"
+
+[[main]]
+  name = "Python ->"
+  weight = 21
+  url = "https://github.com/devlikeapro/whatsapp-http-api/tree/core/examples/python"
+  parent = "examples"
+
 
 [[social]]
   name = "GitHub"

docs/site/config/_default/params.toml

@@ -4,7 +4,7 @@
 title = "WAHA"
 titleSeparator = "-"
 titleAddition = "WhatsApp HTTP API"
-description = "WAHA - WhatsApp HTTP API that you can configure in a click!"
+description = "WAHA - WhatsApp HTTP API that you can run in a click!"
 
 ## Documentation
 # docsVersion = "0.3"
@@ -71,10 +71,9 @@ footer = 'This project is not affiliated, associated, authorized, endorsed by, o
 copyRight = "Copyright (c) 2021-2023 Dev Like A Pro"
 
 # Alert
-alert = false
+alert = true
 alertDismissable = true
-# alertText = "Introducing the Doks child theme, several DX + UX updates, and more! <a class=\"alert-link stretched-link\" href=\"https://getdoks.org/blog/doks-v0.2/\" target=\"_blank\" rel=\"noopener\">Check out Doks v0.2</a>"
-alertText = "Introducing the Doks child theme, several DX + UX updates, and more! <a class=\"alert-link stretched-link\" href=\"https://getdoks.org/blog/doks-v0.2/\">Check out Doks v0.2</a>"
+alertText = "<a class=\"alert-link stretched-link\" href=\"https://waha.devlike.pro/docs/how-to/plus-version/\">Support the project and get WAHA Plus version! -></a>"
 
 # Edit Page
 # repoHost [Github | Gitea | GitLab | Bitbucket | BitbucketServer ] is used for building the edit link based on git hoster

docs/site/content/en/_index.md

@@ -1,7 +1,7 @@
 ---
 title : "WAHA"
-description: "WAHA - WhatsApp HTTP API that you can configure in a click!"
-lead: "WAHA - WhatsApp HTTP API that you can configure in a click!"
+description: "WAHA - WhatsApp HTTP API that you can run in a click!"
+lead: "WAHA - WhatsApp HTTP API that you can run in a click!"
 date: 2020-10-06T08:47:36+00:00
 lastmod: 2020-10-06T08:47:36+00:00
 draft: false

docs/site/content/en/docs/examples/_index.md

@@ -4,7 +4,7 @@ description: "Examples for different languages."
 lead: "Examples for different languages."
 date: 2020-10-06T08:49:15+00:00
 lastmod: 2020-10-06T08:49:15+00:00
-draft: true
+draft: false
 images: []
 weight: 900
 ---

docs/site/content/en/docs/examples/python.md

@@ -1,7 +1,7 @@
 ---
 title: "Python"
-description: "WhatsApp HTTP API Python example."
-lead: "WhatsApp HTTP API Python example."
+description: "WhatsApp HTTP API Python examples."
+lead: "WhatsApp HTTP API Python examples."
 date: 2020-10-06T08:49:31+00:00
 lastmod: 2020-10-06T08:49:31+00:00
 draft: false
@@ -12,41 +12,7 @@ parent: "help"
 weight: 630
 toc: true
 ---
+We've created a few examples on how to interact with WAHA WhatsApp HTTP API with Python.
 
-To show how to receive messages we've created a simple "echo" server with two functions:
+You can find the examples in [examples folder on GitHub with detailed instructions in README.md](https://github.com/devlikeapro/whatsapp-http-api/tree/core/examples/python)
 
-1. When we receive a text message - just send the text back
-2. When we receive a message with a file (an image, a voice message) - download it and send the path back ![](/images/versions/plus.png)
-
-In order to send you messages we use **Webhooks** and configure them via environments variables. So
-what you need to
-create "echo" server is HTTP server that will receive JSON POST request and then call back WhatsApp HTTP API
-via `POST /api/sendText` endpoint with JSON body.
-
-## Python echo server
-
-We use Python. Feel free to create your favorite language example and contribute to the project!
-
-Run "echo" server in one terminal and leave it working:
-
-```bash
-# if you haven't already
-git clone https://github.com/devlikeapro/whatsapp-http-api.git
-cd whatsapp-http-api
-python -mpip install -r examples/requirements.txt
-export FLASK_APP=examples/echo.py
-flask run
-```
-
-Visit [http://localhost:5000](http://localhost:5000) and check that we are good to go further.
-
-Let's start WhatsApp HTTP API and configure the "on message" webhook and point it on our "http://localhost:5000/message"
-endpoint:
-
-```bash
-docker run -it --network=host -e WHATSAPP_HOOK_URL=http://localhost:5000/message -e WHATSAPP_HOOK_EVENTS=* devlikeapro/whatsapp-http-api
-```
-
-Now go ahead, open the second whatsapp and send to our WhatsApp HTTP API a text message! It must reply the same text.
-
-![](/images/versions/plus.png) If you try to send an image the "echo server" will send a path to the downloaded file.

docs/site/content/en/docs/help/_index.md

@@ -1,10 +0,0 @@
----
-title: "Help"
-description: "Help Doks."
-lead: ""
-date: 2020-10-06T08:49:15+00:00
-lastmod: 2020-10-06T08:49:15+00:00
-draft: false
-images: []
-weight: 800
----

docs/site/content/en/docs/help/changelog.md

@@ -1,57 +0,0 @@
----
-title: "Changelog"
-description: "WAHA's changelog"
-lead: "Changelog"
-date: 2020-10-06T08:49:31+00:00
-lastmod: 2020-10-06T08:49:31+00:00
-draft: false
-images: []
-menu:
-  docs:
-    parent: "help"
-weight: 600
-toc: true
----
-
-## 2022.11
-### Engine ![](/images/versions/core.png) ![](/images/versions/plus.png)
-WAHA has changed its underlying engine from Venom to Whatsapp Web.JS. It might change the response and webhook's payloads.
-
-**Please test changes in test environment before update production!!**
-
-### Requests ![](/images/versions/core.png) ![](/images/versions/plus.png)
-- For all `/api/session/` requests use `name` field instead of `sessionName`.
-- For all "chatting" requests use `session` field instead of `sessionName`.
-
-### Sessions ![](/images/versions/plus.png)
-Now you don't have to scan QR code each time you run WAHA, WAHA saves it for you! Available only in Plus version.
-
-### Authentication ![](/images/versions/plus.png)
-Now you can authenticate all requests for WAHA - use `WHATSAPP_API_KEY=secret` environment variable to set "secret key".
-
-If `WHATSAPP_API_KEY` is set - requests must have `X-Api-Key` header with `secret` value, where `secret` - any random secret key.
-
-### Webhooks ![](/images/versions/core.png) ![](/images/versions/plus.png)
-#### Configuration
-
-Instead of setting each webhook via environment variables - we use two environments variables:
-
-- `WHATSAPP_HOOK_URL` - to set a URL
-- `WHATSAPP_HOOK_EVENTS` - to set events that are sent to the URL
-
-| Previous                                                                                                             | Current                                                                                            |
-|----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
-| <pre>WHATSAPP_HOOK_ONMESSAGE=https://httpbin.org/post <br>WHATSAPP_HOOK_ONANYMESSAGE=https://httpbin.org/post </pre> | <pre>WHATSAPP_HOOK_URL=https://httpbin.org/post <br>WHATSAPP_HOOK_EVENTS=message,message.any</pre> |
-
-#### Payload
-
-The data for webhooks are wrapped inside a new `WAWebhook` object with `event` and `payload` fields to help you identify
-which handler you should call based on `event`.
-
-```json
-{
-  "event": "message.any",
-  "payload": {
-  }
-}
-```

docs/site/content/en/docs/help/faq.md

@@ -1,27 +0,0 @@
----
-title: "FAQ"
-description: "Answers to frequently asked questions."
-lead: "Answers to frequently asked questions."
-date: 2020-10-06T08:49:31+00:00
-lastmod: 2020-10-06T08:49:31+00:00
-draft: false
-images: []
-menu:
-  docs:
-    parent: "help"
-weight: 630
-toc: true
----
-
-
-## How to build the newest Docker image locally
-
-If the changes haven't been released yet from `main` branch - you can build your own version from the git repository
-
-```bash
-git clone https://github.com/devlikeapro/whatsapp-http-api.git
-cd whatsapp-http-api
-docker build . -t devlikeapro/whatsapp-http-api
-```
-
-

docs/site/content/en/docs/help/how-to-update.md

@@ -1,34 +0,0 @@
----
-title: "How to Update"
-description: "Regularly update the installed WAHA to keep your bot stable, usable, and secure."
-lead: "Regularly update the installed WAHA to keep your bot stable, usable, and secure."
-date: 2020-11-12T13:26:54+01:00
-lastmod: 2020-11-12T13:26:54+01:00
-draft: false
-images: []
-menu:
-  docs:
-    parent: "help"
-weight: 610
-toc: true
----
-
-{{< alert icon="💡" text="Please test all new versions in the development environment before updating production!" />}}
-
-## Core
-![](/images/versions/core.png) For Core version the command is
-
-```bash
-docker pull devlikeapro/whatsapp-http-api
-```
-
-## Plus
-![](/images/versions/plus.png) For Plus version, we use login to get the image before:
-
-```bash
-docker login -u devlikeapro -p {PASSWORD}
-docker pull devlikeapro/whatsapp-http-api-plus
-docker logout
-```
-
-Read more about how to get `PASSWORD` for [Plus Version →]({{< relref "plus-version" >}})

docs/site/content/en/docs/how-to/config/index.md

@@ -1,36 +1,157 @@
 ---
-title : "Configuration"
+title: "Configuration"
 description: "Configuration"
 lead: ""
 date: 2020-10-06T08:48:45+00:00
 lastmod: 2020-10-06T08:48:45+00:00
 draft: false
-images: []
-weight: 400
+images: [ ]
+weight: 800
 ---
+
 You can configure WhatsApp HTTP API behaviour via environment variables, by adding `-e WHATSAPP_VARNAME=value` at the
 begging of the command line or by using [other options](https://docs.docker.com/engine/reference/commandline/run/)
 
 ```bash
-docker run -it -e WHATSAPP_HOOK_EVENTS=* -e WHATSAPP_HOOK_URL=https://httpbin.org/post devlikeapro/whatsapp-http-api
+docker run -it -e "WHATSAPP_HOOK_EVENTS=*" -e WHATSAPP_HOOK_URL=https://httpbin.org/post devlikeapro/whatsapp-http-api
 ```
 
+It's not necessary to always run such a long command - you can save all data in
+[docker-compose.yaml](https://github.com/devlikeapro/whatsapp-http-api/blob/core/docker-compose.yaml)
+file as described on [How to deploy page ->]({{< relref "/docs/how-to/deploy" >}}).
+
 ## Environment variables
 
+The following environment variables can be used to configure the WAHA.
+
 ### Common
+- `DEBUG=1`: Set this variable to any value to enable debug and verbose logs.
+- `WHATSAPP_API_PORT=3000`: The port number that the HTTP server will listen on. The default value is `3000`.
+- `WHATSAPP_API_HOSTNAME=localhost`: The hostname for the HTTP server. The default value is `localhost`.
 
-- `DEBUG=1` - show debug and verbose logs, set in any value
-- `WHATSAPP_API_PORT=3000` - listen port for HTTP server (default: `3000`)
-- `WHATSAPP_API_HOSTNAME=localhost` - Hostname for HTTP server (default: `localhost`)
-- `WHATSAPP_API_KEY=mysecret` - protect the api with a secret code. If you set it - add `X-Api-Key: mysecret` to all
-  requests.
-- `WHATSAPP_START_SESSION=default` - start session with the name right after launching the app
--
+### Sessions
+- `WHATSAPP_RESTART_ALL_SESSIONS=True`: Set this variable to `True` to start all **STOPPED** sessions after container
+  restarts. By default, this variable is set to `False`.
+  - Please note that this will start all **STOPPED** sessions, not just the sessions that were working before the restart. You can maintain the session list by
+    using `POST /api/session/stop` with the `logout: True` parameter or by calling `POST /api/session/logout` to remove
+    **STOPPED** sessions. You can see all sessions, including **STOPPED** sessions, in the `GET /api/sessions/all=True`
+    response.
+- `WHATSAPP_START_SESSION=session1,session2`: This variable can be used to start sessions with the specified names right
+  after launching the API. Separate session names with a comma.
 
-## File storage ![](/images/versions/plus.png)
-- `WHATSAPP_FILES_MIMETYPES` - download only these mimetypes from messages (download all files be default). Mimetypes
-  must be separated by a comma, without spaces: `audio,image/png,image/gif`. In order to choose type use prefix (
-  like `audio,image`).
-- `WHATSAPP_FILES_LIFETIME`- to keep free space files will be removed after this time (default: `180`, in seconds)
-- `WHATSAPP_FILES_FOLDER` - folder where will be stored files from chats (images, voice messages) (
-  default: `/tmp/whatsapp-files`)
+### Swagger
+- `WHATSAPP_SWAGGER_CONFIG_ADVANCED=true` - enables advanced configuration options for Swagger documentation - you can customize host, port and base URL for the requests.
+  Disabled by default.
+
+### Proxy
+#### Global proxy configuration
+If you need to use a proxy, you can set the following environment variables:
+
+- `WHATSAPP_PROXY_SERVER=localhost:3128`: Use this variable to set the proxy server in the format `host:port`, without http or https.
+- `WHATSAPP_PROXY_SERVER_USERNAME=username` and `WHATSAPP_PROXY_SERVER_PASSWORD=password`: Use these variables to set up credentials for the proxy.
+- `WHATSAPP_PROXY_SERVER_LIST=host1.example.com:3138,host2.example.com:3138`: Use this variable to set a comma-separated list of addresses to use, using a round-robin algorithm to choose the server for the session.
+- `WHATSAPP_PROXY_SERVER_INDEX_PREFIX=proxy-`: Use this variable to parse the session name for the prefix and find the appropriate session.
+  For example, if you have set `WHATSAPP_PROXY_SERVER_LIST=host-first:80,host-second:80,host-third:80` and `WHATSAPP_PROXY_SERVER_INDEX_PREFIX=proxy-` and you run `proxy-3` session, the `host-third:80` proxy will be chosen for that session.
+  This is a way to select a proxy from while you start session.
+
+#### Session proxy configuration
+You can configure proxy when you start session by setting `config.proxy` fields.
+Read more about it on [**Session page** ->]({{< relref "/docs/how-to/sessions#configure-proxy" >}}).
+
+Keep in mind that session's proxy configuration takes precedence over proxy configuration set by environment variables!
+
+
+### Security ![](/images/versions/plus.png)
+- `WHATSAPP_API_KEY=mysecret`: If you set this variable, you must include the `X-Api-Key: mysecret` header in all
+  requests to the API. This will protect the API with a secret code.
+- `WHATSAPP_SWAGGER_USERNAME=admin` and `WHATSAPP_SWAGGER_PASSWORD=admin`: These variables can be used to protect the
+  Swagger panel with `admin / admin` credentials. This does not affect API access.
+
+
+### Files ![](/images/versions/plus.png)
+
+The following environment variables can be used to configure the file storage options for the WAHA:
+
+- `WHATSAPP_FILES_MIMETYPES`: This variable can be used to download only specific mimetypes from messages. By default,
+  all files are downloaded. The mimetypes must be separated by a comma, without spaces. For
+  example: `audio,image/png,image/gif`. To choose a specific type, use a prefix (like `audio,image`).
+- `WHATSAPP_FILES_LIFETIME`: This variable can be used to set the time (in seconds) after which files will be removed to
+  free up space. The default value is `180`.
+- `WHATSAPP_FILES_FOLDER`: This variable can be used to set the folder where files from chats (images, voice messages)
+  will be stored. The default value is `/tmp/whatsapp-files`.
+
+## Examples
+
+#### Debug Mode
+
+To enable debug mode, set the `DEBUG` environment variable to any value:
+
+```
+DEBUG=1
+```
+
+#### Protecting the API with a Secret Code
+
+To protect the API with a secret code, set the `WHATSAPP_API_KEY` environment variable to your secret code:
+
+```
+WHATSAPP_API_KEY=mysecret
+```
+
+You must include the `X-Api-Key: mysecret` header in all requests to the API.
+
+#### Starting Sessions Automatically
+
+To start sessions automatically when the API is launched, set the `WHATSAPP_START_SESSION` environment variable to a
+comma-separated list of session names:
+
+```
+WHATSAPP_START_SESSION=session1,session2
+```
+
+#### Restarting All Sessions
+
+To start all **STOPPED** sessions after container restarts, set the `WHATSAPP_RESTART_ALL_SESSIONS` environment variable
+to `True`:
+
+```
+WHATSAPP_RESTART_ALL_SESSIONS=True
+```
+
+#### Protecting the Swagger Panel
+
+To protect the Swagger panel with `admin / admin` credentials, set the `WHATSAPP_SWAGGER_USERNAME`
+and `WHATSAPP_SWAGGER_PASSWORD` environment variables:
+
+```
+WHATSAPP_SWAGGER_USERNAME=admin
+WHATSAPP_SWAGGER_PASSWORD=admin
+```
+
+
+#### Downloading Specific Mimetypes
+
+To download only specific mimetypes from messages, set the `WHATSAPP_FILES_MIMETYPES` environment variable to a
+comma-separated list of mimetypes:
+
+```
+WHATSAPP_FILES_MIMETYPES=audio,image/png,image/gif
+```
+
+#### Setting the File Lifetime
+
+To set the time (in seconds) after which files will be removed to free up space, set the `WHATSAPP_FILES_LIFETIME`
+environment variable:
+
+```
+WHATSAPP_FILES_LIFETIME=300
+```
+
+#### Setting the File Storage Folder
+
+To set the folder where files from chats (images, voice messages) will be stored, set the `WHATSAPP_FILES_FOLDER`
+environment variable:
+
+```
+WHATSAPP_FILES_FOLDER=/home/user/whatsapp-files
+```

docs/site/content/en/docs/how-to/contacts/index.md

@@ -0,0 +1,101 @@
+---
+title : "Contacts"
+description: "Contacts"
+lead: ""
+date: 2020-10-06T08:48:45+00:00
+lastmod: 2020-10-06T08:48:45+00:00
+draft: false
+images: []
+weight: 130
+---
+
+Methods for contacts.
+
+{{< alert icon="👉" text="WhatsApp Web does not support adding contacts, so the API doesn't support it too." />}}
+
+## Get all contacts
+
+Get your contacts - `GET /api/contacts/all`
+
+```json
+[
+  {
+    "id": "11231231231@c.us",
+    "number": "11231231231",
+    "name": "Contact Name",
+    "pushname": "Pushname",
+    "shortName": "Shortname",
+    "isMe": true,
+    "isGroup": false,
+    "isWAContact": true,
+    "isMyContact": true,
+    "isBlocked": false
+  }
+]
+```
+
+## Get contact
+
+Get contact
+
+- `GET /api/contacts?contactId=11231231231&session=default`
+- `GET /api/contacts?contactId=11231231231@c.us&session=default`
+
+```json
+{
+  "id": "11231231231@c.us",
+  "number": "11231231231",
+  "name": "Contact Name",
+  "pushname": "Pushname",
+  "shortName": "Shortname",
+  "isMe": true,
+  "isGroup": false,
+  "isWAContact": true,
+  "isMyContact": true,
+  "isBlocked": false
+}
+```
+
+## Check phone number exists
+
+If you want to check if phone number is registered in WhatsApp (even if the number is not in your contact list) - use
+this endpoint for that.
+- `GET /api/contacts/check-exists?phone=11231231231&session=default`
+
+```json
+{
+  "numberExists": true
+}
+```
+
+## Get "about" contact
+
+- `GET /api/contacts/about?contactId=11231231231&session=default`
+
+```json
+{
+  "about": "Hi, I use WhatsApp!"
+}
+```
+
+## Get contact profile picture
+
+- `GET /api/contacts/profile-picture?contactId=11231231231&session=default`
+
+```json
+{
+  "profilePictureURL": "https://example.com/profile.jpg"
+}
+```
+
+## Block (unblock) contact
+- To block contact - `POST /api/contacts/block`
+- To unblock contact - `POST /api/contacts/unblock`
+
+Request:
+```json
+{
+  "contactId": "11231231231",
+  "session": "default"
+}
+```

docs/site/content/en/docs/how-to/deploy/index.md

@@ -0,0 +1,90 @@
+---
+title: "Deploy"
+description: "How to deploy WAHA"
+lead: ""
+date: 2020-10-06T08:48:45+00:00
+lastmod: 2020-10-06T08:48:45+00:00
+draft: false
+images: [ ]
+weight: 899
+---
+
+This page provides useful information to assist you in deploying the project.
+It includes tips on how to avoid running long command lines, how to view logs, and other helpful advice.
+
+## How to Use Docker Compose
+
+Docker Compose is a tool that allows you to define and run multi-container Docker applications. It simplifies the
+process of managing multiple containers and their dependencies. In this topic, we will walk you through how to use
+Docker Compose with the WhatsApp HTTP API.
+
+### Prerequisites
+
+Before you start, you need to have Docker and Docker Compose installed on your machine. You can download Docker from the
+official website [here](https://www.docker.com/products/docker-desktop). Docker Compose is included with Docker Desktop
+for Windows and macOS, but for Linux, you need to install it separately. You can find the installation
+instructions [here](https://docs.docker.com/compose/install/).
+
+### Getting Started
+
+To get started, you need to clone the [docker-compose.yaml](https://github.com/devlikeapro/whatsapp-http-api/blob/core/docker-compose.yaml) file to your local machine.
+Open your terminal and run the following command:
+
+```
+wget https://raw.githubusercontent.com/devlikeapro/whatsapp-http-api/core/docker-compose.yaml
+```
+
+### Running the WhatsApp HTTP API Service
+
+To start the `whatsapp-http-api` service, run the following command:
+
+```
+docker-compose up -d whatsapp-http-api
+```
+
+This will start the container in detached mode and map port 3000 to 3000 on the host machine.
+
+To stop the service, run the command:
+
+```
+docker-compose down
+```
+
+This will stop and remove the container.
+
+To restart the service, run the command:
+
+```
+docker-compose restart whtasapp-http-api
+```
+
+This will restart the container.
+
+### Viewing the Logs
+
+To view the logs for the `whatsapp-http-api` service, run the command:
+
+```
+docker-compose logs -f whatsapp-http-api
+```
+
+This will show the logs in real-time. To view the logs for the `whatsapp-http-api-plus` service,
+replace `whatsapp-http-api` with `whatsapp-http-api-plus`.
+
+To view the logs for a specific period, run the command:
+
+```
+docker-compose logs --since <time>
+```
+
+Replace `<time>` with the time period you want to view the logs for. For example, `docker-compose logs --since 1h` will
+show the logs for the past hour.
+
+### Using the WhatsApp HTTP API Services
+
+There are two services provided in the `docker-compose.yml` file - `whatsapp-http-api` and `whatsapp-http-api-plus`.
+It is important to note that these services must not be run at the same time.
+By default, the `whatsapp-http-api` service will be used.
+
+To use the `whatsapp-http-api-plus` service, you need to specify it in the command.
+

docs/site/content/en/docs/how-to/engines/index.md

@@ -0,0 +1,52 @@
+---
+title: "Engines"
+description: "Engines"
+lead: ""
+date: 2020-10-06T08:48:45+00:00
+lastmod: 2020-10-06T08:48:45+00:00
+draft: false
+images: [ ]
+weight: 800
+---
+
+Under the hood **WAHA** allows you to use two different engines. You can control what you want to run by settings
+`WHATSAPP_DEFAULT_ENGINE` environment variables.
+
+```bash
+docker run -it -e "WHATSAPP_DEFAULT_ENGINE=WEBJS" devlikeapro/whatsapp-http-api
+```
+
+If you have any problems with one engine - try another!
+
+{{< alert icon="👉" text="API responses and webhook payloads may differ significantly! We do our best to keep requests body stable between engines." />}}
+
+All engines are available in Core version ![](/images/versions/core.png)
+
+## WEBJS
+
+A WhatsApp API client that connects through the WhatsApp Web browser app.
+It uses Puppeteer to run a real instance of Whatsapp Web to avoid getting blocked.
+
+**WAHA** uses **WhatsApp WebJS** engine by default.
+
+- `WHATSAPP_DEFAULT_ENGINE=WEBJS`
+- https://github.com/pedroslopez/whatsapp-web.js
+
+## NOWEB
+
+**NOWEB** engine does not require a browser to work with WhatsApp Web, it does so directly using a WebSocket.
+Not running Chromium saves you CPU and Memory, so you can run more instances on a single server!
+
+️Working with the engine requires more attention, because it's easy to be blocked with it!
+
+⚠ Read the article before using **NOWEB** engine [How to avoid blocking ->]({{< relref "/docs/overview/how-to-avoid-blocking" >}}).
+
+- `WHATSAPP_DEFAULT_ENGINE=NOWEB`
+- https://github.com/WhiskeySockets/Baileys
+
+## VENOM
+
+It's a high-performance system developed with JavaScript to create a bot for WhatsApp
+
+- `WHATSAPP_DEFAULT_ENGINE=VENOM`
+- https://github.com/orkestral/venom

docs/site/content/en/docs/how-to/groups/index.md

@@ -0,0 +1,168 @@
+---
+title : "Groups"
+description: "Groups"
+lead: ""
+date: 2020-10-06T08:48:45+00:00
+lastmod: 2020-10-06T08:48:45+00:00
+draft: false
+images: []
+weight: 140
+---
+
+Methods for groups. Please look at swagger for details.
+
+- `{session}` - use the session name for Whatsapp instance that you created with `POST /api/session/start` endpoint
+- `{groupId}` - group id in format `123123123123@g.us`. You can get the id in a few ways:
+  - By [handling incoming message webhook]({{< relref "/docs/how-to/receive-messages" >}}).
+  - By getting all groups (see below).
+  - By creating a new group and saving the id.
+
+## Create a new group
+
+`POST /api/{session}/groups`
+
+Request:
+
+```json
+{
+  "name": "Group name",
+  "participants": [
+    {
+      "id": "123123123123@c.us"
+    }
+  ]
+}
+```
+
+## Get all groups
+
+`GET /api/{session}/groups`
+
+## Get the group
+
+`GET /api/{session}/groups/{groupId}`
+
+## Delete the group
+
+`DELETE /api/{session}/groups/{groupId}`
+
+## Leave the group
+
+`POST /api/{session}/groups/{groupId}/leave`
+
+## Set group subject
+
+Updates the group subject.
+
+Returns `true` if the subject was properly updated. This can return false if the user does not have the necessary
+permissions.
+
+`PUT /api/{session}/groups/{groupId}/subject`
+
+Request:
+
+```json
+{
+  "subject": "Group name"
+}
+```
+
+## Set group description
+
+Updates the group description.
+
+Returns `true` if the subject was properly updated. This can return false if the user does not have the necessary
+permissions.
+
+`PUT /api/{session}/groups/{groupId}/description`
+
+Request:
+
+```json
+{
+  "description": "Group description"
+}
+```
+
+## Participants
+
+### Get participants
+
+`GET /api/{session}/groups/{groupId}/participants`
+
+### Add participants
+
+`POST /api/{session}/groups/{groupId}/participants/add`
+
+```json
+{
+  "participants": [
+    {
+      "id": "123123123123@c.us"
+    }
+  ]
+}
+```
+
+### Remove participants
+
+`POST /api/{session}/groups/{groupId}/participants/remove`
+
+```json
+{
+  "participants": [
+    {
+      "id": "123123123123@c.us"
+    }
+  ]
+}
+```
+
+## Admin
+
+### Promote to admin
+
+Promote participants to admin users.
+
+`POST /api/{session}/groups/{groupId}/admin/promote`
+
+```json
+{
+  "participants": [
+    {
+      "id": "123123123123@c.us"
+    }
+  ]
+}
+```
+
+### Demote to regular users
+
+Demote participants by to regular users.
+
+`POST /api/{session}/groups/{groupId}/admin/demote`
+
+```json
+{
+  "participants": [
+    {
+      "id": "123123123123@c.us"
+    }
+  ]
+}
+```
+
+## Invite code
+
+### Get invite code
+
+`GET /api/{session}/groups/{groupId}/invite-code`
+
+Then you can put it in the url `https://chat.whatsapp.com/{inviteCode}` and send it to contacts.
+
+### Revoke invite code
+
+Invalidates the current group invite code and generates a new one.
+
+`POST /api/{session}/groups/{groupId}/invite-code/revoke`
+

docs/site/content/en/docs/how-to/plus-version/boosty.svg

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><svg width="145px" height="40px" viewBox="0 0 145 40" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><defs><linearGradient x1="61.5370404%" y1="13%" x2="34.2376801%" y2="129.365079%" id="linearGradient-1"><stop stop-color="#EF7829" offset="0%"/><stop stop-color="#F0692A" offset="28%"/><stop stop-color="#F15E2C" offset="63%"/><stop stop-color="#F15A2C" offset="100%"/></linearGradient></defs><g id="Symbols" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"><g id="Blocks/Header_Unlogged" transform="translate(-15.000000, -15.000000)"><g id="icons/boosty_logo" transform="translate(15.000000, 15.000000)"><g id="Shape"><path d="M138.119363,13.14856 L132.002653,22.63144 L131.397878,13.14856 L122.575597,13.14856 C123.384615,10.366 124.037135,8.13256 124.037135,8.13256 L124.381963,7.01848 L117.6313,7.01848 L117.312997,8.13256 L115.851459,13.14856 L108.660477,13.14856 C102.750663,13.14856 99.4244032,14.8276 98.0503979,18.00352 C97.2546419,15.09952 94.6206897,13.14856 90.5782493,13.14856 C87.2902077,13.135208 84.1128672,14.3300173 81.6551724,16.504 C80.464191,14.45536 78.1061008,13.1512 74.8116711,13.1512 C71.2975199,13.1360778 67.9189855,14.5000837 65.4084881,16.94752 C64.3103448,14.656 61.8541114,13.14856 58.3262599,13.14856 C57.1586378,13.1510938 55.9961737,13.302814 54.867374,13.6 L55.397878,11.77312 C55.4066092,11.7439195 55.4181572,11.7156279 55.4323607,11.68864 L56.7904509,7 L50.066313,7 L45.7798408,21.73384 C45.668435,22.02952 45.5676393,22.32784 45.4801061,22.63144 C45.2902336,23.2752559 45.1623364,23.9355911 45.0981432,24.60352 C44.5384615,28.714 46.3474801,31.816 51.3660477,32.0272 C51.8475451,32.0843575 52.332067,32.1125687 52.8169761,32.11168 C56.2925823,32.0722669 59.6211655,30.7100879 62.1193634,28.3048 C63.1564987,30.6148 65.5676393,32.11168 69.2970822,32.11168 C72.5436452,32.0790306 75.6705362,30.8873894 78.1087533,28.7536 C79.2493369,30.80488 81.5862069,32.11168 85.061008,32.11168 L101.917772,32.11168 C107.143236,32.11168 110.095491,31.08472 111.6313,28.85392 C111.6313,30.98176 112.851459,32.11168 115.941645,32.11168 C118.437666,32.11168 121.777188,31.5652 126.366048,30.43792 L119.687003,39.9208 L126.411141,39.9208 L144.846154,13.14856 L138.119363,13.14856 Z M58.9310345,22.63144 C58.3023873,24.79096 56.2785146,26.53336 54.4217507,26.53336 C52.5649867,26.53336 51.5676393,24.79096 52.1962865,22.63144 C52.8249337,20.47192 54.8488064,18.72688 56.6923077,18.72688 C58.535809,18.72688 59.5596817,20.464 58.9310345,22.63144 Z M75.4164456,22.63144 C74.7877984,24.79096 72.7639257,26.53336 70.9071618,26.53336 C69.0503979,26.53336 68.0769231,24.79096 68.6923077,22.63144 C69.3076923,20.47192 71.3448276,18.72688 73.2015915,18.72688 C75.0583554,18.72688 76.0344828,20.464 75.4164456,22.63144 Z M84.4562334,22.63144 C85.0848806,20.46928 87.1087533,18.72688 88.9522546,18.72688 C90.795756,18.72688 91.8090186,20.46928 91.1803714,22.63144 C90.5517241,24.7936 88.5941645,26.4832 86.7586207,26.536 L86.6074271,26.536 C84.801061,26.4832 83.8355438,24.76192 84.4562334,22.63144 Z M106.127321,25.85752 C105.787798,26.64952 103.132626,26.53072 102.466844,26.54128 L95.928382,26.536 C96.8103436,25.360374 97.4758216,24.0383816 97.8938992,22.63144 C97.9363395,22.48888 97.9734748,22.34896 98.0079576,22.20904 C98.7108753,23.2096 100.201592,24.11248 103.100796,24.68536 C105.864721,25.216 106.3687,25.05496 106.127321,25.85752 Z M112.777188,23.7244 C112.204244,21.49624 109.721485,20.6224 106.241379,20.2 C104.785146,20.02576 103.965517,19.95712 104.148541,19.3288 C104.289125,18.8404 105.018568,18.73744 106.586207,18.73744 L114.230769,18.73744 L112.777188,23.7244 Z M119.496021,23.74552 C119.496021,23.70064 120.151194,21.4804 120.952255,18.72952 L125.217507,18.72952 L125.915119,25.8364 C118.888594,27.328 118.713528,26.92672 119.496021,23.74552 L119.496021,23.74552 Z" fill="#242B2C" fill-rule="nonzero"/><path d="M1.03841146,23.8920635 L7.81508464,0 L18.2158138,0 L16.1119922,7.40740741 C16.0897554,7.44994435 16.0716695,7.49460291 16.0579948,7.54074074 L10.5357227,27.1005291 L15.6903971,27.1005291 C13.537424,32.5848325 11.8524284,36.8846561 10.6354102,40 C1.12771484,39.8920635 -1.53892578,32.9481481 0.795423177,24.7322751 L1.03841146,23.8920635 Z M10.672793,40 L23.2084961,21.6 L17.8897526,21.6 L22.5169141,9.81375661 C30.4586849,10.6603175 34.1824284,17.0285714 31.993457,24.7301587 C29.6424935,33.015873 20.1285677,40 10.8659375,40 L10.672793,40 Z" fill="url(#linearGradient-1)" fill-rule="nonzero"/></g></g></g></g></svg>

docs/site/content/en/docs/how-to/plus-version/index.md

@@ -1,6 +1,6 @@
 ---
-title : "Plus version"
-description: "Plus version"
+title : "WAHA Plus"
+description: "WAHA Plus"
 lead: ""
 date: 2020-10-06T08:48:45+00:00
 lastmod: 2020-10-06T08:48:45+00:00
@@ -9,18 +9,35 @@ images: []
 weight: 900
 ---
 
+## Overview
+
 **WAHA** is distributed in two versions:
 
 1. Core ![](/images/versions/core.png) the basic version that meet almost 80% people’s needs. 100% free and open source.
 2. Plus ![](/images/versions/plus.png) the version with advanced messages, security, and reliability features.
 
-Plus version - available through **donations** - either one time or subscription.
+ You support the project and get **WAHA Plus** on
+ <a href="https://boosty.to/wa-http-api" target="_blank">
+   <b>
+     Boosty ->
+   </b>
+ </a>
+or
+ <a href="https://patreon.com/wa_http_api" target="_blank">
+   <b>
+     Patreon ->
+   </b>
+ </a>
+.
+
+### Donations
+
+WAHA Plus version is available through **donations** (subscriptions).
 
 **It doesn't require monthly subscriptions, once installed on your server - it always works!**
+(until WhatsApp made backward-incompatible changes, and you have to update the image)
 
 {{< alert icon="💡" text="No licence checks or expiration on already installed instances!" />}}
-
-## Donations
 We do not sell **WAHA**, it's not a purchase. It's a donation.
 
 We treat our projects like art. You donate to the project and get a bit more from it as a thank-you. 😊
@@ -32,7 +49,7 @@ Treat **WAHA Plus** it as an additional episode, behind-the-scenes videos, our n
 We donate most of the donations down to the stream to the underlying libraries and tools - JS-community, Node, other libraries authors, personal contributors.
 By donating to the **WAHA** you donate to the Open Source world!
 
-## Features
+### Features
 
 The Plus additional features are:
 
@@ -42,45 +59,73 @@ The Plus additional features are:
 4. [**Security** →]({{< relref "/docs/how-to/security" >}})
 5. [**Saving sessions** →]({{< relref "/docs/how-to/sessions" >}})
 6. [**Support multiple sessions** →]({{< relref "/docs/how-to/sessions" >}})
-7. **Instant updates** - no one month delay in getting bugfixes or new features
-8. **Priority in support** - on both bugs and features
+7. **Priority in support** - on both bugs and features
 
-## Differences
+### Why WAHA?
 
-What is the difference between **WAHA Plus** and other SaaS solutions for WhatsApp HTTP API?
+What is the difference between **WAHA Plus** and **other SaaS solutions** for WhatsApp HTTP API?
 
 |                    |                     WAHA Plus                     |                                                                            Others |
 |--------------------|:-------------------------------------------------:|----------------------------------------------------------------------------------:|
-| **Sessions**       |                   ✔️ No limits!                   |                                                      ➖ One account for $50/month. |
+| **Sessions**       |   ✔️ No limits on **accounts** or **servers**!    |                                                      ➖ One account for $50/month. |
 | **Infrastructure** | ✔️ On-Premise - your server, your infrastructure! |                                                        ➖ Insecure cloud solution. |
 | **Security**       |                 ✔️ No data leaks!                 | ➖ You have to give access to customers' data - phone number, name, your messages. |
-| **License Term**               |               ✔️ No license checks!   |                                                                       ➖ One month |
+| **License Term**               |               ✔️ No license checks!               |                                                                       ➖ One month |
 | **Message price**  |             ✔️ All messages are Free!             |                     ➖ Some solutions have a price for messages - $1/100 messages. |
-| **Expenses**       |           ✔️ one-time $69 **donation**!           |                                                 ➖ Monthly payment starts from $50 |
+| **Expenses**       |               ✔️ $19 **donation**!                |                                                 ➖ Monthly payment starts from $50 |
+
 
 ## Get Plus ![](/images/versions/plus.png)
 
-For $69 one-time donation you get:
+The more you support the project - the more you get!
+
+Here's available tiers for our supporters:
+
+|                                                                                     |  Plus   | Advanced |   Pro   |
+|-------------------------------------------------------------------------------------|---------|:--------:|:-------:|
+| Access to WAHA Plus  ![](/images/versions/plus.png) docker image.                   |   ✔️    |    ✔️    |   ✔️    |
+| An invitation to a private Github repository so you have the WAHA Plus source code. |   ➖️    |    ✔️    |   ✔️️   |
+| Access to a Telegram group where we provide support and assistance.                 |   ➖️    |    ➖     |   ✔️    |
+| **Donation**                                                                        | **$19** | **$39**  | **$99** |
+
+For **$19** donation you get:
 1. **Secret password** for Docker Hub to download Plus image: `devlikeapro/whatsapp-http-api-plus`.
 2. **All updates for one month** for the Plus image.
 3. **NO LICENSE CHECKS** on installed instances!
 4. **NO LICENSE EXPIRATION** on installed instances! We repeated it twice to make sure that you've got it 😊
 
-{{< alert icon="👉" text="We don't mind if you stay subscribed with us after one month :)" />}}
+{{< alert icon="💡" text="If you stay subscribed - the donation amount will never change for you and always be $19 to get monthly updates!" />}}
+
 
 ### Boosty
-We use Boosty to get donations (Patreon analogue) - [https://boosty.to/wa-http-api](https://boosty.to/wa-http-api).
+<p align="center">
+  <img src="boosty.svg" alt="Patreon" />
+  <br/>
+  <br/>
+</p>
 
-Go ahead and get your monthly password to get no license expiration WhatsApp HTTP API - either subscribe or use one time donation!
+Support the project and get WAHA Plus version on
+<a href="https://boosty.to/wa-http-api" target="_blank">
+  <b>
+    Boosty ->
+  </b>
+</a>
 
-{{< alert icon="💡" text="If you stay subscribed - the donation amount will never change for you and always be $69 to get monthly updates!" />}}
-
-![](boosty.png)
+Go ahead and get your own WhatsApp HTTP API!
 
 ### Patreon
-You can support the project and get WAHA Plus version on Patreon: [https://patreon.com/wa_http_api](https://patreon.com/wa_http_api)
+<p align="center">
+  <img src="patreon.png" alt="Patreon" />
+</p>
 
-{{< alert icon="💡" text="Please look at Boosty - we prefer it because of lower fees, so we can donate more to the projects!" />}}
+Support the project and get WAHA Plus version on
+<a href="https://patreon.com/wa_http_api" target="_blank">
+  <b>
+    Patreon ->
+  </b>
+</a>
+
+Go ahead and get your own WhatsApp HTTP API!
 
 
 ### Install Plus
@@ -91,3 +136,4 @@ docker pull devlikeapro/whatsapp-http-api-plus
 docker logout
 ```
 Then in all commands use **Plus** image `devlikeapro/whatsapp-http-api-plus` instead of Core `devlikeapro/whatsapp-http-api`.
+

docs/site/content/en/docs/how-to/presence/index.md

@@ -0,0 +1,152 @@
+---
+title: "Presence"
+description: "Presence"
+lead: ""
+date: 2020-10-06T08:48:45+00:00
+lastmod: 2020-10-06T08:48:45+00:00
+draft: false
+images: [ ]
+weight: 801
+---
+
+You can get presence information (online, offline with last seen, typing status) for a contact if they share their
+presence information.
+
+Possible presence statuses that you can set or get for chats:
+- `online`
+- `offline`
+- `typing`
+- `recording`
+- `paused` resets the chat presence after you were `typing`
+
+
+## Endpoints
+
+### Set presence
+You can set your global or chat-related presence with `POST /api/{session}/presence` endpoint
+
+Start typing to a chat (you can use `POST /startTyping` instead)
+```json
+{
+  "chatId": "111111111@c.us",
+  "presence": "typing"
+}
+```
+
+Clear "typing" state (you can use `POST /stopTyping` instead)
+```json
+{
+  "chatId": "111111111@c.us",
+  "presence": "paused"
+}
+```
+
+Set global "online", all contacts will see it
+```json
+{
+  "presence": "online"
+}
+```
+
+💡 In the multi-device version of WhatsApp - if a desktop client is active, WhatsApp doesn't send push notifications
+to the device.
+If you would like to receive said notifications - you need to mark a session's presence as `offline`.
+
+```json
+{
+  "presence": "offline"
+}
+```
+
+### Get all chats presence
+
+{{< alert icon="👉" text="Get presence endpoints and webhook is available only in **NOWEB** engine." />}}
+[Read more about engines to choose right for you ->]({{< relref "/docs/how-to/engines" >}})
+
+Here's few notes about fields:
+
+- `chatId` - either contact id (`213213213@c.us`) or group chat id (`1111111111111@g.us`).
+- `lastSeen` - contains Unix timestamps indicating when a participant was last online
+- `lastKnownPresence` - contains the last known presence status, which can be
+  `offline`, `online`, `typing`, `recording`, or `paused`
+
+
+You can get all presence information available for a session by calling `GET /api/{session}/presence/`.
+It returns both groups' and personal chats' presence information.
+
+```json
+[
+  {
+    "id": "2132132130@c.us",
+    "presences": [
+      {
+        "participant": "2132132130@c.us",
+        "lastKnownPresence": "offline",
+        "lastSeen": 1686719326
+      }
+    ]
+  },
+  {
+    "id": "11111111111111111111111@g.us",
+    "presences": [
+      {
+        "participant": "11111111111111111111111@g.us",
+        "lastKnownPresence": "online",
+        "lastSeen": null
+      },
+      {
+        "participant": "2132132130@c.us",
+        "lastKnownPresence": "offline",
+        "lastSeen": 1686719326
+      }
+    ]
+  }
+]
+```
+
+### Get chat presence
+
+To get presence information for a single chat - call `GET /api/{session}/presence/{chatId}`.
+For a group, you'll get participants' statuses.
+
+```json
+{
+  "id": "2132132130@c.us",
+  "presences": [
+    {
+      "participant": "2132132130@c.us",
+      "lastKnownPresence": "online",
+      "lastSeen": null
+    }
+  ]
+}
+```
+
+### Subscribe to presence
+
+You can subscribe to presence information by calling `POST /api/{session}/presence/{chatId}/subscribe` request
+(no body required).
+You can get later presence information for the chat with above `GET` endpoints or by listening to `presence.update`
+webhook.
+
+## Webhook
+
+You can subscribe to `presence.update` webhook event to get the most recent presence information.
+
+```json
+{
+    "event": "presence.update",
+    "session": "default",
+    "payload": {
+        "id": "111111111111111111@g.us",
+        "presences": [
+            {
+                "participant": "11111111111@c.us",
+                "lastKnownPresence": "typing",
+                "lastSeen": null
+            }
+        ]
+    },
+    "engine": "NOWEB"
+}
+```

docs/site/content/en/docs/how-to/receive-messages/index.md

@@ -6,43 +6,39 @@ date: 2020-10-06T08:48:45+00:00
 lastmod: 2020-10-06T08:48:45+00:00
 draft: false
 images: []
-weight: 300
+weight: 120
 ---
+We consider that you've run docker container and authenticated the session with QR code.
 
-The project uses [Webhooks](https://en.wikipedia.org/wiki/Webhook) to send the messages or events from WhatsApp to your
-application.
+If you haven't yet - please follow the steps from [**Quick Start →**]({{< relref "/docs/overview/quick-start" >}}).
 
-## Webhooks ![](/images/versions/core.png) ![](/images/versions/plus.png)
+## Webhooks
 
-You can configure where you want to receive events in environment variables:
-
-- `WHATSAPP_HOOK_URL=https://httpbin.org/post`  - to set up a URL for the webhook
-- `WHATSAPP_HOOK_EVENTS=message,message.any,state.change,group.join,group.leave` - specify events. DO NOT specify all of
-  them, it's too heavy payload, choose the right for you.
-- `WHATSAPP_HOOK_EVENTS=*` - subscribe to all events. It's not recommended for production, but it's fine for
-  development.
-
-On the URL that you set via `WHATSAPP_HOOK_URL` you receive JSON-data with following format:
+You must use [Webhooks]({{< relref "/docs/how-to/webhooks" >}}) to receive messages from WhatsApp to your application.
 
+Start a new session with configured `message` event in webhooks - call `POST /api/sessions/start` with the payload:
 ```json
 {
-  "event": "message",
-  "payload": {}
+  "name": "default",
+  "config": {
+    "webhooks": [
+      {
+        "url": "https://httpbin.org/post",
+        "events": [
+          "message"
+        ]
+      }
+    ]
+  }
 }
 ```
 
-Where `event` value helps you identify the incoming event with `payload` for that events.
-
-Below the list of all events that WhatsApp HTTP API sends to your.
-
-{{< alert icon="👉" text="If you want to look at a webhook body - use the url `https://httpbin.org/post`" />}}
-
-```bash
-docker run -it -e WHATSAPP_HOOK_EVENTS=* -e WHATSAPP_HOOK_URL=https://httpbin.org/post devlikeapro/whatsapp-http-api
-```
+After that WAHA'll send events (see below) about new messages to an endpoint you provided.
 
 
-## Events ![](/images/versions/core.png) ![](/images/versions/plus.png)
+## Events
+Here's examples of message-related events.
+Read [Webhooks ->]({{< relref "/docs/how-to/webhooks" >}}) to find how to set them up.
 
 ### message
 
@@ -51,6 +47,7 @@ Incoming message (text/audio/files)
 ```json
 {
   "event": "message",
+  "session": "default",
   "payload": {
     "id": "true_11111111111@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
     "timestamp": 1667561485,
@@ -113,6 +110,7 @@ Fired on all message creations, including your own. The payload is the same as f
 ```json
 {
   "event": "message.any",
+  "session": "default",
   "payload": {}
 }
 ```
@@ -122,33 +120,7 @@ Fired on all message creations, including your own. The payload is the same as f
 ```json
 {
   "event": "message.ack",
-  "payload": {}
-}
-```
-
-### state.change
-
-```json
-{
-  "event": "state.change",
-  "payload": {}
-}
-```
-
-### group.join
-
-```json
-{
-  "event": "group.join",
-  "payload": {}
-}
-```
-
-### group.leave
-
-```json
-{
-  "event": "group.left",
+  "session": "default",
   "payload": {}
 }
 ```
@@ -163,6 +135,7 @@ For example, you can get the webhook like this with `mediaUrl` value (we've skip
 ```json
 {
   "event": "message",
+  "session": "default",
   "payload": {
     "id": "true_11111111111@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
     "timestamp": 1667561485,
@@ -175,8 +148,30 @@ Then you can use the link to download the file `http://localhost:3000/api/files/
 
 To configure the url you can use environment variables `WHATSAPP_API_HOSTNAME` and `WHATSAPP_API_PORT`.
 
-[Read more about file storage configuration and variables ->]({{< relref "config" >}}).
+By default, WAHA download all files that the account receive.
+If you want to limit files lifetime, specify file types for download or change directory for files -
+[read more about file storage configuration and variables ->]({{< relref "config" >}}).
 
-## Webhook retries ![](/images/versions/plus.png)
+## Endpoints
+
+### Get messages
+You can read messages from the history by using `GET /api/messages` endpoint.
+
+{{< alert icon="👉" text="We do not recommend using this method in production, consider using webhooks instead!" />}}
+
+```bash
+curl -X 'GET' \
+  'http://localhost:3000/api/messages?chatId=11111111111%40c.us&limit=1000&session=default' \
+  -H 'accept: application/json'
+```
+
+## Examples
+Here's few examples of how to receive messages in different languages:
+1. [Python guide ->]({{< relref "/docs/examples/python" >}})
+
+**Do you use another language?**
+
+Please create a short guide how to handle webhook and send message after you finish your setup!
+You can create a pull request with your favorite language in the
+[GitHub, in examples folder ->](https://github.com/devlikeapro/whatsapp-http-api/tree/core/examples).
 
-**WAHA** retries to reach your webhook URL 15 times and with 2 seconds.

docs/site/content/en/docs/how-to/security/index.md

@@ -6,7 +6,7 @@ date: 2020-10-06T08:48:45+00:00
 lastmod: 2020-10-06T08:48:45+00:00
 draft: false
 images: []
-weight: 800
+weight: 700
 ---
 {{< alert icon="💡" text="Do not expose WhatsApp HTTP API on public networks!" />}}
 
@@ -15,19 +15,35 @@ We do not recommend exposing the API on any public networks!
 Either protect the API with [Api Key](https://www.fortinet.com/resources/cyberglossary/api-key) or deny access by using
 firewalls.
 
+## Swagger Security ![](/images/versions/plus.png)
+If you want to hide the project Swagger panel under the password - run the following command to hide under `admin/admin`
+login and password.
+
+```bash
+docker run -it -e WHATSAPP_SWAGGER_USERNAME=admin -eWHATSAPP_SWAGGER_PASSWORD=admin devlikeapro/whatsapp-http-api-plus
+```
+
+Open http://localhost:3000/ and enter `admin / admin` in the inputs:
+
+![](swagger-basic-auth.png)
+
+{{< alert icon="👉" text="Protecting Swagger under the password does not protect your API from other request! Use both techniques to protect your API and Swagger!" />}}
+
 ## API security ![](/images/versions/plus.png)
 
 You can protect the API by requiring Api Key in a request's headers.
 
+{{< alert icon="👉" text="Api Key does not hide your Swagger documentation. Please have a look at the previous section to find how to hide Swagger under the password." />}}
+
 ### Set Api Key
 
 Set `WHATSAPP_API_KEY=yoursecretkey` environment variable for that:
 
 ```bash
-docker run -it -e WHATSAPP_API_KEY=yoursecretkey devlikeapro/whatsapp-http-api
+docker run -it -e WHATSAPP_API_KEY=yoursecretkey devlikeapro/whatsapp-http-api-plus
 ```
 
-### Swagger
+### Use Api-Key in Swagger
 
 After you set api key - to authorize on swagger use **Authorize** button at the top:
 ![](swagger-auth.png)
@@ -49,5 +65,7 @@ headers = {
 requests.get("http://localhost:3000/api/sessions", headers=headers)
 ```
 
-## Swagger Security ![](/images/versions/plus-soon.png)
-If you want to hide under a password the swagger UI - please create an issue on GitHub, we'll do it!
+## Webhook security ![](/images/versions/plus.png)
+To make sure that you get a webhook from your WAHA instance - you can use **HMAC authentication**.
+Read more about it on [Webhooks page ->]({{< relref "/docs/how-to/webhooks#hmac-authentication" >}})
+

docs/site/content/en/docs/how-to/send-messages/index.md

@@ -6,15 +6,12 @@ date: 2020-10-06T08:48:45+00:00
 lastmod: 2020-10-06T08:48:45+00:00
 draft: false
 images: []
-weight: 200
+weight: 110
 ---
-On your swagger documentation [http://localhost:3000/](http://localhost:3000/)
-or in [the example swagger](/swagger) you can find:
-1. List of all supported methods - we have not documented all of them on the page
-1. Requests JSON schemas
-1. Responses JSON schemas
-1. **Try it** button - no additional setup to play around with a method
 
+We consider that you've run docker container and authenticated the session with QR code.
+
+If you haven't yet - please follow the steps from [**Quick Start →**]({{< relref "/docs/overview/quick-start" >}}).
 
 ## Fields
 There are common fields that you can find in almost all requests:
@@ -28,7 +25,7 @@ Read more about [multiple sessions →]({{< relref "/docs/how-to/sessions" >}})
     For phone number `12132132131` the `chatId` is  `12132132131@c.us`.
   - **Groups** use random number with `@g.us` at the end.
 
-## Send text ![](/images/versions/core.png) ![](/images/versions/plus.png)
+## Send text ![](/images/versions/core.png)
 To send text message - use `POST /api/sendText` with example payload.
 ```json
 {
@@ -37,8 +34,25 @@ To send text message - use `POST /api/sendText` with example payload.
   "text": "Hi there!"
 }
 ```
+### Mention contact
+If you send a message in a group and want to mention a participant in the message -
+use `mentions` field for that in `POST /api/sendText` request.
 
-## Reply on message ![](/images/versions/core.png) ![](/images/versions/plus.png)
+Please note that you MUST mention a number in the text as well in the format `@2132132130` and
+also mention it in `mentions` in format `2132132130@c.us`
+
+```json
+{
+  "session": "default",
+  "chatId": "12132132130@c.us",
+  "text": "Hi there! @2132132130",
+  "mentions": [
+    "2132132130@c.us"
+  ]
+}
+```
+
+## Reply on message ![](/images/versions/core.png)
 To reply on a message - use `POST /api/reply` with example payload.
 ```json
 {
@@ -52,10 +66,10 @@ To reply on a message - use `POST /api/reply` with example payload.
 ### Reply files ![](/images/versions/plus-soon.png)
 WAHA does not support reply with files (images, voice, etc). If you're interested in it - please create an issue in GitHub.
 
-## Add a reaction ![](/images/versions/core.png) ![](/images/versions/plus.png)
+## Add a reaction ![](/images/versions/core.png)
 Use `PUT /api/reaction` method to set reaction to a message.
 
-{{< alert icon="👉" text="Reactoin API uses PUT, not POST request! Please make sure you send right request." />}}
+{{< alert icon="👉" text="Reaction API uses PUT, not POST request! Please make sure you send right request." />}}
 
 ```json
 {

docs/site/content/en/docs/how-to/sessions/index.md

@@ -1,44 +1,15 @@
 ---
-title : "Sessions"
+title: "Sessions"
 description: "Sessions"
 lead: ""
 date: 2020-10-06T08:48:45+00:00
 lastmod: 2020-10-06T08:48:45+00:00
 draft: false
-images: []
-weight: 800
+images: [ ]
+weight: 125
 ---
 
-## Saving session ![](/images/versions/plus.png)
-
-Plus ![](/images/versions/plus.png) version allows you to save "session" state and avoid scanning QR code everytime when
-you start a container.
-
-### File storage
-
-If you want to save your session and do not scan QR code everytime when you launch WAHA - connect a local file storage
-to the container. WAHA stores authentication information in the directory and reuses it after restart.
-
-[Attach volume](https://docs.docker.com/storage/volumes/) part to the command:
-```bash
--v `pwd`/.sessions:/app/.sessions
-```
-
-The full command would be:
-```bash
-docker run --rm -d -v `pwd`/.sessions:/app/.sessions -p 127.0.0.1:3000:3000/tcp --name whatsapp-http-api devlikeapro/whatsapp-http-api
-```
-
-### Remote storage ![](/images/versions/soon.png)
-
-If you're interested in using some "remote" storage (like Redis or other Databases) to save sessions - please create an
-issue on GitHub.
-
-For instances, it may be useful if you run WAHA in a cluster of servers and do not have shared file storage
-
-## Multiple sessions ![](/images/versions/plus.png)
-
-If you want to save server's CPU and Memory - run multiple sessions inside one docker container!
+## Endpoints
 
 ### Start
 
@@ -49,6 +20,68 @@ In order to start a new session - call `POST /api/sessions/start`
   "name": "default"
 }
 ```
+#### Configure webhooks
+You can configure webhooks for a session:
+```json
+{
+  "name": "default",
+  "config": {
+    "webhooks": [
+      {
+        "url": "https://httpbin.org/post",
+        "events": [
+          "message"
+        ]
+      }
+    ]
+  }
+}
+```
+
+Read more about available options on [**Webhooks page ->**]({{< relref "/docs/how-to/webhooks#hmac-authentication" >}})
+
+The configuration is saved and will be applied if the docker container restarts,
+and you set `WHATSAPP_RESTART_ALL_SESSIONS` environment variables.
+Read more about it in [Autostart section](#autostart).
+
+#### Configure proxy
+You can configure proxy for a session by setting `config.proxy` fields:
+- `server` - proxy server address, without `http://` or `https://` prefixes
+- `username` and `password` - set this if the proxy requires authentication
+
+
+**No authentication**
+```json
+{
+  "name": "default",
+  "config": {
+    "proxy": {
+      "server": "localhost:3128"
+    }
+  }
+}
+```
+
+**Proxy with authentication**
+```json
+{
+  "name": "default",
+  "config": {
+    "proxy": {
+      "server": "localhost:3128",
+      "username": "username",
+      "password": "P@ssw0rd"
+    }
+  }
+}
+```
+
+The configuration is saved and will be applied if the docker container restarts,
+and you set `WHATSAPP_RESTART_ALL_SESSIONS` environment variables.
+Read more about it in [Autostart section](#autostart).
+
+You can configure proxy when for all sessions by set up environment variables.
+Read more about it on [**Configuration page** ->]({{< relref "/docs/how-to/config#proxy" >}}).
 
 ### List
 
@@ -65,15 +98,84 @@ The response:
 ]
 ```
 
+You can add `?all=true` parameter to the request `GET /api/session?all=True` it'll show you ALL session,
+including **STOPPED**,
+so you can know which one will be restarted if you set `WHATSAPP_RESTART_ALL_SESSIONS=True` environment variable.
+
 ### Stop
 
 In order to stop a new session - call `POST /api/sessions/stop`
 
-{{< alert icon="👉" text="The stop request does not log out the account. Manually remove the session storage." />}}
+{{< alert icon="👉" text="The stop request does not log out the account by default. Set 'logout' field to 'true'." />}}
 
 ```json
 {
-  "name": "default"
+  "name": "default",
+  "logout": true
 }
 ```
 
+### Logout
+
+In order to log out the session - call `POST /api/sessions/logout`
+
+{{< alert icon="👉" text="You must stop session first." />}}
+
+```json
+{
+  "name": "default",
+  "logout": true
+}
+```
+
+
+
+## Advanced sessions ![](/images/versions/plus.png)
+
+With [WAHA Plus version]({{< relref "plus-version" >}}) you can save session state to avoid scanning QR code everytime,
+configure autostart options so when the docker container restarts - it restores all previously run sessions!
+
+### Session persistent
+
+#### File storage
+If you want to save your session and do not scan QR code everytime when you launch WAHA - connect a local file storage
+to the container. WAHA stores authentication information in the directory and reuses it after restart.
+
+[Attach volume](https://docs.docker.com/storage/volumes/) part to the command:
+
+```bash
+-v `pwd`/.sessions:/app/.sessions
+```
+
+The full command would be:
+
+```bash
+docker run --rm -d -v `pwd`/.sessions:/app/.sessions -p 3000:3000/tcp --name whatsapp-http-api devlikeapro/whatsapp-http-api-plus
+```
+
+#### Remote storage ![](/images/versions/soon.png)
+
+If you're interested in using some "remote" storage (like Redis or other Databases) to save sessions - please create an
+issue on GitHub.
+
+For instances, it may be useful if you run WAHA in a cluster of servers and do not have shared file storage
+
+### Autostart
+If you don't want to call `POST /api/sessions/start` for every session each time when the container restart -
+you can use set of these environment variables to start sessions for you:
+
+- `WHATSAPP_RESTART_ALL_SESSIONS=True`: Set this variable to `True` to start all **STOPPED** sessions after container
+  restarts. By default, this variable is set to `False`.
+  - Please note that this will start all **STOPPED** sessions, not just the sessions that were working before the restart. You can maintain the session list by
+    using `POST /api/session/stop` with the `logout: True` parameter or by calling `POST /api/session/logout` to remove
+    **STOPPED** sessions. You can see all sessions, including **STOPPED** sessions, in the `GET /api/sessions/all=True`
+    response.
+- `WHATSAPP_START_SESSION=session1,session2`: This variable can be used to start sessions with the specified names right
+  after launching the API. Separate session names with a comma.
+
+
+### Multiple sessions
+
+If you want to save server's CPU and Memory - run multiple sessions inside one docker container!
+[Plus version]({{< relref "plus-version" >}}) supports multiple sessions in one container.
+

docs/site/content/en/docs/how-to/webhooks/index.md

@@ -0,0 +1,374 @@
+---
+title : "Webhooks"
+description: "Webhooks"
+lead: ""
+date: 2020-10-06T08:48:45+00:00
+lastmod: 2020-10-06T08:48:45+00:00
+draft: false
+images: []
+weight: 121
+---
+
+The project uses [Webhooks](https://en.wikipedia.org/wiki/Webhook) to send the messages and events from WhatsApp to your
+application.
+
+Webhooks are a way for two different applications to communicate with each other in real-time.
+When a certain event happens in one application, it sends a message to another application through a webhook URL.
+The receiving application can then take action based on the information received.
+
+## Setup webhooks
+### Session webhooks
+You can define webhooks configuration per session when you start it with `POST /api/sessions/start` request data.
+
+Here's a simple example:
+```json
+{
+  "name": "default",
+  "config": {
+    "webhooks": [
+      {
+        "url": "https://httpbin.org/post",
+        "events": [
+          "message"
+        ]
+      }
+    ]
+  }
+}
+
+```
+
+Here's available configuration options for webhooks
+```json
+{
+  "name": "default",
+  "config": {
+    "webhooks": [
+      {
+        "url": "https://httpbin.org/post",
+        "events": [
+          "message"
+        ],
+        "hmac": {
+          "key": "your-secret-key"
+        },
+        "retries": {
+          "delaySeconds": 2,
+          "attempts": 15
+        },
+        "customHeaders": [
+          {
+            "name": "X-My-Custom-Header",
+            "value": "Value"
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+### Global webhooks
+There's a way how you can configure webhooks for ALL sessions - by settings these environment variables:
+
+- `WHATSAPP_HOOK_URL=https://httpbin.org/post`  - to set up a URL for the webhook
+- `WHATSAPP_HOOK_EVENTS=message,message.any,state.change` - specify events. Do not specify all of
+  them, it's too heavy payload, choose the right for you.
+- `WHATSAPP_HOOK_EVENTS=*` - subscribe to all events. It's not recommended for production, but it's fine for
+development.
+
+That webhook configuration **does not appear** in `session.config` field in `GET /api/sessions/` request.
+
+## Webhook payload
+
+On the URL that you set you'll receive **HTTP POST** request with a JSON string with following format:
+
+```json
+{
+  "event": "message",
+  "session": "default",
+  "engine": "WEBJS",
+  "payload": {
+    ...
+  }
+}
+```
+
+Where `event` value helps you identify the incoming event with `payload` for that events.
+
+Below the list of all events that WhatsApp HTTP API sends to your.
+
+{{< alert icon="👉" text="If you want to look at a webhook body - use the url https://httpbin.org/post" />}}
+
+Run the bellow command and see look at the logs - it prints body request for all events that happen in your WhatsApp!
+
+```bash
+docker run -it -e "WHATSAPP_HOOK_EVENTS=*" -e WHATSAPP_HOOK_URL=https://httpbin.org/post -p 3000:3000 devlikeapro/whatsapp-http-api
+```
+
+
+
+## Events
+
+### message
+
+Incoming message (text/audio/files)
+
+```json
+{
+  "event": "message",
+  "session": "default",
+  "engine": "WEBJS",
+  "payload": {
+    "id": "true_11111111111@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
+    "timestamp": 1667561485,
+    "from": "11111111111@c.us",
+    "fromMe": true,
+    "to": "11111111111@c.us",
+    "body": "Hi there!",
+    "hasMedia": false,
+    "ack": 1,
+    "vCards": [],
+    "_data": {
+      "id": {
+        "fromMe": true,
+        "remote": "11111111111@c.us",
+        "id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
+        "_serialized": "true_11111111111@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
+      },
+      "body": "Hi there!",
+      "type": "chat",
+      "t": 1667561485,
+      "notifyName": "MyName",
+      "from": "11111111111@c.us",
+      "to": "11111111111@c.us",
+      "self": "in",
+      "ack": 1,
+      "isNewMsg": true,
+      "star": false,
+      "kicNotified": false,
+      "recvFresh": true,
+      "isFromTemplate": false,
+      "pollInvalidated": false,
+      "latestEditMsgKey": null,
+      "latestEditSenderTimestampMs": null,
+      "broadcast": false,
+      "mentionedJidList": [],
+      "isVcardOverMmsDocument": false,
+      "isForwarded": false,
+      "hasReaction": false,
+      "ephemeralOutOfSync": false,
+      "productHeaderImageRejected": false,
+      "lastPlaybackProgress": 0,
+      "isDynamicReplyButtonsMsg": false,
+      "isMdHistoryMsg": false,
+      "stickerSentTs": 0,
+      "isAvatar": false,
+      "requiresDirectConnection": false,
+      "pttForwardedFeaturesEnabled": true,
+      "isEphemeral": false,
+      "isStatusV3": false,
+      "links": []
+    }
+  }
+}
+```
+
+### message.any
+
+Fired on all message creations, including your own. The payload is the same as for [message](#message) event.
+
+```json
+{
+  "event": "message.any",
+  "session": "default",
+  "engine": "WEBJS",
+  "payload": {
+    ...
+  }
+}
+```
+
+### message.ack
+
+```json
+{
+  "event": "message.ack",
+  "session": "default",
+  "engine": "WEBJS",
+  "payload": {
+    ...
+  }
+}
+```
+
+### state.change
+
+It's an internal engine's state, not **session** `status`.
+
+```json
+{
+  "event": "state.change",
+  "session": "default",
+  "engine": "WEBJS",
+  "payload": {
+    ...
+  }
+}
+```
+
+### group.join
+
+```json
+{
+  "event": "group.join",
+  "session": "default",
+  "engine": "WEBJS",
+  "payload": {
+    ...
+  }
+}
+```
+
+### group.leave
+
+```json
+{
+  "event": "group.left",
+  "session": "default",
+  "engine": "WEBJS",
+  "payload": {
+    ...
+  }
+}
+```
+
+### presence.update
+
+- `payload.id` indicates the chat - either direct chat with a contact or a group chat.
+- `payload.id.[].participant` - certain participant presence status. For a direct chat there's only one participant.
+
+```json
+{
+    "event": "presence.update",
+    "session": "default",
+    "engine": "NOWEB",
+    "payload": {
+        "id": "111111111111111111@g.us",
+        "presences": [
+            {
+                "participant": "11111111111@c.us",
+                "lastKnownPresence": "typing",
+                "lastSeen": null
+            }
+        ]
+    }
+}
+```
+
+## Webhooks Advanced ![](/images/versions/plus.png)
+### HMAC authentication
+
+You can authenticate webhook sender by using [HMAC Authentication](https://www.okta.com/identity-101/hmac/).
+
+1. Define you secret key in `config.hmac.key` field when you start session with `POST /api/sessions/start`:
+
+```json
+{
+  "name": "default",
+  "config": {
+    "webhooks": [
+      {
+        "url": "https://httpbin.org/post",
+        "events": [
+          "message"
+        ],
+        "hmac": {
+          "key": "your-secret-key"
+        }
+      }
+    ]
+  }
+}
+```
+
+2. After that you'll receive all webhooks payload with two additional headers:
+- `X-Webhook-Hmac` - message authentication code for the raw **body** in HTTP POST request that send to your endpoint.
+- `X-Webhook-Hmac-Algorithm` - `sha512` - algorithm that have been used to create `X-Webhook-Hmac` value.
+
+3. Implement the authentication algorithm by hashing body and using secret key and then verifying it with `X-Webhook-Hmac`
+value. Please [check your implementation here ->](https://www.devglan.com/online-tools/hmac-sha256-online)
+
+Here's example for
+```
+# Full body
+{"event":"message","session":"default","engine":"WEBJS"}
+# Secret key
+my-secret-key
+# X-Webhook-Hmac-Algorithm
+sha512
+# X-Webhook-Hmac
+208f8a55dde9e05519e898b10b89bf0d0b3b0fdf11fdbf09b6b90476301b98d8097c462b2b17a6ce93b6b47a136cf2e78a33a63f6752c2c1631777076153fa89
+```
+
+
+### Retries
+**WAHA** retries to reach your webhook URL **15 times** with **2 seconds delay** between attempts by default in
+[Plus Version →]({{< relref "plus-version" >}})
+
+You can configure those parameters by settings `config.retries` structure when `POST /api/sessions/start`:
+
+```json
+{
+  "name": "default",
+  "config": {
+    "webhooks": [
+      {
+        "url": "https://httpbin.org/post",
+        "events": [
+          "message"
+        ],
+        "retries": {
+          "delaySeconds": 2,
+          "attempts": 15
+        }
+      }
+    ]
+  }
+}
+
+```
+
+### Custom Headers
+You can send any customer headers by defining `config.webhooks.customHeaders` fields this way:
+```json
+{
+  "name": "default",
+  "config": {
+    "webhooks": [
+      {
+        "url": "https://httpbin.org/post",
+        "events": [
+          "message"
+        ],
+        "customHeaders": [
+          {
+            "name": "X-My-Custom-Header",
+            "value": "Value"
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+Here's few examples of how to handle webhook in different languages:
+1. [Python guide]({{< relref "/docs/examples/python" >}})
+
+**Do you use another language?**
+
+Please create a short guide how to handle webhook and send message after you finish your setup!
+You can create a pull request with your favorite language in the
+[GitHub, in examples folder ->](https://github.com/devlikeapro/whatsapp-http-api/tree/core/examples).

docs/site/content/en/docs/overview/changelog.md

@@ -0,0 +1,157 @@
+---
+title: "Changelog"
+description: "WAHA's changelog"
+lead: "Changelog"
+date: 2020-10-06T08:49:31+00:00
+lastmod: 2020-10-06T08:49:31+00:00
+draft: false
+images: [ ]
+menu:
+  docs:
+    parent: "help"
+weight: 199
+toc: true
+---
+## 2023.8
+August 2023
+- Added [set presence endpoint](https://waha.devlike.pro/docs/how-to/presence)!
+  - With `online` presence you can show your status as online [#121](https://github.com/devlikeapro/whatsapp-http-api/issues/121)
+  - With `offline` presence you can get notifications for your device [#28](https://github.com/devlikeapro/whatsapp-http-api/issues/28)
+
+## 2023.7
+July 2023
+- Now session can have their own [Webhooks](https://waha.devlike.pro/docs/how-to/webhooks) -
+   you can define webhook configuration when you start a session with `POST /api/session/start`!
+  - Add HMAC authentication for webhooks
+  - Configure retries
+  - Add you custom headers
+- Added [proxy configuration](https://waha.devlike.pro/docs/how-to/config/#proxy) with supporting proxy authentication.
+  Thanks **puntolino** for the contribution!
+  You can control proxy's settings per session with `POST /api/session/start` or globally with environment variables.
+- Added [presence information](https://waha.devlike.pro/docs/how-to/presence) - now you can get online status for
+  a contact by calling endpoints or receiving a webhook event!
+- Now you can mention contact in groups by settings `mentions` field in `POST /api/sendText`
+  [read more about it in Send Messages ->]({{< relref "/docs/how-to/send-messages" >}})
+
+## 2023.6
+June 2023
+
+Improvements on session management, restarting sessions and more:
+
+- Added `WHATSAPP_RESTART_ALL_SESSIONS=True`: Set this variable to `True` to start all **STOPPED** sessions after
+  container restarts. By default, this variable is set to `False`.
+  - Please note that this will start all **STOPPED** sessions, not just the sessions that were working before the
+    restart. You can maintain the session list by
+    using `POST /api/session/stop` with the `logout: True` parameter or by calling `POST /api/session/logout` to remove
+    **STOPPED** sessions. You can see all sessions, including **STOPPED** sessions, in the `GET /api/sessions/all=True`
+    response.
+- `WHATSAPP_START_SESSION` now support more than one session! Separate session names by command, and it'll start them
+  ALWAYS after container restart `WHATSAPP_START_SESSION=session1,session2`
+- `WHATSAPP_SWAGGER_CONFIG_ADVANCED=true` enables advanced configuration options for Swagger documentation - you can customize host, port and base URL for the requests.
+  Disabled by default.
+- Added `?all=true` parameter to `GET /api/session?all=True` endpoint - it'll show you ALL session, included **STOPPED
+  **, so you can know which one will be restarted if you set `WHATSAPP_RESTART_ALL_SESSIONS=True` environment variable.
+- Added `POST /api/sessions/logout` that allow you to logout from session - remove saved credentials.
+- Added `logout` boolean parameter to `POST /api/sessions/stop` request that allow you to stop the session AND logout at
+  the same time.
+- Added [How to deploy page ->]({{< relref "/docs/how-to/deploy" >}}) with
+  [docker-compose.yaml](https://github.com/devlikeapro/whatsapp-http-api/blob/core/docker-compose.yaml) example
+- Added `engine` field in webhook payload
+
+```json
+{
+  "event": "message",
+  "session": "default",
+  "engine": "WEBJS",
+  "payload": {}
+}
+```
+
+## 2023.5
+May 2023
+
+- Added new [NOWEB engine]({{< relref "/docs/how-to/engines" >}}). **NOWEB** engine does not require a browser to work
+  with
+  WhatsApp Web, it does so directly using a WebSocket.
+  - Less CPU and RAM usage!
+  - Send Locations API works!
+  - Send Link Preview API works!
+  - ⚠ Read the article before using it [How to avoid blocking ->]({{< relref "/docs/overview/how-to-avoid-blocking" >}}).
+
+## 2023.4
+March 2023
+
+- Add [Groups API]({{< relref "/docs/how-to/groups" >}})
+- Use Chromium by default instead of Chrome
+
+## 2023.1
+January 2023
+
+- Added  [Contacts API]({{< relref "/docs/how-to/contacts" >}})
+  - Get all contacts
+  - Get a contact
+  - Get contact "about" (status)
+  - Get contact profile picture
+  - Check number exists (is registered in WhatsApp) - works even if the number is not in the contact list
+  - Block and unblock contact
+
+## 2022.12
+December 2023
+
+- Added `GET /messages/` endpoint to get chat messages [#31](https://github.com/devlikeapro/whatsapp-http-api/issues/31)
+
+### Security ![](/images/versions/plus.png)
+
+- Added `WHATSAPP_SWAGGER_USERNAME` and `WHATSAPP_SWAGGER_PASSWORD` to hide and protect swagger panel.
+
+## 2022.11
+
+**Please test changes in test environment before update production!!**
+
+### Engine ![](/images/versions/core.png)
+
+1. WAHA has changed its underlying engine from Venom to Whatsapp Web.JS. It might change the response and webhook's
+   payloads.
+2. Optimize CPU and memory consumption.
+
+### Requests ![](/images/versions/core.png)
+
+- For all `/api/session/` requests use `name` field instead of `sessionName`.
+- For all "chatting" requests use `session` field instead of `sessionName`.
+
+### Sessions ![](/images/versions/plus.png)
+
+Now you don't have to scan QR code each time you run WAHA, WAHA saves it for you! Available only in Plus version.
+
+### Authentication ![](/images/versions/plus.png)
+
+Now you can authenticate all requests for WAHA - use `WHATSAPP_API_KEY=secret` environment variable to set "secret key".
+
+If `WHATSAPP_API_KEY` is set - requests must have `X-Api-Key` header with `secret` value, where `secret` - any random
+secret key.
+
+### Webhooks ![](/images/versions/core.png)
+
+#### Configuration
+
+Instead of setting each webhook via environment variables - we use two environments variables:
+
+- `WHATSAPP_HOOK_URL` - to set a URL
+- `WHATSAPP_HOOK_EVENTS` - to set events that are sent to the URL
+
+| Previous                                                                                                             | Current                                                                                            |
+|----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
+| <pre>WHATSAPP_HOOK_ONMESSAGE=https://httpbin.org/post <br>WHATSAPP_HOOK_ONANYMESSAGE=https://httpbin.org/post </pre> | <pre>WHATSAPP_HOOK_URL=https://httpbin.org/post <br>WHATSAPP_HOOK_EVENTS=message,message.any</pre> |
+
+#### Payload
+
+The data for webhooks are wrapped inside a new `WAWebhook` object with `event` and `payload` fields to help you identify
+which handler you should call based on `event`.
+
+```json
+{
+  "event": "message.any",
+  "payload": {
+  }
+}
+```

docs/site/content/en/docs/overview/faq.md

@@ -0,0 +1,49 @@
+---
+title: "FAQ"
+description: "Answers to frequently asked questions."
+lead: "Answers to frequently asked questions."
+date: 2020-10-06T08:49:31+00:00
+lastmod: 2020-10-06T08:49:31+00:00
+draft: false
+images: [ ]
+menu:
+docs:
+parent: "help"
+weight: 130
+toc: true
+---
+
+## How to update?
+
+{{< alert icon="💡" text="Please test all new versions in the development environment before updating production!" />}}
+
+![](/images/versions/core.png) For **Core** version the command is
+
+```bash
+docker pull devlikeapro/whatsapp-http-api
+```
+
+![](/images/versions/plus.png) For **Plus** version, we use login to get the image before:
+
+```bash
+docker login -u devlikeapro -p {PASSWORD}
+docker pull devlikeapro/whatsapp-http-api-plus
+docker logout
+```
+
+Read more about how to get `PASSWORD` for [Plus Version →]({{< relref "plus-version" >}})
+
+## How much CPU and Memory does WhatsApp HTTP API consume?
+
+The benchmark has been made on **Intel(R) Core(TM) i7-10510U CPU @ 1.80GHz**.
+It may differ from case to case, it depends on usage pattern - how many messages you get, how many send, etc.
+
+| Accounts (sessions) in the container | CPU  | Memory |
+|--------------------------------------|------|--------|
+| 1                                    | 30%  | 400MB  |
+| 10                                   | 270% | 1.5GB  |
+
+The nature of WhatsApp HTTP API and its underlying engines - is to run **real** WhatsApp Web version in Chrome and
+communicate with it to prevent blocking from WhatsApp. It's the reason why it's so demanding on resources.
+
+If you're looking for less resource demanded engine - [have a look at **NOWEB** engine ->]({{< relref "/docs/how-to/engines" >}})

docs/site/content/en/docs/overview/how-to-avoid-blocking.md

@@ -0,0 +1,58 @@
+---
+title: "How to Avoid Blocking"
+description: "How to Avoid Blocking From Whatsapp"
+date: 2020-11-12T13:26:54+01:00
+lastmod: 2020-11-12T13:26:54+01:00
+draft: false
+images: [ ]
+menu:
+  docs:
+    parent: "help"
+weight: 120
+toc: true
+---
+
+How to Avoid Blocking in WhatsApp when developing bots.
+
+It's important to keep in mind that WhatsApp has strict policies in place to prevent spamming and abuse of their
+platform.
+
+If you're developing a bot for WhatsApp, it's crucial to follow these guidelines to avoid getting blocked.
+
+## Guidelines to Follow
+
+### 1. Only Reply to Messages
+
+When developing a bot for WhatsApp, you **should never initiate a conversation**.
+Instead, your bot **should only reply** to messages that it receives.
+This will prevent your bot from being flagged as spam by WhatsApp's users and algorithms.
+
+### 2. Avoid Spamming and Sending Unnecessary Content
+
+Sending too many messages or sending content that the user did not request can also lead to your bot being blocked. Make
+sure to only send relevant and useful information to the user.
+Additionally, do not send too many messages at once, as this can also trigger spam filters.
+
+### 3. Other Considerations
+
+There are other guidelines to follow when developing a bot for WhatsApp, such as avoiding the use of banned words and
+not sharing sensitive or inappropriate content.
+Make sure to read WhatsApp's policies thoroughly to ensure that your bot complies with all of their rules.
+
+## How to Process Messages
+
+When processing messages in your bot, it's important to follow certain steps to avoid being flagged as spam.
+Here's a recommended process to follow:
+
+1. **Send seen** before processing the message. This can be done by sending a `POST /api/sendSeen/` request to
+   the WAHA API.
+
+2. **Start typing** before sending a message and wait for a random interval depending on the size of the message. This can
+   be done by sending a `POST /api/startTyping/` request.
+
+3. **Stop typing** before sending the message. This can be done by sending a `POST /api/stopTyping/` request.
+
+4. **Send the text message** using the `POST /api/sendText` request.
+
+By following these steps, you can ensure that your bot processes messages in a way that's compliant with WhatsApp's
+guidelines and reduces the risk of being blocked.

docs/site/content/en/docs/overview/introduction.md

@@ -22,58 +22,56 @@ toc: true
 
 {{< alert icon="👉" text="Run WhatsApp HTTP API in less than 5 minutes!" />}}
 
-Go straight to the [Quick Start →]({{< relref "quick-start" >}})
+We will guide you through the necessary steps to successfully send your first text message using WhatsApp HTTP API in
+[**Quick Start →**]({{< relref "quick-start" >}}).
 
 ## Features
 WAHA is distributed in two versions:
-- Core ![](/images/versions/core.png) - the basic version that meet almost 80% people's needs. 100% free and [open source](https://github.com/devlikeapro/whatsapp-http-api).
-- Plus ![](/images/versions/plus.png) - the version with advanced messages, security, and reliability features. One-time donation, no license expiration, quick updates, read more about [Plus Version →]({{< relref "plus-version" >}})
+- Core ![](/images/versions/core.png) - the basic version that meet almost 80% people's needs. 100% free and [open source ->](https://github.com/devlikeapro/whatsapp-http-api).
+- Plus ![](/images/versions/plus.png) - the version with advanced messages, security, and reliability features. Donations, no license expiration, quick updates, read more about [Plus Version →]({{< relref "plus-version" >}})
 
 Here's the available features:
 
 ### Messages
-- Send messages ![](/images/versions/core.png) ![](/images/versions/plus.png)
-- Receive messages ![](/images/versions/core.png) ![](/images/versions/plus.png)
-- Message replies ![](/images/versions/core.png) ![](/images/versions/plus.png)
-- Send location ![](/images/versions/core.png) ![](/images/versions/plus.png)
-- Send buttons ![](/images/versions/core.png) ![](/images/versions/plus.png)
-- Receive location ![](/images/versions/core.png) ![](/images/versions/plus.png)
-- React to messages ![](/images/versions/core.png) ![](/images/versions/plus.png)
+- Send messages
+- Receive messages
+- Message replies
+- Send location
+- Send buttons
+- Receive location
+- React to messages
 - Send media (images/documents/files) ![](/images/versions/plus.png)
 - Send voice messages ![](/images/versions/plus.png)
 - Receive media (images/audio/video/documents) ![](/images/versions/plus.png)
 - Receive messages - webhook retries ![](/images/versions/plus.png)
 
-### Sessions
-- Multi Device ![](/images/versions/core.png) ![](/images/versions/plus.png)
-- Get the screenshot ![](/images/versions/core.png) ![](/images/versions/plus.png)
-- Session saving (don't have to scan QR on every restart) ![](/images/versions/plus.png)
-- Session saving on remote storage (database, redis) ![](/images/versions/plus-soon.png)
-- Single WhatsApp account running inside one container ![](/images/versions/core.png)
-- Multiple WhatsApp account running inside one container ![](/images/versions/plus.png)
-
-### Security
-- API authentication ![](/images/versions/plus.png)
-- Swagger panel authentication ![](/images/versions/plus-soon.png)
-
-### Updates
-- Bug fixes and updates come as soon as they are implemented. ![](/images/versions/plus.png)
-- One month delay in bug fixes and updates. ![](/images/versions/core.png)
-
-
-### Groups ![](/images/versions/soon.png)
-- Join groups by invite
+### Groups
+- Create a group
 - 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
 
-### Contacts ![](/images/versions/soon.png)
-- Mention users
+### Contacts
 - Mute/unmute chats
 - Block/unblock contacts
 - Get contact info
 - Get profile pictures
-- Set user status message
+- Get presence (online\offline\typing) status
+
+### Sessions
+- Multi Device
+- Get the screenshot
+- Single WhatsApp account running inside one container
+- Multiple WhatsApp account running inside one container ![](/images/versions/plus.png)
+- Session saving (don't have to scan QR on every restart) ![](/images/versions/plus.png)
+- Session saving on remote storage (database, redis) ![](/images/versions/plus-soon.png)
+
+### Security
+- API authentication ![](/images/versions/plus.png)
+- Swagger panel authentication ![](/images/versions/plus.png)
+
+### Updates
+- Bug fixes and updates come as soon as they are implemented.
+

docs/site/content/en/docs/overview/quick-start/index.md

@@ -13,7 +13,10 @@ weight: 110
 toc: true
 ---
 
-On this page you're going to install WAHA, run it, authenticate the client using QR code and send the first text message to WhatsApp!
+On this page you're going to install WAHA, run it, authenticate the client using QR code and send the first text message
+to WhatsApp!
+
+![](swagger.png)
 
 ## Requirements
 
@@ -31,7 +34,21 @@ Also Docker makes installation and update processes so simple, just one command!
 
 ## Send your first message
 
-Let's go over steps that allow you to send your first text message via WhatsApp HTTP API!
+We will guide you through the necessary steps to successfully send your first text message using WhatsApp HTTP API.
+
+**If you find it easier to follow a video** tutorial, we've got you covered!
+A 3-minute video tutorial is available to help you navigate WhatsApp HTTP API smoothly.
+
+<div class="d-flex justify-content-center my-4">
+  <iframe
+    width="560" height="315"
+    src="https://www.youtube.com/embed/RFerMyAUPRg"
+    title="YouTube video player"
+    frameborder="0"
+    allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
+    allowfullscreen
+  ></iframe>
+</div>
 
 ### 1. Download image
 
@@ -53,12 +70,34 @@ docker logout
 
 Read more about how to get `PASSWORD` for [Plus Version →]({{< relref "plus-version" >}})
 
+#### 1.1 Download image on ARM
+
+If you're using ARM (like Apple Silicon, Apple M1, etc) - use following commands to download the image
+
+![](/images/versions/core.png) For Core version the command is
+```bash
+# Download the image
+docker pull devlikeapro/whatsapp-http-api:arm
+# Rename it, so you can use devlikeapro/whatsapp-http-api image in other place
+docker tag devlikeapro/whatsapp-http-api:arm devlikeapro/whatsapp-http-api
+```
+
+![](/images/versions/plus.png) For Plus version the command is:
+```bash
+docker login -u devlikeapro -p {PASSWORD}
+docker pull devlikeapro/whatsapp-http-api-plus:arm
+docker logout
+
+# Rename it, so you can use devlikeapro/whatsapp-http-api image in other place
+docker tag devlikeapro/whatsapp-http-api-plus:arm devlikeapro/whatsapp-http-api
+```
+
 ### 2. Run WhatsApp HTTP API
 
 Run WhatsApp HTTP API:
 
 ```bash
-docker run -it --rm -v `pwd`/tokens:/app/tokens -p 127.0.0.1:3000:3000/tcp --name whatsapp-http-api devlikeapro/whatsapp-http-api
+docker run -it --rm -p 3000:3000/tcp --name whatsapp-http-api devlikeapro/whatsapp-http-api
 
 # It prints logs and the last line must be
 # WhatsApp HTTP API is running on: http://[::1]:3000
@@ -83,8 +122,8 @@ How to log in - the instruction on WhatsApp site
 
 When your ready - find `POST /api/session/start`, click on **Try it out**, then **Execute** a bit below.
 
-
 The example payload:
+
 ```json
 {
   "name": "default"
@@ -93,7 +132,8 @@ The example payload:
 
 ![](session-start.png)
 
-By using the request with `name` values you can start multiple session (WhatsApp accounts) inside the single docker container in Plus
+By using the request with `name` values you can start multiple session (WhatsApp accounts) inside the single docker
+container in Plus
 ![](/images/versions/plus.png) version and only one account in Core ![](/images/versions/core.png) version.
 
 Read more about [multiple sessions →]({{< relref "/docs/how-to/sessions" >}})
@@ -123,6 +163,7 @@ way: use a phone international phone number without `+` symbol and add `@c.us` a
 For phone number `12132132131` the `chatId` is  `12132132131@c.us`.
 
 The example payload:
+
 ```json
 {
   "chatId": "12132132130@c.us",

docs/site/content/nl/_index.md

@@ -1,10 +0,0 @@
----
-title : "Modern documentatie-thema"
-description: "Doks is een Hugo-thema waarmee je moderne documentatie-websites kunt bouwen die veilig, snel en klaar voor SEO zijn — standaard."
-lead: "Doks is een Hugo-thema waarmee je moderne documentatie-websites kunt bouwen die veilig, snel en klaar voor SEO zijn — standaard."
-date: 2020-10-06T08:47:36+00:00
-lastmod: 2020-10-06T08:47:36+00:00
-draft: false
-images: []
----
-

docs/site/content/nl/contact/index.md

@@ -1,10 +0,0 @@
----
-title: "Contact"
-description: "Drop us an email."
-date: 2020-08-27T19:25:12+02:00
-lastmod: 2020-08-27T19:25:12+02:00
-draft: true
-images: []
----
-
-{{< email user="hello" domain="getdoks.org" >}}

docs/site/content/nl/contributors/_index.md

@@ -1,10 +0,0 @@
----
-title: "Contributors"
-description: "The Doks contributors."
-date: 2020-10-06T08:50:29+00:00
-lastmod: 2020-10-06T08:50:29+00:00
-draft: false
-images: []
----
-
-The Doks contributors.

docs/site/content/nl/contributors/henk-verlinde/_index.md

@@ -1,12 +0,0 @@
----
-title: "Henk Verlinde"
-description: "Creator of Hyas."
-date: 2020-10-06T08:50:45+00:00
-lastmod: 2020-10-06T08:50:45+00:00
-draft: false
-images: []
----
-
-Creator of Hyas.
-
-[@HenkVerlinde](https://twitter.com/henkverlinde)

docs/site/content/nl/docs/_index.md

@@ -1,9 +0,0 @@
----
-title : "Docs"
-description: "Docs Doks."
-lead: ""
-date: 2020-10-06T08:48:23+00:00
-lastmod: 2020-10-06T08:48:23+00:00
-draft: false
-images: []
----

docs/site/content/nl/docs/help/_index.md

@@ -1,9 +0,0 @@
----
-title: "Help"
-description: "Help Doks."
-lead: ""
-date: 2020-10-06T08:49:15+00:00
-lastmod: 2020-10-06T08:49:15+00:00
-draft: false
-images: []
----

docs/site/content/nl/docs/help/faq.md

@@ -1,50 +0,0 @@
----
-title: "FAQ"
-description: "Answers to frequently asked questions."
-lead: "Answers to frequently asked questions."
-date: 2020-10-06T08:49:31+00:00
-lastmod: 2020-10-06T08:49:31+00:00
-draft: false
-images: []
-menu:
-  docs:
-    parent: "help"
-weight: 630
-toc: true
----
-
-## Hyas?
-
-Doks is a [Hyas theme](https://gethyas.com/themes/) build by the creator of Hyas.
-
-## Footer notice?
-
-Please keep it in place.
-
-## Keyboard shortcuts for search?
-
-- focus: `Ctrl + /`
-- select: `↓` and `↑`
-- open: `Enter`
-- close: `Esc`
-
-## Other documentation?
-
-- [Netlify](https://docs.netlify.com/)
-- [Hugo](https://gohugo.io/documentation/)
-
-## Can I get support?
-
-Create a topic:
-
-- [Netlify Community](https://community.netlify.com/)
-- [Hugo Forums](https://discourse.gohugo.io/)
-- [Doks Discussions](https://github.com/h-enk/doks/discussions)
-
-## Contact the creator?
-
-Send `h-enk` a message:
-
-- [Netlify Community](https://community.netlify.com/)
-- [Hugo Forums](https://discourse.gohugo.io/)
-- [Doks Discussions](https://github.com/h-enk/doks/discussions)

docs/site/content/nl/docs/help/how-to-update.md

@@ -1,32 +0,0 @@
----
-title: "How to Update"
-description: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure."
-lead: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure."
-date: 2020-11-12T13:26:54+01:00
-lastmod: 2020-11-12T13:26:54+01:00
-draft: false
-images: []
-menu:
-  docs:
-    parent: "help"
-weight: 610
-toc: true
----
-
-{{< alert icon="💡" text="Learn more about <a href=\"https://docs.npmjs.com/about-semantic-versioning\">semantic versioning</a> and <a href=\"https://docs.npmjs.com/cli/v6/using-npm/semver#advanced-range-syntax\">advanced range syntax</a>." />}}
-
-## Check for outdated packages
-
-The [`npm outdated`](https://docs.npmjs.com/cli/v7/commands/npm-outdated) command will check the registry to see if any (or, specific) installed packages are currently outdated:
-
-```bash
-npm outdated [[<@scope>/]<pkg> ...]
-```
-
-## Update packages
-
-The [`npm update`](https://docs.npmjs.com/cli/v7/commands/npm-update) command will update all the packages listed to the latest version (specified by the tag config), respecting semver:
-
-```bash
-npm update [<pkg>...]
-```

docs/site/content/nl/docs/help/troubleshooting.md

@@ -1,30 +0,0 @@
----
-title: "Troubleshooting"
-description: "Solutions to common problems."
-lead: "Solutions to common problems."
-date: 2020-11-12T15:22:20+01:00
-lastmod: 2020-11-12T15:22:20+01:00
-draft: false
-images: []
-menu: 
-  docs:
-    parent: "help"
-weight: 620
-toc: true
----
-
-## Problems updating npm packages
-
-Delete the `./node_modules` folder, and run again:
-
-```bash
-npm install
-```
-
-## Problems with cache
-
-Delete the temporary directories:
-
-```bash
-npm run clean
-```

docs/site/content/nl/docs/prologue/_index.md

@@ -1,9 +0,0 @@
----
-title : "Overview"
-description: "Overview Doks."
-lead: ""
-date: 2020-10-06T08:48:45+00:00
-lastmod: 2020-10-06T08:48:45+00:00
-draft: false
-images: []
----

docs/site/content/nl/docs/prologue/commands.md

@@ -1,98 +0,0 @@
----
-title: "Commands"
-description: "Doks comes with commands for common tasks."
-lead: "Doks comes with commands for common tasks."
-date: 2020-10-13T15:21:01+02:00
-lastmod: 2020-10-13T15:21:01+02:00
-draft: false
-images: []
-menu:
-  docs:
-    parent: "overview"
-weight: 130
-toc: true
----
-
-{{< alert icon="💡" text="You can change the commands in the scripts section of `./package.json`." />}}
-
-## create
-
-Create new content for your site:
-
-```bash
-npm run create [path] [flags]
-```
-
-See also the Hugo docs: [hugo new](https://gohugo.io/commands/hugo_new/).
-
-## lint
-
-Check scripts, styles, and markdown for errors:
-
-```bash
-npm run lint
-```
-
-### scripts
-
-Check scripts for errors:
-
-```bash
-npm run lint:scripts [-- --fix]
-```
-
-### styles
-
-Check styles for errors:
-
-```bash
-npm run lint:styles [-- --fix]
-```
-
-### markdown
-
-Check markdown for errors:
-
-```bash
-npm run lint:markdown [-- --fix]
-```
-
-## clean
-
-Delete temporary directories:
-
-```bash
-npm run clean
-```
-
-## start
-
-Start local development server:
-
-```bash
-npm run start
-```
-
-## build
-
-Build production website:
-
-```bash
-npm run build
-```
-
-### functions
-
-Build Lambda functions:
-
-```bash
-npm run build:functions
-```
-
-### preview
-
-Build production website including draft and future content:
-
-```bash
-npm run build:preview
-```

docs/site/content/nl/docs/prologue/introduction.md

@@ -1,58 +0,0 @@
----
-title: "Introduction"
-description: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
-lead: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
-date: 2020-10-06T08:48:57+00:00
-lastmod: 2020-10-06T08:48:57+00:00
-draft: false
-images: []
-menu:
-  docs:
-    parent: "overview"
-weight: 100
-toc: true
----
-
-## Get started
-
-There are two main ways to get started with Doks:
-
-### Tutorial
-
-{{< alert icon="👉" text="The Tutorial is intended for novice to intermediate users." />}}
-
-Step-by-step instructions on how to start a new Doks project. [Tutorial →](https://getdoks.org/tutorial/introduction/)
-
-### Quick Start
-
-{{< alert icon="👉" text="The Quick Start is intended for intermediate to advanced users." />}}
-
-One page summary of how to start a new Doks project. [Quick Start →]({{< relref "quick-start" >}})
-
-## Go further
-
-Recipes, Reference Guides, Extensions, and Showcase.
-
-### Recipes
-
-Get instructions on how to accomplish common tasks with Doks. [Recipes →](https://getdoks.org/docs/recipes/project-configuration/)
-
-### Reference Guides
-
-Learn how to customize Doks to fully make it your own. [Reference Guides →](https://getdoks.org/docs/reference-guides/security/)
-
-### Extensions
-
-Get instructions on how to add even more to Doks. [Extensions →](https://getdoks.org/docs/extensions/breadcrumb-navigation/)
-
-### Showcase
-
-See what others have build with Doks. [Showcase →](https://getdoks.org/showcase/electric-blocks/)
-
-## Contributing
-
-Find out how to contribute to Doks. [Contributing →](https://getdoks.org/docs/contributing/how-to-contribute/)
-
-## Help
-
-Get help on Doks. [Help →]({{< relref "how-to-update" >}})

docs/site/content/nl/docs/prologue/quick-start.md

@@ -1,69 +0,0 @@
----
-title: "Quick Start"
-description: "One page summary of how to start a new Doks project."
-lead: "One page summary of how to start a new Doks project."
-date: 2020-11-16T13:59:39+01:00
-lastmod: 2020-11-16T13:59:39+01:00
-draft: false
-images: []
-menu:
-  docs:
-    parent: "overview"
-weight: 110
-toc: true
----
-
-## Requirements
-
-Doks uses npm to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts:
-
-- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform.
-
-## Start a new Doks project
-
-Create a new site, change directories, install dependencies, and start development server.
-
-### Create a new site
-
-Doks is available as a child theme, and a starter theme:
-
-- Use the Doks child theme, if you do __not__ plan to customize a lot, and/or need future Doks updates.
-- Use the Doks starter theme, if you plan to customize a lot, and/or do __not__ need future Doks updates.
-
-Not quite sure? Use the Doks child theme.
-
-#### Doks child theme
-
-```bash
-git clone https://github.com/h-enk/doks-child-theme.git my-doks-site
-```
-
-#### Doks starter theme
-
-```bash
-git clone https://github.com/h-enk/doks.git my-doks-site
-```
-
-### Change directories
-
-```bash
-cd my-doks-site
-```
-
-### Install dependencies
-
-```bash
-npm install
-```
-
-### Start development server
-
-```bash
-npm run start
-```
-
-Doks will start the Hugo development webserver accessible by default at `http://localhost:1313`. Saved changes will live reload in the browser.
-
-## Other commands
-
-Doks comes with commands for common tasks. [Commands →]({{< relref "commands" >}})

docs/site/content/nl/privacy-policy/index.md

@@ -1,36 +0,0 @@
----
-title: "Privacy Policy"
-description: "We do not use cookies and we do not collect any personal data."
-date: 2020-08-27T19:23:18+02:00
-lastmod: 2020-08-27T19:23:18+02:00
-draft: true
-images: []
----
-
-__TLDR__: We do not use cookies and we do not collect any personal data.
-
-## Website visitors
-
-- No personal information is collected.
-- No information is stored in the browser.
-- No information is shared with, sent to or sold to third-parties.
-- No information is shared with advertising companies.
-- No information is mined and harvested for personal and behavioral trends.
-- No information is monetized.
-
-### Information we collect and what we use it for
-
-We run [Plausible](https://plausible.io/) analytics on getdoks.org. The following information is collected:
-
-- __Page URL__. We track the page URL of each page view on this website. We use this to understand which pages have been viewed and how many times a particular page has been viewed. For example: _https://getdoks.org/_.
-- __HTTP Referrer__. We use the referrer string to understand the number of visitors referred to this website from links on other sites. For example: _https://github.com/_.
-- __Browser__. We use this to understand what browsers people use when visiting this website. This is derived from the User-Agent HTTP header. The full User-Agent is discarded. For example: _Chrome_.
-- __Operating system__. We use this to understand what operating systems people use when visiting this website. We only use the brand of the operating system and don’t include the version number or any other details. This is derived from the User-Agent HTTP header. The full User-Agent is discarded. For example: _GNU/Linux_.
-- __Device type__. We use this to understand what devices people use when visiting this website. This is derived from window.innerWidth. The actual width of the browser in pixels is discarded. For example: _Desktop_.
-- __Visitor Country__. We look up the visitor’s country using the IP address. We do not track anything more granular than the country of origin and the IP address of the visitor is discarded. We never store IP addresses in our database or logs. For example: _Canada_.
-
-## Contact us
-
-[Contact us]({{< relref "contact/index.md" >}}) if you have any questions.
-
-Effective Date: _27th August 2020_

docs/site/layouts/index.html

@@ -4,11 +4,16 @@
     <div class="col-lg-12 text-center">
       <h1 class="mt-0">{{ .Title }}</h1>
     </div>
-    <div class="col-lg-9 col-xl-8 text-center">
+    <div class="col-lg-9 col-xl-9 text-center">
       <div class="mb-4">
         <img src="/images/logo.png" title="WhatsApp HTTP API" alt="logo" width="100"/>
       </div>
       <p class="lead">{{ .Params.lead | safeHTML }}</p>
+      <code>
+        docker run -it -p 3000:3000/tcp devlikeapro/whatsapp-http-api
+      </code>
+      <br/>
+      <br/>
       <a class="btn btn-primary btn-lg px-4 mb-2"
          href="/docs/{{ if .Site.Params.options.docsVersioning }}{{ .Site.Params.docsVersion }}/{{ end }}overview/introduction/"
          role="button">Get Started</a>
@@ -22,6 +27,14 @@
 <section class="section section-sm">
   <div class="container">
     <div class="row justify-content-center text-center">
+      <div class="col-lg-5">
+        <h2 class="h4">It's free!</h2>
+        <p>
+          <b>WAHA Core</b> version is always free!
+          <br>
+          Even <b>WAHA Plus</b> version have no licence expiration!
+        </p>
+      </div>
       <div class="col-lg-5">
         <h2 class="h4">Language agnostic</h2>
         <p>
@@ -34,18 +47,7 @@
       </div>
       <div class="col-lg-5">
         <h2 class="h4">Well documented</h2>
-        <p>Documentation has a lof examples and how to guide.</p>
-      </div>
-      <div class="col-lg-5">
-        <h2 class="h4">No blocking</h2>
-        <p>
-          Under the hood it runs a real instance of Whatsapp Web to avoid getting blocked.
-          <br/>
-          <small class="text-muted">
-            WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn't be considered
-            totally safe.
-          </small>
-        </p>
+        <p>Documentation has a lof examples and how-to guides.</p>
       </div>
     </div>
     <div class="row justify-content-center text-center">
@@ -67,11 +69,14 @@
         </p>
       </div>
       <div class="col-lg-5">
-        <h2 class="h4">It's free!</h2>
+        <h2 class="h4">No blocking</h2>
         <p>
-          <img src="/images/versions/core.png"> version is always free!
-          <br>
-          Even <img src="/images/versions/plus.png">  version does not require monthly donations and have no licence expiration!
+          Under the hood it runs a real instance of Whatsapp Web to avoid getting blocked.
+          <br/>
+          <small class="text-muted">
+            WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn't be considered
+            totally safe.
+          </small>
         </p>
       </div>
     </div>

docs/site/layouts/partials/head/custom-head.html

@@ -1 +1,17 @@
-<!-- Custom head -->
+<!-- Yandex.Metrika counter -->
+<script type="text/javascript" >
+   (function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)};
+   m[i].l=1*new Date();
+   for (var j = 0; j < document.scripts.length; j++) {if (document.scripts[j].src === r) { return; }}
+   k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)})
+   (window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
+
+   ym(91185978, "init", {
+        clickmap:true,
+        trackLinks:true,
+        accurateTrackBounce:true,
+        webvisor:true
+   });
+</script>
+<noscript><div><img src="https://mc.yandex.ru/watch/91185978" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
+<!-- /Yandex.Metrika counter -->

docs/site/static/swagger/index.html

@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
     <meta charset="UTF-8">
-    <title>devlikeapro/whatsapp-http-api</title>
+    <title>WAHA - WhatsApp HTTP API</title>
     <link href="./swagger-ui.css" rel="stylesheet" type="text/css">
     <link href="./favicon-32x32.png" rel="icon" sizes="32x32" type="image/png"/>
     <link href="./favicon-16x16.png" rel="icon" sizes="16x16" type="image/png"/>

docs/site/static/swagger/openapi.json

@@ -1 +1 @@
-{"openapi":"3.0.0","paths":{"/api/sessions/start":{"post":{"operationId":"SessionsController_start","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionStartRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionDTO"}}}}},"tags":["sessions"],"security":[{"api_key":[]}]}},"/api/sessions/stop":{"post":{"operationId":"SessionsController_stop","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionStopRequest"}}}},"responses":{"201":{"description":""}},"tags":["sessions"],"security":[{"api_key":[]}]}},"/api/sessions":{"get":{"operationId":"SessionsController_list","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SessionDTO"}}}}}},"tags":["sessions"],"security":[{"api_key":[]}]}},"/api/checkNumberStatus":{"get":{"operationId":"ChattingController_checkNumberStatus","summary":"Check number status","parameters":[{"name":"phone","required":true,"in":"query","schema":{"type":"string"}},{"name":"sessionName","required":true,"in":"query","schema":{"default":"default","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WANumberExistResult"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendContactVcard":{"post":{"operationId":"ChattingController_sendContactVcard","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageContactVcardRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendText":{"get":{"operationId":"ChattingController_sendTextGet","summary":"Send a text message","parameters":[{"name":"phone","required":true,"in":"query","schema":{"type":"string"}},{"name":"sessionName","required":true,"in":"query","schema":{"default":"default","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]},"post":{"operationId":"ChattingController_sendText","summary":"Send a text message","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageTextRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WAMessage"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendTextButtons":{"post":{"operationId":"ChattingController_sendTextButtons","summary":"Send a text message with buttons","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageTextButtonsRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendLocation":{"post":{"operationId":"ChattingController_sendLocation","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageLocationRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendLinkPreview":{"post":{"operationId":"ChattingController_sendLinkPreview","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageLinkPreviewRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendImage":{"post":{"operationId":"ChattingController_sendImage","summary":"Send an image. Either from an URL or base64 data - look at the request schemas for details.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageImageRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendFile":{"post":{"operationId":"ChattingController_sendFile","summary":"Send a file. Either from an URL or base64 data - look at the request schemas for details.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageFileRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendVoice":{"post":{"operationId":"ChattingController_sendVoice","summary":"Send an voice message. Either from an URL or base64 data - look at the request schemas for details.","parametersLine truncated
+{"openapi":"3.0.0","paths":{"/api/sessions/start":{"post":{"operationId":"SessionsController_start","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionStartRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionDTO"}}}}},"tags":["sessions"],"security":[{"api_key":[]}]}},"/api/sessions/stop":{"post":{"operationId":"SessionsController_stop","summary":"Stop session","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionStopRequest"}}}},"responses":{"201":{"description":""}},"tags":["sessions"],"security":[{"api_key":[]}]}},"/api/sessions/logout":{"post":{"operationId":"SessionsController_clean","summary":"Logout from session.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionLogoutRequest"}}}},"responses":{"201":{"description":""}},"tags":["sessions"],"security":[{"api_key":[]}]}},"/api/sessions":{"get":{"operationId":"SessionsController_list","parameters":[{"name":"all","required":false,"in":"query","example":false,"description":"Return all sessions, including those that are in the STOPPED state.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SessionDTO"}}}}}},"tags":["sessions"],"security":[{"api_key":[]}]}},"/api/checkNumberStatus":{"get":{"operationId":"ChattingController_checkNumberStatus","summary":"Check number status","parameters":[{"name":"phone","required":true,"in":"query","schema":{"type":"string"}},{"name":"session","required":true,"in":"query","schema":{"default":"default","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WANumberExistResult"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendContactVcard":{"post":{"operationId":"ChattingController_sendContactVcard","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageContactVcardRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendText":{"get":{"operationId":"ChattingController_sendTextGet","summary":"Send a text message","parameters":[{"name":"phone","required":true,"in":"query","schema":{"type":"string"}},{"name":"text","required":true,"in":"query","schema":{"type":"string"}},{"name":"session","required":true,"in":"query","schema":{"default":"default","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]},"post":{"operationId":"ChattingController_sendText","summary":"Send a text message","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageTextRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WAMessage"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendTextButtons":{"post":{"operationId":"ChattingController_sendTextButtons","summary":"Send a text message with buttons","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageTextButtonsRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendLocation":{"post":{"operationId":"ChattingController_sendLocation","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageLocationRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendLinkPreview":{"post":{"operationId":"ChattingController_sendLinkPreview","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageLinkPreviewRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendImage":{"post":{"operationId":"ChattingController_sendImage","summary":"Send an image. Either from an URL or base64 data - look at the request schemas for details.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageImageRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["chatting"],"security":[{"api_key":[]}]}},"/api/sendFile":{"post":{"operationId":"ChattingControllLine truncated

examples/python/README.md

@@ -0,0 +1,118 @@
+# WAHA (WhatsApp HTTP API) Python examples
+
+## Installation
+
+We assume that you have installed software:
+
+1. Python 3
+2. Docker
+
+### Download and start image
+
+First of all, you must run WhatsApp HTTP API locally (which under the hood it runs real WhatsApp Web instance and expose
+HTTP API for interaction).
+
+Here are the steps from [Quick Start](https://waha.devlike.pro/docs/overview/quick-start/):
+
+Download and start WhatsApp HTTP API docker container
+
+```bash
+# Download the image
+docker pull devlikeapro/whatsapp-http-api
+# Run the docker container
+docker run -it --rm --network=host -e WHATSAPP_HOOK_URL=http://localhost:5000/bot -e "WHATSAPP_HOOK_EVENTS=*" --name whatsapp-http-api devlikeapro/whatsapp-http-api
+
+# It prints logs and the last line must be
+# WhatsApp HTTP API is running on: http://[::1]:3000
+```
+
+#### Download image - ARM
+
+If you're using ARM (like Apple Silicon, Apple M1, etc) - use following commands to download the image
+
+![](/images/versions/core.png) For Core version the command is
+```bash
+# Download the image
+docker pull devlikeapro/whatsapp-http-api:arm
+# Rename it, so you can use devlikeapro/whatsapp-http-api image in other place
+docker tag devlikeapro/whatsapp-http-api:arm devlikeapro/whatsapp-http-api
+# Run the docker container
+docker run -it --rm --network=host -e WHATSAPP_HOOK_URL=http://localhost:5000/bot -e "WHATSAPP_HOOK_EVENTS=*" --name whatsapp-http-api devlikeapro/whatsapp-http-api
+
+# It prints logs and the last line must be
+# WhatsApp HTTP API is running on: http://[::1]:3000
+```
+
+### Start session and scan QR
+
+2. Open Swagger API in the browser http://localhost:3000/
+3. Start session and scan QR code in swagger
+    1. Find `POST /api/session/start` request press **Try it out** and **Execute** it with `default` session name
+    2. Find `GET /api/screenshot` and execute it - it must show QR code
+    3. Scan QR code on your mobile WhatsApp application (that installed on your phone)
+    4. Execute `GET /api/screenshot` once again - it must show the screenshot from WhatsApp Web.
+4. Send test text message - find `POST /api/sendText` and execute it with payload (change `12132132130` in the `chatId`
+   to phone number that is registered in WhatsApp).
+
+```json
+{
+  "chatId": "12132132130@c.us",
+  "text": "Hi there!",
+  "session": "default"
+}
+```
+
+If you see **Hi there!** message then you're ready to run bots!
+
+## WhatsApp Echo Bot
+
+The WhatsApp Echo Bot is a sample flask webhook server application that echoes back to you whatever you send it. It can
+serve
+as a basic reference for how to set up webhooks and reply to incoming messages.
+
+```bash
+# Clone the git repository with example
+git clone https://github.com/devlikeapro/whatsapp-http-api.git
+# Open python example folder
+cd whatsapp-http-api/examples/python
+# Install requirements
+python -mpip install -r requirements.txt
+# Run the bot
+FLASK_APP=whatsapp_echo_bot.py flask run
+```
+
+Open http://127.0.0.1:5000/bot - if you see **WhatsApp Echo Bot is ready!** then the bot is ready to receive message!
+
+Send message to the WhatsApp (that you used to scan QR code) and it'll echo text back to you!
+
+## WhatsApp Download Files Bot
+
+The WhatsApp Download Image Bot downloads all files people send to your WhatsApp and log the path for the file.
+
+**The bot works only with WAHA Plus version** available with donations.
+Visit [read more about difference between Core and Plus versions](https://waha.devlike.pro/docs/how-to/plus-version/).
+
+Download **WAHA Plus** version:
+
+```bash
+# Download the image
+docker pull devlikeapro/whatsapp-http-api-plus
+# Run the docker container
+docker run -it --rm --network=host -e WHATSAPP_HOOK_URL=http://localhost:5000/bot -e "WHATSAPP_HOOK_EVENTS=*" --name whatsapp-http-api devlikeapro/whatsapp-http-api-plus
+```
+
+Run the WhatsApp Download Files bot:
+
+```bash
+# Clone the git repository with example
+git clone https://github.com/devlikeapro/whatsapp-http-api.git
+# Open python example folder
+cd whatsapp-http-api/examples/python
+# Install requirements
+python -mpip install -r requirements.txt
+# Run the bot
+FLASK_APP=whatsapp_download_files_bot.py flask run
+```
+
+Open http://127.0.0.1:5000/bot - if you see **WhatsApp Download Files Bot!** then the bot is ready to receive message
+with files!

examples/python/echo.py

@@ -1,44 +0,0 @@
-from pprint import pprint
-
-import requests
-from flask import Flask
-from flask import request
-
-app = Flask(__name__)
-
-
-@app.route("/")
-def whatsapp_echo():
-    return "WhatsApp HTTP API Echo server is ready!"
-
-
-@app.route("/message", methods=["GET", "POST"])
-def whatsapp_webhook():
-    data = request.get_json()
-    if not data:
-        return "WhatsApp HTTP API Echo server is ready!"
-    pprint(data)
-    if data['event'] != "message":
-        return f"Unknown event {data['event']}"
-
-    payload = data["payload"]
-    # The text
-    text = payload["body"]
-    # Number in format 791111111@c.us
-    from_ = payload["from"]
-
-    if payload.get("mediaUrl", None):
-        # Download file and set text to path
-        client_url = payload["mediaUrl"]
-        filename = client_url.split("/")[-1]
-        path = "/tmp/" + filename
-        r = requests.get(client_url)
-        open(path, "wb").write(r.content)
-        text = f"We have downloaded file here: {path}"
-
-    # Send a text back via WhatsApp HTTP API
-    response = requests.post(
-        "http://localhost:3000/api/sendText", json={"chatId": from_, "text": text}
-    )
-    response.raise_for_status()
-    return "OK"

examples/python/requirements.txt

@@ -1,2 +1,3 @@
-flask
-requests
+flask~=1.0
+requests~=2.0
+markupsafe==2.0.1

examples/python/whatsapp_download_files_bot.py

@@ -0,0 +1,84 @@
+from os.path import abspath
+from pprint import pprint
+
+import requests
+from flask import Flask
+from flask import request
+
+app = Flask(__name__)
+
+
+def send_message(chat_id, text):
+    """
+    Send message to chat_id.
+    :param chat_id: Phone number + "@c.us" suffix - 1231231231@c.us
+    :param text: Message for the recipient
+    """
+    # Send a text back via WhatsApp HTTP API
+    response = requests.post(
+        "http://localhost:3000/api/sendText",
+        json={
+            "chatId": chat_id,
+            "text": text,
+            "session": "default",
+        },
+    )
+    response.raise_for_status()
+
+def send_seen(chat_id, message_id, participant):
+    response = requests.post(
+        "http://localhost:3000/api/sendSeen",
+        json={
+            "session": "default",
+            "chatId": chat_id,
+            "messageId": message_id,
+            "participant": participant,
+        },
+    )
+    response.raise_for_status()
+
+@app.route("/")
+def whatsapp_echo():
+    return "WhatsApp Download Files Bot is ready!"
+
+
+@app.route("/bot", methods=["GET", "POST"])
+def whatsapp_webhook():
+    if request.method == "GET":
+        return "WhatsApp Download Files Bot is ready!"
+
+    data = request.get_json()
+    pprint(data)
+    if data["event"] != "message":
+        # We can't process other event yet
+        return f"Unknown event {data['event']}"
+
+    payload = data["payload"]
+    # Ignore messages without files
+    if not payload.get("mediaUrl", None):
+        return "No files in the message"
+
+    # Number in format 791111111@c.us
+    chat_id = payload["from"]
+    # Message ID - false_11111111111@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+    message_id = payload['id']
+    # For groups - who sent the message
+    participant = payload.get('participant')
+    # IMPORTANT - Always send seen before sending new message
+    send_seen(chat_id=chat_id, message_id=message_id, participant=participant)
+
+    # Download the file and download it to the current folder
+    client_url = payload["mediaUrl"]
+    filename = client_url.split("/")[-1]
+    path = abspath("./" + filename)
+    r = requests.get(client_url)
+    with open(path, "wb") as f:
+        f.write(r.content)
+
+    # Send a text back via WhatsApp HTTP API
+    text = f"We have downloaded file here: {path}"
+    print(text)
+    send_message(chat_id=chat_id, text=text)
+
+    # Send OK back
+    return "OK"

examples/python/whatsapp_echo_bot.py

@@ -0,0 +1,88 @@
+from pprint import pprint
+
+import requests
+from flask import Flask
+from flask import request
+
+app = Flask(__name__)
+
+
+def send_message(chat_id, text):
+    """
+    Send message to chat_id.
+    :param chat_id: Phone number + "@c.us" suffix - 1231231231@c.us
+    :param text: Message for the recipient
+    """
+    # Send a text back via WhatsApp HTTP API
+    response = requests.post(
+        "http://localhost:3000/api/sendText",
+        json={
+            "chatId": chat_id,
+            "text": text,
+            "session": "default",
+        },
+    )
+    response.raise_for_status()
+
+def reply(chat_id, message_id, text):
+    response = requests.post(
+        "http://localhost:3000/api/reply",
+        json={
+            "chatId": chat_id,
+            "text": text,
+            "reply_to": message_id,
+            "session": "default",
+        },
+    )
+    response.raise_for_status()
+
+
+def send_seen(chat_id, message_id, participant):
+    response = requests.post(
+        "http://localhost:3000/api/sendSeen",
+        json={
+            "session": "default",
+            "chatId": chat_id,
+            "messageId": message_id,
+            "participant": participant,
+        },
+    )
+    response.raise_for_status()
+
+
+@app.route("/")
+def whatsapp_echo():
+    return "WhatsApp Echo Bot is ready!"
+
+
+@app.route("/bot", methods=["GET", "POST"])
+def whatsapp_webhook():
+    if request.method == "GET":
+        return "WhatsApp Echo Bot is ready!"
+
+    data = request.get_json()
+    pprint(data)
+    if data["event"] != "message":
+        # We can't process other event yet
+        return f"Unknown event {data['event']}"
+
+    # Payload that we've got
+    payload = data["payload"]
+    # The text
+    text = payload["body"]
+    # Number in format 1231231231@c.us or @g.us for group
+    chat_id = payload["from"]
+    # Message ID - false_11111111111@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+    message_id = payload['id']
+    # For groups - who sent the message
+    participant = payload.get('participant')
+    # IMPORTANT - Always send seen before sending new message
+    send_seen(chat_id=chat_id, message_id=message_id, participant=participant)
+
+    # Send a text back via WhatsApp HTTP API
+    send_message(chat_id=chat_id, text=text)
+    # OR reply on the message
+    # reply(chat_id=chat_id, message_id=message_id, text=text)
+
+    # Send OK back
+    return "OK"

package.json

@@ -22,6 +22,8 @@
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
+    "@adiwajshing/baileys": "github:WhiskeySockets/Baileys",
+    "@adiwajshing/keyed-db": "^0.2.4",
     "@nestjs/common": "^9.0.9",
     "@nestjs/config": "^0.5.0",
     "@nestjs/core": "^9.0.9",
@@ -29,11 +31,19 @@
     "@nestjs/platform-express": "^9.0.9",
     "@nestjs/serve-static": "^2.1.3",
     "@nestjs/swagger": "^6.0.5",
+    "@types/lodash": "^4.14.194",
+    "@types/ws": "^8.5.4",
     "class-validator": "^0.12.2",
     "del": "^6.0.0",
+    "express-basic-auth": "^1.2.1",
+    "file-type": "16.5.4",
+    "https-proxy-agent": "^7.0.0",
+    "link-preview-js": "^3.0.4",
+    "lodash": "^4.17.21",
     "mime-types": "^2.1.27",
     "passport": "^0.6.0",
     "passport-headerapikey": "^1.2.2",
+    "qrcode": "^1.5.1",
     "qrcode-terminal": "^0.12.0",
     "reflect-metadata": "^0.1.13",
     "request": "^2.88.2",
@@ -41,8 +51,8 @@
     "rimraf": "^3.0.2",
     "rxjs": "^7.1.0",
     "swagger-ui-express": "^4.1.4",
-    "venom-bot": "^4.3.0",
-    "whatsapp-web.js": "github:mrfelipemartins/whatsapp-web.js#fix-group-module"
+    "venom-bot": "5.0.1",
+    "whatsapp-web.js": "https://github.com/pedroslopez/whatsapp-web.js"
   },
   "devDependencies": {
     "@nestjs/cli": "^9.0.0",
@@ -50,13 +60,14 @@
     "@nestjs/testing": "^9.0.9",
     "@types/express": "^4.17.3",
     "@types/jest": "26.0.10",
-    "@types/node": "^13.9.1",
+    "@types/node": "^18.14.2",
     "@types/supertest": "^2.0.8",
     "@typescript-eslint/eslint-plugin": "3.9.1",
     "@typescript-eslint/parser": "3.9.1",
     "eslint": "7.7.0",
     "eslint-config-prettier": "^6.10.0",
     "eslint-plugin-import": "^2.20.1",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
     "jest": "26.4.2",
     "prettier": "^1.19.1",
     "supertest": "^4.0.2",
@@ -64,7 +75,7 @@
     "ts-loader": "^6.2.1",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.1.0",
-    "typescript": "4.7.4"
+    "typescript": "^4.8.4"
   },
   "jest": {
     "moduleFileExtensions": [
@@ -79,5 +90,6 @@
     },
     "coverageDirectory": "../coverage",
     "testEnvironment": "node"
-  }
+  },
+  "packageManager": "yarn@3.6.0"
 }

src/api/chatting.controller.ts

@@ -1,134 +1,152 @@
-import {Body, Controller, Get, Post, Put, Query} from '@nestjs/common';
-import {ApiOperation, ApiSecurity, ApiTags} from "@nestjs/swagger";
+import { Body, Controller, Get, Post, Put, Query } from '@nestjs/common';
+import { ApiOperation, ApiSecurity, ApiTags } from '@nestjs/swagger';
+
+import { SessionManager } from '../core/abc/manager.abc';
 import {
-    ChatRequest,
-    CheckNumberStatusQuery,
-    MessageContactVcardRequest,
-    MessageFileRequest,
-    MessageImageRequest,
-    MessageLinkPreviewRequest,
-    MessageLocationRequest,
-    MessageReactionRequest,
-    MessageReplyRequest,
-    MessageTextButtonsRequest,
-    MessageTextQuery,
-    MessageTextRequest,
-    MessageVoiceRequest
-} from "../structures/chatting.dto";
-import {WAMessage, WANumberExistResult} from "../structures/responses.dto";
-import {SessionManager} from "../core/abc/manager.abc";
+  ChatRequest,
+  CheckNumberStatusQuery,
+  GetMessageQuery,
+  MessageContactVcardRequest,
+  MessageFileRequest,
+  MessageImageRequest,
+  MessageLinkPreviewRequest,
+  MessageLocationRequest,
+  MessageReactionRequest,
+  MessageReplyRequest,
+  MessageTextButtonsRequest,
+  MessageTextQuery,
+  MessageTextRequest,
+  MessageVoiceRequest,
+  SendSeenRequest,
+} from '../structures/chatting.dto';
+import { WAMessage, WANumberExistResult } from '../structures/responses.dto';
 
 @ApiSecurity('api_key')
 @Controller('api')
 @ApiTags('chatting')
 export class ChattingController {
-    constructor(private manager: SessionManager) {
-    }
+  constructor(private manager: SessionManager) {}
 
-    @Get('/checkNumberStatus')
-    @ApiOperation({summary: 'Check number status'})
-    async checkNumberStatus(@Query() request: CheckNumberStatusQuery): Promise<WANumberExistResult> {
-        const whatsapp = this.manager.getSession(request.sessionName)
-        return whatsapp.checkNumberStatus(request)
-    }
+  @Get('/checkNumberStatus')
+  @ApiOperation({ summary: 'Check number status' })
+  async checkNumberStatus(
+    @Query() request: CheckNumberStatusQuery,
+  ): Promise<WANumberExistResult> {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.checkNumberStatus(request);
+  }
 
-    @Post('/sendContactVcard')
-    sendContactVcard(@Body() request: MessageContactVcardRequest) {
-        const whatsapp = this.manager.getSession(request.session)
-        return whatsapp.sendContactVCard(request)
-    }
+  @Post('/sendContactVcard')
+  sendContactVcard(@Body() request: MessageContactVcardRequest) {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.sendContactVCard(request);
+  }
 
-    @Get('/sendText')
-    @ApiOperation({summary: 'Send a text message'})
-    sendTextGet(
-        @Query() query: MessageTextQuery,
-    ) {
-        const whatsapp = this.manager.getSession(query.sessionName)
-        const msg = new MessageTextRequest()
-        msg.chatId = query.phone
-        msg.text = query.text
-        return whatsapp.sendText(new MessageTextRequest())
-    }
+  @Get('/sendText')
+  @ApiOperation({ summary: 'Send a text message' })
+  sendTextGet(@Query() query: MessageTextQuery) {
+    const whatsapp = this.manager.getSession(query.session);
+    const msg = new MessageTextRequest();
+    msg.chatId = query.phone;
+    msg.text = query.text;
+    return whatsapp.sendText(msg);
+  }
 
-    @Post('/sendText')
-    @ApiOperation({summary: 'Send a text message'})
-    sendText(@Body() request: MessageTextRequest): Promise<WAMessage> {
-        const whatsapp = this.manager.getSession(request.session)
-        return whatsapp.sendText(request)
-    }
+  @Post('/sendText')
+  @ApiOperation({ summary: 'Send a text message' })
+  sendText(@Body() request: MessageTextRequest): Promise<WAMessage> {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.sendText(request);
+  }
 
-    @Post('/sendTextButtons')
-    @ApiOperation({summary: 'Send a text message with buttons'})
-    sendTextButtons(@Body() request: MessageTextButtonsRequest) {
-        const whatsapp = this.manager.getSession(request.session)
-        return whatsapp.sendTextButtons(request)
-    }
+  @Post('/sendTextButtons')
+  @ApiOperation({ summary: 'Send a text message with buttons' })
+  sendTextButtons(@Body() request: MessageTextButtonsRequest) {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.sendTextButtons(request);
+  }
 
-    @Post('/sendLocation')
-    sendLocation(@Body() request: MessageLocationRequest) {
-        const whatsapp = this.manager.getSession(request.session)
-        return whatsapp.sendLocation(request)
-    }
+  @Post('/sendLocation')
+  sendLocation(@Body() request: MessageLocationRequest) {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.sendLocation(request);
+  }
 
-    @Post('/sendLinkPreview')
-    sendLinkPreview(@Body() request: MessageLinkPreviewRequest) {
-        const whatsapp = this.manager.getSession(request.session)
-        return whatsapp.sendLinkPreview(request)
-    }
+  @Post('/sendLinkPreview')
+  sendLinkPreview(@Body() request: MessageLinkPreviewRequest) {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.sendLinkPreview(request);
+  }
 
-    @Post('/sendImage')
-    @ApiOperation({summary: "Send an image. Either from an URL or base64 data - look at the request schemas for details."})
-    sendImage(@Body() request: MessageImageRequest) {
-        const whatsapp = this.manager.getSession(request.session)
-        return whatsapp.sendImage(request)
-    }
+  @Post('/sendImage')
+  @ApiOperation({
+    summary:
+      'Send an image. Either from an URL or base64 data - look at the request schemas for details.',
+  })
+  sendImage(@Body() request: MessageImageRequest) {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.sendImage(request);
+  }
 
-    @Post('/sendFile')
-    @ApiOperation({summary: "Send a file. Either from an URL or base64 data - look at the request schemas for details."})
-    sendFile(@Body() request: MessageFileRequest) {
-        const whatsapp = this.manager.getSession(request.session)
-        return whatsapp.sendFile(request)
-    }
+  @Post('/sendFile')
+  @ApiOperation({
+    summary:
+      'Send a file. Either from an URL or base64 data - look at the request schemas for details.',
+  })
+  sendFile(@Body() request: MessageFileRequest) {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.sendFile(request);
+  }
 
-    @Post('/sendVoice')
-    @ApiOperation({summary: "Send an voice message. Either from an URL or base64 data - look at the request schemas for details."})
-    sendVoice(@Body() request: MessageVoiceRequest) {
-        const whatsapp = this.manager.getSession(request.session)
-        return whatsapp.sendVoice(request)
-    }
+  @Post('/sendVoice')
+  @ApiOperation({
+    summary:
+      'Send an voice message. Either from an URL or base64 data - look at the request schemas for details.',
+  })
+  sendVoice(@Body() request: MessageVoiceRequest) {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.sendVoice(request);
+  }
 
-    @Post('/reply')
-    @ApiOperation({summary: 'Reply to a text message'})
-    reply(@Body() request: MessageReplyRequest) {
-        const whatsapp = this.manager.getSession(request.session)
-        return whatsapp.reply(request)
-    }
+  @Post('/reply')
+  @ApiOperation({ summary: 'Reply to a text message' })
+  reply(@Body() request: MessageReplyRequest) {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.reply(request);
+  }
 
-    @Post('/sendSeen')
-    sendSeen(@Body() chat: ChatRequest) {
-        const whatsapp = this.manager.getSession(chat.session)
-        return whatsapp.sendSeen(chat)
-    }
+  @Post('/sendSeen')
+  sendSeen(@Body() chat: SendSeenRequest) {
+    const whatsapp = this.manager.getSession(chat.session);
+    return whatsapp.sendSeen(chat);
+  }
 
-    @Post('/startTyping')
-    async startTyping(@Body() chat: ChatRequest) {
-        // It's infinitive action
-        const whatsapp = this.manager.getSession(chat.session)
-        await whatsapp.startTyping(chat)
-        return {result: true}
-    }
+  @Post('/startTyping')
+  async startTyping(@Body() chat: ChatRequest) {
+    // It's infinitive action
+    const whatsapp = this.manager.getSession(chat.session);
+    await whatsapp.startTyping(chat);
+    return { result: true };
+  }
 
-    @Post('/stopTyping')
-    async stopTyping(@Body() chat: ChatRequest) {
-        const whatsapp = this.manager.getSession(chat.session)
-        await whatsapp.stopTyping(chat)
-        return {result: true}
-    }
+  @Post('/stopTyping')
+  async stopTyping(@Body() chat: ChatRequest) {
+    const whatsapp = this.manager.getSession(chat.session);
+    await whatsapp.stopTyping(chat);
+    return { result: true };
+  }
 
-    @Put('/reaction')
-    @ApiOperation({summary: 'React to a message with an emoji'})
-    setReaction(@Body() request: MessageReactionRequest) {
-        const whatsapp = this.manager.getSession(request.session)
-        return whatsapp.setReaction(request)
-    }
+  @Put('/reaction')
+  @ApiOperation({ summary: 'React to a message with an emoji' })
+  setReaction(@Body() request: MessageReactionRequest) {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.setReaction(request);
+  }
+
+  @Get('/messages')
+  @ApiOperation({ summary: 'Get messages in a chat' })
+  getMessages(@Query() query: GetMessageQuery) {
+    const whatsapp = this.manager.getSession(query.session);
+    return whatsapp.getMessages(query);
+  }
 }

src/api/contacts.controller.ts

@@ -0,0 +1,74 @@
+import { Body, Controller, Get, Post, Query } from '@nestjs/common';
+import { ApiOperation, ApiSecurity, ApiTags } from '@nestjs/swagger';
+
+import { SessionManager } from '../core/abc/manager.abc';
+import { SessionQuery } from '../structures/base.dto';
+import { CheckNumberStatusQuery } from '../structures/chatting.dto';
+import { ContactQuery, ContactRequest } from '../structures/contacts.dto';
+import { WANumberExistResult } from '../structures/responses.dto';
+
+@ApiSecurity('api_key')
+@Controller('api/contacts')
+@ApiTags('contacts')
+export class ContactsController {
+  constructor(private manager: SessionManager) {}
+
+  @Get('/')
+  @ApiOperation({
+    summary:
+      'Get contact basic info. The method always return result, even if the phone number is not registered in WhatsApp. For that - use /check-exists endpoint below.',
+  })
+  get(@Query() query: ContactQuery) {
+    const whatsapp = this.manager.getSession(query.session);
+    return whatsapp.getContact(query);
+  }
+
+  @Get('/all')
+  @ApiOperation({ summary: 'Get all contacts' })
+  getAll(@Query() query: SessionQuery) {
+    const whatsapp = this.manager.getSession(query.session);
+    return whatsapp.getContacts();
+  }
+
+  @Get('/check-exists')
+  @ApiOperation({ summary: 'Check phone number is registered in WhatsApp.' })
+  async checkExists(
+    @Query() request: CheckNumberStatusQuery,
+  ): Promise<WANumberExistResult> {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.checkNumberStatus(request);
+  }
+
+  @Get('/about')
+  @ApiOperation({
+    summary:
+      'Gets the Contact\'s current "about" info. Returns null if you don\'t have permission to read their status.',
+  })
+  getAbout(@Query() query: ContactQuery) {
+    const whatsapp = this.manager.getSession(query.session);
+    return whatsapp.getContactAbout(query);
+  }
+
+  @Get('/profile-picture')
+  @ApiOperation({
+    summary:
+      "Returns the contact's profile picture URL, if privacy settings allow it.",
+  })
+  getProfilePicture(@Query() query: ContactQuery) {
+    const whatsapp = this.manager.getSession(query.session);
+    return whatsapp.getContactProfilePicture(query);
+  }
+
+  @Post('/block')
+  @ApiOperation({ summary: 'Block contact' })
+  block(@Body() request: ContactRequest) {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.blockContact(request);
+  }
+  @Post('/unblock')
+  @ApiOperation({ summary: 'Unblock contact' })
+  unblock(@Body() request: ContactRequest) {
+    const whatsapp = this.manager.getSession(request.session);
+    return whatsapp.unblockContact(request);
+  }
+}

src/api/exception.filter.ts

@@ -1,6 +1,13 @@
-import {ArgumentsHost, Catch, ExceptionFilter, HttpException, HttpStatus,} from '@nestjs/common';
-import {Request, Response} from 'express';
-import {VERSION} from "../version";
+import {
+  ArgumentsHost,
+  Catch,
+  ExceptionFilter,
+  HttpException,
+  HttpStatus,
+} from '@nestjs/common';
+import { Request, Response } from 'express';
+
+import { VERSION } from '../version';
 
 /**
  * Serializer error to JSON.
@@ -8,42 +15,36 @@ import {VERSION} from "../version";
  * Credits: https://stackoverflow.com/a/72707578/6753144
  */
 export function serializeError(err: unknown) {
-    const properties = Object.getOwnPropertyNames(err)
-    // getOwnPropertyNames does not get 'name', like "ReferenceError"
-    properties.push('name')
-    return JSON.parse(JSON.stringify(err, properties))
+  const properties = Object.getOwnPropertyNames(err);
+  // getOwnPropertyNames does not get 'name', like "ReferenceError"
+  properties.push('name');
+  return JSON.parse(JSON.stringify(err, properties));
 }
 
 @Catch()
 export class AllExceptionsFilter implements ExceptionFilter {
-    catch(exception: HttpException | Error, host: ArgumentsHost): void {
-
-        const ctx = host.switchToHttp();
-        const response = ctx.getResponse<Response>();
-        const request = ctx.getRequest<Request>();
-
-        if (exception instanceof HttpException) {
-            response
-                .status(exception.getStatus())
-                .json(exception.getResponse());
-            return
-        }
-
-        const httpStatus = HttpStatus.INTERNAL_SERVER_ERROR
-        response
-            .status(httpStatus)
-            .json({
-                statusCode: httpStatus,
-                timestamp: new Date().toISOString(),
-                exception: serializeError(exception),
-                request: {
-                    path: request.url,
-                    method: request.method,
-                    body: request.body,
-                    query: request.query,
-                },
-                version: VERSION,
-            });
+  catch(exception: HttpException | Error, host: ArgumentsHost): void {
+    const ctx = host.switchToHttp();
+    const response = ctx.getResponse<Response>();
+    const request = ctx.getRequest<Request>();
 
+    if (exception instanceof HttpException) {
+      response.status(exception.getStatus()).json(exception.getResponse());
+      return;
     }
+
+    const httpStatus = HttpStatus.INTERNAL_SERVER_ERROR;
+    response.status(httpStatus).json({
+      statusCode: httpStatus,
+      timestamp: new Date().toISOString(),
+      exception: serializeError(exception),
+      request: {
+        path: request.url,
+        method: request.method,
+        body: request.body,
+        query: request.query,
+      },
+      version: VERSION,
+    });
+  }
 }

src/api/groups.controller.ts

@@ -0,0 +1,174 @@
+import {
+  Body,
+  Controller,
+  Delete,
+  Get,
+  Param,
+  Post,
+  Put,
+} from '@nestjs/common';
+import { ApiOperation, ApiSecurity, ApiTags } from '@nestjs/swagger';
+
+import { SessionManager } from '../core/abc/manager.abc';
+import { WhatsappSession } from '../core/abc/session.abc';
+import {
+  CreateGroupRequest,
+  DescriptionRequest,
+  ParticipantsRequest,
+  SubjectRequest,
+} from '../structures/groups.dto';
+import { SessionApiParam, SessionParam } from './helpers';
+
+@ApiSecurity('api_key')
+@Controller('api/:session/groups')
+@ApiTags('groups')
+export class GroupsController {
+  constructor(private manager: SessionManager) {}
+
+  @Post('')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Create a new group.' })
+  createGroup(
+    @SessionParam session: WhatsappSession,
+    @Body() request: CreateGroupRequest,
+  ) {
+    return session.createGroup(request);
+  }
+
+  @Get('')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Get all groups.' })
+  getGroups(@SessionParam session: WhatsappSession) {
+    return session.getGroups();
+  }
+
+  @Get(':id')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Get the group.' })
+  getGroup(@SessionParam session: WhatsappSession, @Param('id') id: string) {
+    return session.getGroup(id);
+  }
+
+  @Delete(':id')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Delete the group.' })
+  deleteGroup(@SessionParam session: WhatsappSession, @Param('id') id: string) {
+    return session.deleteGroup(id);
+  }
+
+  @Post(':id/leave')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Leave the group.' })
+  leaveGroup(@SessionParam session: WhatsappSession, @Param('id') id: string) {
+    return session.leaveGroup(id);
+  }
+
+  @Put(':id/description')
+  @ApiOperation({
+    summary:
+      'Updates the group description.\n' +
+      'Returns true if the subject was properly updated. This can return false if the user does not have the necessary permissions.\n',
+  })
+  @SessionApiParam
+  setDescription(
+    @SessionParam session: WhatsappSession,
+    @Param('id') id: string,
+    @Body() request: DescriptionRequest,
+  ) {
+    return session.setDescription(id, request.description);
+  }
+
+  @Put(':id/subject')
+  @SessionApiParam
+  @ApiOperation({
+    summary:
+      'Updates the group subject.\n' +
+      'Returns true if the subject was properly updated. This can return false if the user does not have the necessary permissions.\n',
+  })
+  setSubject(
+    @SessionParam session: WhatsappSession,
+    @Param('id') id: string,
+    @Body() request: SubjectRequest,
+  ) {
+    return session.setSubject(id, request.subject);
+  }
+
+  @Get(':id/invite-code')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Gets the invite code for a specific group.' })
+  getInviteCode(
+    @SessionParam session: WhatsappSession,
+    @Param('id') id: string,
+  ): Promise<string> {
+    return session.getInviteCode(id);
+  }
+
+  @Post(':id/invite-code/revoke')
+  @SessionApiParam
+  @ApiOperation({
+    summary:
+      'Invalidates the current group invite code and generates a new one.',
+  })
+  revokeInviteCode(
+    @SessionParam session: WhatsappSession,
+    @Param('id') id: string,
+  ): Promise<string> {
+    return session.revokeInviteCode(id);
+  }
+
+  @Get(':id/participants/')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Get a list of participants by in the group.' })
+  getParticipants(
+    @SessionParam session: WhatsappSession,
+    @Param('id') id: string,
+  ) {
+    return session.getParticipants(id);
+  }
+
+  @Post(':id/participants/add')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Adds a list of participants by ID to the group.' })
+  addParticipants(
+    @SessionParam session: WhatsappSession,
+    @Param('id') id: string,
+    @Body() request: ParticipantsRequest,
+  ) {
+    return session.addParticipants(id, request);
+  }
+
+  @Post(':id/participants/remove')
+  @SessionApiParam
+  @ApiOperation({
+    summary: 'Removes a list of participants by ID to the group.',
+  })
+  removeParticipants(
+    @SessionParam session: WhatsappSession,
+    @Param('id') id: string,
+    @Body() request: ParticipantsRequest,
+  ) {
+    return session.removeParticipants(id, request);
+  }
+
+  @Post(':id/admin/promote')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Promote participants to admin users.' })
+  promoteToAdmin(
+    @SessionParam session: WhatsappSession,
+    @Param('id') id: string,
+    @Body() request: ParticipantsRequest,
+  ) {
+    return session.promoteParticipantsToAdmin(id, request);
+  }
+
+  @Post(':id/admin/demote')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Demotes participants by to regular users.' })
+  demoteToAdmin(
+    @SessionParam session: WhatsappSession,
+    @Param('id') id: string,
+    @Body() request: ParticipantsRequest,
+  ) {
+    return session.demoteParticipantsToUser(id, request);
+  }
+}

src/api/helpers.ts

@@ -0,0 +1,35 @@
+import { Injectable, Param, PipeTransform } from '@nestjs/common';
+import { ApiParam } from '@nestjs/swagger';
+
+import { SessionManager } from '../core/abc/manager.abc';
+import { WhatsappSession } from '../core/abc/session.abc';
+
+/**
+ * Get session name and return Whatsapp session back (if exists)
+ * use it as
+ @Param('session', SessionPipe) session: WhatsappSession,
+ */
+@Injectable()
+export class SessionPipe implements PipeTransform<WhatsappSession> {
+  constructor(private manager: SessionManager) {}
+
+  async transform(value: any) {
+    return this.manager.getSession(value);
+  }
+}
+
+/**
+ * Decorator for a method that uses SessionPipe above
+ */
+export const SessionApiParam = ApiParam({
+  name: 'session',
+  required: true,
+  type: 'string',
+  description: 'WhatsApp session name',
+});
+
+/**
+ * Session param
+ @SessionParam session: WhatsappSession,
+ */
+export const SessionParam = Param('session', SessionPipe);

src/api/presence.controller.ts

@@ -0,0 +1,89 @@
+import {
+  BadRequestException,
+  Body,
+  Controller,
+  Get,
+  Param,
+  Post,
+} from '@nestjs/common';
+import { ApiOperation, ApiSecurity, ApiTags } from '@nestjs/swagger';
+
+import { SessionManager } from '../core/abc/manager.abc';
+import { WhatsappSession } from '../core/abc/session.abc';
+import {
+  WAHAChatPresences,
+  WAHASessionPresence,
+} from '../structures/presence.dto';
+import { SessionApiParam, SessionParam } from './helpers';
+import { WAHAPresenceStatus } from '../structures/enums.dto';
+
+@ApiSecurity('api_key')
+@Controller('api/:session/presence')
+@ApiTags('presence')
+export class PresenceController {
+  constructor(private manager: SessionManager) {}
+
+  @Post('')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Set session presence' })
+  setPresence(
+    @SessionParam session: WhatsappSession,
+    @Body() request: WAHASessionPresence,
+  ) {
+    // Validate request
+    const presencesWithoutChatId = [
+      WAHAPresenceStatus.ONLINE,
+      WAHAPresenceStatus.OFFLINE,
+    ];
+    const requiresNoChatId = presencesWithoutChatId.includes(request.presence);
+    const requiresChatId = !requiresNoChatId;
+
+    if (requiresNoChatId && request.chatId) {
+      const msg = {
+        detail: `'${request.presence}' presence works on the global scope and doesn't require 'chatId' field.`,
+      };
+      throw new BadRequestException(msg);
+    } else if (requiresChatId && !request.chatId) {
+      const msg = {
+        detail: `'${request.presence}' presence requires 'chatId' field.`,
+      };
+      throw new BadRequestException(msg);
+    }
+
+    return session.setPresence(request.presence, request.chatId);
+  }
+
+  @Get('')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Get all subscribed presence information.' })
+  getPresenceAll(
+    @SessionParam session: WhatsappSession,
+  ): Promise<WAHAChatPresences[]> {
+    return session.getPresences();
+  }
+
+  @Get(':chatId')
+  @SessionApiParam
+  @ApiOperation({
+    summary:
+      "Get the presence for the chat id. If it hasn't been subscribed - it also subscribes to it.",
+  })
+  getPresence(
+    @SessionParam session: WhatsappSession,
+    @Param('chatId') chatId: string,
+  ): Promise<WAHAChatPresences> {
+    return session.getPresence(chatId);
+  }
+
+  @Post(':chatId/subscribe')
+  @SessionApiParam
+  @ApiOperation({
+    summary: 'Subscribe to presence events for the chat.',
+  })
+  subscribe(
+    @SessionParam session: WhatsappSession,
+    @Param('chatId') chatId: string,
+  ): Promise<void> {
+    return session.subscribePresence(chatId);
+  }
+}

src/api/screenshot.controller.ts

@@ -1,34 +1,29 @@
-import {Controller, Get, Query, Res} from '@nestjs/common';
-import {ApiSecurity, ApiTags} from "@nestjs/swagger";
-import {Readable} from "stream";
-import {Response} from 'express';
-import {SessionQuery} from "../structures/chatting.dto";
-import {SessionManager} from "../core/abc/manager.abc";
+import { Controller, Get, Query, Res } from '@nestjs/common';
+import { ApiSecurity, ApiTags } from '@nestjs/swagger';
+import { Response } from 'express';
+import { Readable } from 'stream';
 
+import { SessionManager } from '../core/abc/manager.abc';
+import { SessionQuery } from '../structures/base.dto';
 
 @ApiSecurity('api_key')
 @Controller('api')
 @ApiTags('screenshot')
 export class ScreenshotController {
-    constructor(private manager: SessionManager) {
-    }
+  constructor(private manager: SessionManager) {}
 
-    @Get('/screenshot')
-    async screenshot(
-        @Res() res: Response,
-        @Query() sessionQuery: SessionQuery,
-    ) {
-        const whatsappService = this.manager.getSession(sessionQuery.sessionName)
-        const buffer = await whatsappService.getScreenshot();
-        const stream = new Readable();
-        stream.push(buffer);
-        stream.push(null);
+  @Get('/screenshot')
+  async screenshot(@Res() res: Response, @Query() sessionQuery: SessionQuery) {
+    const whatsappService = this.manager.getSession(sessionQuery.session);
+    const buffer = await whatsappService.getScreenshot();
+    const stream = new Readable();
+    stream.push(buffer);
+    stream.push(null);
 
-        res.set({
-            'Content-Type': 'image/png',
-            'Content-Length': buffer.length,
-        });
-        stream.pipe(res)
-    }
+    res.set({
+      'Content-Type': 'image/png',
+      'Content-Length': buffer.length,
+    });
+    stream.pipe(res);
+  }
 }
-

src/api/sessions.controller.ts

@@ -1,30 +1,52 @@
-import {Body, Controller, Get, Post} from '@nestjs/common';
-import {ApiSecurity, ApiTags} from "@nestjs/swagger";
-import {SessionDTO, SessionStartRequest, SessionStopRequest} from "../structures/sessions.dto";
-import {SessionManager} from "../core/abc/manager.abc";
+import { Body, Controller, Get, Post, Query } from '@nestjs/common';
+import { UnprocessableEntityException } from '@nestjs/common/exceptions/unprocessable-entity.exception';
+import { ApiOperation, ApiSecurity, ApiTags } from '@nestjs/swagger';
 
+import { SessionManager } from '../core/abc/manager.abc';
+import { parseBool } from '../helpers';
+import {
+  ListSessionsQuery,
+  SessionDTO,
+  SessionLogoutRequest,
+  SessionStartRequest,
+  SessionStopRequest,
+} from '../structures/sessions.dto';
 
 @ApiSecurity('api_key')
 @Controller('api/sessions')
 @ApiTags('sessions')
 export class SessionsController {
-    constructor(private manager: SessionManager) {
-    }
+  constructor(private manager: SessionManager) {}
 
+  @Post('/start/')
+  async start(@Body() request: SessionStartRequest): Promise<SessionDTO> {
+    const result = await this.manager.start(request);
+    await this.manager.sessionStorage.configRepository.save(
+      request.name,
+      request.config,
+    );
+    return result;
+  }
 
-    @Post('/start/')
-    start(@Body() request: SessionStartRequest): SessionDTO {
-        return this.manager.start(request)
+  @Post('/stop/')
+  @ApiOperation({ summary: 'Stop session' })
+  async stop(@Body() request: SessionStopRequest): Promise<void> {
+    await this.manager.stop(request);
+    if (request.logout) {
+      await this.manager.logout(request);
     }
+    return;
+  }
 
-    @Post('/stop/')
-    stop(@Body() request: SessionStopRequest): Promise<void> {
-        return this.manager.stop(request)
-    }
+  @Post('/logout/')
+  @ApiOperation({ summary: 'Logout from session.' })
+  clean(@Body() request: SessionLogoutRequest): Promise<void> {
+    return this.manager.logout(request);
+  }
 
-    @Get('/')
-    list(): SessionDTO[] {
-        return this.manager.getSessions()
-    }
+  @Get('/')
+  async list(@Query() query: ListSessionsQuery): Promise<SessionDTO[]> {
+    const all = parseBool(query.all);
+    return this.manager.getSessions(all);
+  }
 }
-

src/api/version.controller.ts

@@ -1,15 +1,14 @@
-import {Controller, Get} from '@nestjs/common';
-import {ApiSecurity, ApiTags} from "@nestjs/swagger";
-import {VERSION} from "../version";
+import { Controller, Get } from '@nestjs/common';
+import { ApiSecurity, ApiTags } from '@nestjs/swagger';
 
+import { VERSION } from '../version';
 
 @ApiSecurity('api_key')
 @Controller('api/version')
 @ApiTags('other')
 export class VersionController {
-    @Get('')
-    async get() {
-        return VERSION
-    }
+  @Get('')
+  async get() {
+    return VERSION;
+  }
 }
-

src/config.service.ts

@@ -1,79 +1,139 @@
-import {Injectable} from "@nestjs/common";
-import {ConfigService} from "@nestjs/config";
-import {WhatsappEngine} from "./structures/enums.dto";
+import { Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+
+import { parseBool } from './helpers';
+import { WAHAEngine } from './structures/enums.dto';
+import { WebhookConfig } from './structures/webhooks.dto';
 
 @Injectable()
 export class WhatsappConfigService {
-    public files_uri = '/api/files'
-    public schema = "http"
+  public files_uri = '/api/files';
+  public schema = 'http';
 
-    constructor(private configService: ConfigService) {
+  constructor(private configService: ConfigService) {}
+
+  get filesURL(): string {
+    return `${this.schema}://${this.hostname}:${this.port}${this.files_uri}/`;
+  }
+
+  get hostname(): string {
+    return this.configService.get('WHATSAPP_API_HOSTNAME', 'localhost');
+  }
+
+  get port(): string {
+    return this.configService.get('WHATSAPP_API_PORT', '3000');
+  }
+
+  get filesFolder(): string {
+    return this.configService.get(
+      'WHATSAPP_FILES_FOLDER',
+      '/tmp/whatsapp-files',
+    );
+  }
+
+  get filesLifetime(): number {
+    return this.configService.get<number>('WHATSAPP_FILES_LIFETIME', 180);
+  }
+
+  get mimetypes(): string[] | null {
+    const types = this.configService.get('WHATSAPP_FILES_MIMETYPES', '');
+    return types ? types.split(',') : null;
+  }
+
+  get startSessions(): string[] {
+    const value: string = this.configService.get('WHATSAPP_START_SESSION', '');
+    if (!value) {
+      return [];
     }
+    return value.split(',');
+  }
 
-    get filesURL(): string {
-        return `${this.schema}://${this.hostname}:${this.port}${this.files_uri}/`
+  get shouldRestartAllSessions(): boolean {
+    const value: string = this.configService.get(
+      'WHATSAPP_RESTART_ALL_SESSIONS',
+      'false',
+    );
+    return parseBool(value);
+  }
+
+  get proxyServer(): string[] | string | undefined {
+    const single = this.configService.get('WHATSAPP_PROXY_SERVER', undefined);
+    const multipleValues = this.configService.get(
+      'WHATSAPP_PROXY_SERVER_LIST',
+      undefined,
+    );
+    const multiple = multipleValues ? multipleValues.split(',') : undefined;
+    return single ? single : multiple;
+  }
+
+  get proxyServerIndexPrefix(): string | undefined {
+    return this.configService.get(
+      'WHATSAPP_PROXY_SERVER_INDEX_PREFIX',
+      undefined,
+    );
+  }
+
+  get proxyServerUsername(): string | undefined {
+    return this.configService.get('WHATSAPP_PROXY_SERVER_USERNAME', undefined);
+  }
+
+  get proxyServerPassword(): string | undefined {
+    return this.configService.get('WHATSAPP_PROXY_SERVER_PASSWORD', undefined);
+  }
+
+  getWebhookConfig(): WebhookConfig | undefined {
+    const url = this.getWebhookUrl();
+    const events = this.getWebhookEvents();
+    if (!url || events.length === 0) {
+      return undefined;
     }
+    return { url: url, events: events };
+  }
 
-    get hostname(): string {
-        return this.configService.get(
-            'WHATSAPP_API_HOSTNAME',
-            'localhost',
-        )
+  private getWebhookUrl(): string | undefined {
+    return this.get('WHATSAPP_HOOK_URL');
+  }
+
+  private getWebhookEvents(): string[] {
+    const value = this.get('WHATSAPP_HOOK_EVENTS', '');
+    return value ? value.split(',') : [];
+  }
+
+  getDefaultEngineName(): WAHAEngine {
+    const value = this.get('WHATSAPP_DEFAULT_ENGINE', WAHAEngine.WEBJS);
+    if (value in WAHAEngine) {
+      return WAHAEngine[value];
     }
+    console.log(
+      `Unknown WhatsApp default engine, using WEBJS. WHATSAPP_DEFAULT_ENGINE=${value}`,
+    );
+  }
 
-    get port(): string {
-        return this.configService.get(
-            'WHATSAPP_API_PORT',
-            '3000',
-        )
+  get(name: string, defaultValue = undefined): any {
+    return this.configService.get(name, defaultValue);
+  }
+
+  getApiKey(): string | undefined {
+    return this.configService.get('WHATSAPP_API_KEY', '');
+  }
+
+  getSwaggerUsernamePassword(): [string, string] | undefined {
+    const user = this.configService.get('WHATSAPP_SWAGGER_USERNAME', undefined);
+    const password = this.configService.get(
+      'WHATSAPP_SWAGGER_PASSWORD',
+      undefined,
+    );
+    if (!user && !password) {
+      console.log(
+        'Please set up both WHATSAPP_SWAGGER_USERNAME and WHATSAPP_SWAGGER_PASSWORD ' +
+          'to enable swagger authentication.',
+      );
+      return undefined;
     }
+    return [user, password];
+  }
 
-    get filesFolder(): string {
-        return this.configService.get(
-            'WHATSAPP_FILES_FOLDER',
-            '/tmp/whatsapp-files',
-        )
-    }
-
-    get filesLifetime(): number {
-        return this.configService.get<number>(
-            'WHATSAPP_FILES_LIFETIME',
-            180,
-        )
-    }
-
-    get mimetypes(): string[] | null {
-        const types = this.configService.get('WHATSAPP_FILES_MIMETYPES', "")
-        return types ? types.split(',') : null
-    }
-
-    get startSession(): string | undefined {
-        return this.configService.get('WHATSAPP_START_SESSION', undefined)
-    }
-
-    getWebhookUrl(): string | undefined {
-        return this.get('WHATSAPP_HOOK_URL')
-    }
-
-    getWebhookEvents(): string[] {
-        const value = this.get('WHATSAPP_HOOK_EVENTS', "")
-        return value ? value.split(',') : []
-    }
-
-    getDefaultEngineName(): WhatsappEngine {
-        const value = this.get("WHATSAPP_DEFAULT_ENGINE", WhatsappEngine.WEBJS)
-        if (value in WhatsappEngine) {
-            return WhatsappEngine[value]
-        }
-        console.log(`Unknown WhatsApp default engine, using WEBJS. WHATSAPP_DEFAULT_ENGINE=${value}`)
-
-    }
-
-    get(name: string, defaultValue = undefined): any {
-        return this.configService.get(name, defaultValue)
-    }
-
-    getApiKey(): string | undefined {
-        return this.configService.get("WHATSAPP_API_KEY", "")
-    }
+  getSwaggerAdvancedConfigEnabled(): boolean {
+    return this.configService.get('WHATSAPP_SWAGGER_CONFIG_ADVANCED', false);
+  }
 }

src/core/QR.ts

@@ -0,0 +1,11 @@
+export class QR {
+  private base64: string;
+
+  save(base64) {
+    this.base64 = base64.replace(/^data:image\/png;base64,/, '');
+  }
+
+  get(): Buffer {
+    return Buffer.from(this.base64, 'base64');
+  }
+}

src/core/abc/manager.abc.ts

@@ -1,28 +1,39 @@
-import {OnApplicationShutdown} from "@nestjs/common";
-import {SessionDTO, SessionStartRequest, SessionStopRequest} from "../../structures/sessions.dto";
-import {WhatsappSession} from "./session.abc";
-import {WhatsappEngine} from "../../structures/enums.dto";
-import {MediaStorage} from "./storage.abc";
-import {WebhookConductor} from "./webhooks.abc";
+import { OnApplicationShutdown } from '@nestjs/common';
+
+import { WAHAEngine } from '../../structures/enums.dto';
+import {
+  SessionDTO,
+  SessionLogoutRequest,
+  SessionStartRequest,
+  SessionStopRequest,
+} from '../../structures/sessions.dto';
+import { WhatsappSession } from './session.abc';
+import { LocalSessionStorage, MediaStorage } from './storage.abc';
+import { WebhookConductor } from './webhooks.abc';
 
 export abstract class SessionManager implements OnApplicationShutdown {
+  public sessionStorage: LocalSessionStorage;
 
-    abstract start(request: SessionStartRequest): SessionDTO
+  protected abstract getEngine(engine: WAHAEngine): typeof WhatsappSession;
 
-    abstract stop(request: SessionStopRequest): Promise<void>
+  protected abstract get EngineClass(): typeof WhatsappSession;
 
-    abstract getSession(name: string): WhatsappSession
+  protected abstract get WebhookConductorClass(): typeof WebhookConductor;
 
-    abstract getSessions(): SessionDTO[]
+  protected abstract get MediaStorageClass(): typeof MediaStorage;
 
-    abstract onApplicationShutdown(signal ?: string)
+  abstract onApplicationShutdown(signal?: string);
 
-    protected abstract getEngine(engine: WhatsappEngine): typeof WhatsappSession
+  //
+  // API Methods
+  //
+  abstract start(request: SessionStartRequest): Promise<SessionDTO>;
 
-    protected abstract get EngineClass(): typeof WhatsappSession
+  abstract stop(request: SessionStopRequest): Promise<void>;
 
-    protected abstract get WebhookConductorClass(): typeof WebhookConductor
+  abstract logout(request: SessionLogoutRequest): Promise<void>;
 
-    protected abstract get MediaStorageClass(): typeof MediaStorage
+  abstract getSession(name: string, error?: boolean): WhatsappSession;
+
+  abstract getSessions(all: boolean): Promise<SessionDTO[]>;
 }
-

src/core/abc/session.abc.ts

@@ -1,100 +1,298 @@
-import {WAEvents, WhatsappStatus} from "../../structures/enums.dto";
-import {ConsoleLogger} from "@nestjs/common";
+import { ConsoleLogger } from '@nestjs/common';
+import { EventEmitter } from 'events';
+import * as fs from 'fs';
+import { MessageId } from 'whatsapp-web.js';
+
 import {
-    ChatRequest,
-    CheckNumberStatusQuery,
-    MessageContactVcardRequest,
-    MessageFileRequest,
-    MessageImageRequest,
-    MessageLinkPreviewRequest,
-    MessageLocationRequest,
-    MessageReactionRequest,
-    MessageReplyRequest,
-    MessageTextButtonsRequest,
-    MessageTextRequest,
-    MessageVoiceRequest
-} from "../../structures/chatting.dto";
-import {MediaStorage} from "./storage.abc";
-import {MessageId} from "whatsapp-web.js";
+  ChatRequest,
+  CheckNumberStatusQuery,
+  GetMessageQuery,
+  MessageContactVcardRequest,
+  MessageFileRequest,
+  MessageImageRequest,
+  MessageLinkPreviewRequest,
+  MessageLocationRequest,
+  MessageReactionRequest,
+  MessageReplyRequest,
+  MessageTextButtonsRequest,
+  MessageTextRequest,
+  MessageVoiceRequest,
+} from '../../structures/chatting.dto';
+import { ContactQuery, ContactRequest } from '../../structures/contacts.dto';
+import {
+  WAHAEngine,
+  WAHAEvents,
+  WAHAPresenceStatus,
+  WAHASessionStatus,
+} from '../../structures/enums.dto';
+import {
+  CreateGroupRequest,
+  ParticipantsRequest,
+} from '../../structures/groups.dto';
+import { WAHAChatPresences } from '../../structures/presence.dto';
+import { ProxyConfig, SessionConfig } from '../../structures/sessions.dto';
+import { NotImplementedByEngineError } from '../exceptions';
+import { LocalSessionStorage, MediaStorage } from './storage.abc';
 
-export abstract class WhatsappSession {
-    public status: WhatsappStatus;
-
-    public constructor(public name: string, protected storage: MediaStorage, protected log: ConsoleLogger) {
-        this.name = name
-        this.status = WhatsappStatus.STARTING
-        this.log = log
-    }
-
-
-    /** Start the session */
-    abstract start()
-
-    /** Stop the session */
-    abstract stop(): void
-
-    /** Subscribe the handler to specific hook */
-    abstract subscribe(hook: WAEvents | string, handler: (message) => void)
-
-    /**
-     * START - Methods for API
-     */
-    abstract getScreenshot(): Promise<Buffer | string>
-
-    abstract checkNumberStatus(request: CheckNumberStatusQuery)
-
-    abstract sendText(request: MessageTextRequest)
-
-    abstract sendContactVCard(request: MessageContactVcardRequest)
-
-    abstract sendTextButtons(request: MessageTextButtonsRequest)
-
-    abstract sendLocation(request: MessageLocationRequest)
-
-    abstract sendLinkPreview(request: MessageLinkPreviewRequest)
-
-    abstract sendImage(request: MessageImageRequest)
-
-    abstract sendFile(request: MessageFileRequest)
-
-    abstract sendVoice(request: MessageVoiceRequest)
-
-    abstract reply(request: MessageReplyRequest)
-
-    abstract sendSeen(chat: ChatRequest)
-
-    abstract startTyping(chat: ChatRequest)
-
-    abstract stopTyping(chat: ChatRequest)
-
-    abstract setReaction(request: MessageReactionRequest)
-
-    /**
-     * END - Methods for API
-     */
-
-    /**
-     * Add WhatsApp suffix (@c.us) to the phone number if it doesn't have it yet
-     * @param phone
-     */
-    protected ensureSuffix(phone) {
-        const suffix = "@c.us"
-        if (phone.includes("@")) {
-            return phone
-        }
-        return phone + suffix
-    }
-
-    protected deserializeId(messageId: string): MessageId {
-        const parts = messageId.split("_")
-        return {
-            "fromMe": parts[0] === "true",
-            "remote": parts[1],
-            "id": parts[2],
-            "_serialized": messageId
-        }
-    }
+const CHROME_PATH = '/usr/bin/google-chrome-stable';
+const CHROMIUM_PATH = '/usr/bin/chromium';
 
+export function getBrowserExecutablePath() {
+  if (fs.existsSync(CHROME_PATH)) {
+    return CHROME_PATH;
+  }
+  return CHROMIUM_PATH;
+}
+export function ensureSuffix(phone) {
+  const suffix = '@c.us';
+  if (phone.includes('@')) {
+    return phone;
+  }
+  return phone + suffix;
 }
 
+export enum WAHAInternalEvent {
+  engine_start = 'engine.start',
+}
 
+export interface SessionParams {
+  name: string;
+  storage: MediaStorage;
+  log: ConsoleLogger;
+  sessionStorage: LocalSessionStorage;
+  proxyConfig?: ProxyConfig;
+  sessionConfig: SessionConfig;
+}
+
+export abstract class WhatsappSession {
+  public status: WAHASessionStatus;
+  public events: EventEmitter;
+  public engine: WAHAEngine;
+
+  public name: string;
+  protected storage: MediaStorage;
+  protected log: ConsoleLogger;
+  protected sessionStorage: LocalSessionStorage;
+  protected proxyConfig?: ProxyConfig;
+  public sessionConfig: SessionConfig;
+
+  public constructor({
+    name,
+    log,
+    sessionStorage,
+    proxyConfig,
+    storage,
+    sessionConfig,
+  }: SessionParams) {
+    this.name = name;
+    this.proxyConfig = proxyConfig;
+    this.status = WAHASessionStatus.STARTING;
+    this.log = log;
+    this.sessionStorage = sessionStorage;
+    this.events = new EventEmitter();
+    this.storage = storage;
+    this.sessionConfig = sessionConfig;
+  }
+
+  getBrowserExecutablePath() {
+    return getBrowserExecutablePath();
+  }
+
+  getBrowserArgsForPuppeteer() {
+    // Run optimized version of Chrome
+    // References:
+    // https://github.com/pedroslopez/whatsapp-web.js/issues/1420
+    // https://www.bannerbear.com/blog/ways-to-speed-up-puppeteer-screenshots/
+    return [
+      '--no-sandbox',
+      '--disable-client-side-phishing-detection',
+      '--disable-setuid-sandbox',
+      '--disable-component-update',
+      '--disable-default-apps',
+      '--disable-popup-blocking',
+      '--disable-offer-store-unmasked-wallet-cards',
+      '--disable-speech-api',
+      '--hide-scrollbars',
+      '--mute-audio',
+      '--disable-extensions',
+      '--disable-dev-shm-usage',
+      '--disable-accelerated-2d-canvas',
+      '--no-first-run',
+      '--no-default-browser-check',
+      '--no-pings',
+      '--password-store=basic',
+      '--use-mock-keychain',
+      '--no-zygote',
+      '--single-process',
+      '--disable-gpu',
+    ];
+  }
+
+  /** Start the session */
+  abstract start();
+
+  /** Stop the session */
+  abstract stop(): void;
+
+  /** Subscribe the handler to specific hook */
+  abstract subscribe(hook: WAHAEvents | string, handler: (message) => void);
+
+  /**
+   * START - Methods for API
+   */
+  abstract getScreenshot(): Promise<Buffer | string>;
+
+  abstract checkNumberStatus(request: CheckNumberStatusQuery);
+
+  abstract sendText(request: MessageTextRequest);
+
+  abstract sendContactVCard(request: MessageContactVcardRequest);
+
+  abstract sendTextButtons(request: MessageTextButtonsRequest);
+
+  abstract sendLocation(request: MessageLocationRequest);
+
+  abstract sendLinkPreview(request: MessageLinkPreviewRequest);
+
+  abstract sendImage(request: MessageImageRequest);
+
+  abstract sendFile(request: MessageFileRequest);
+
+  abstract sendVoice(request: MessageVoiceRequest);
+
+  abstract reply(request: MessageReplyRequest);
+
+  abstract sendSeen(chat: ChatRequest);
+
+  abstract startTyping(chat: ChatRequest);
+
+  abstract stopTyping(chat: ChatRequest);
+
+  abstract getMessages(query: GetMessageQuery);
+
+  abstract setReaction(request: MessageReactionRequest);
+
+  /**
+   * Contacts methods
+   */
+  public getContact(query: ContactQuery) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public getContacts() {
+    throw new NotImplementedByEngineError();
+  }
+
+  public getContactAbout(query: ContactQuery) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public getContactProfilePicture(query: ContactQuery) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public blockContact(request: ContactRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public unblockContact(request: ContactRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  /**
+   * Group methods
+   */
+  public createGroup(request: CreateGroupRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public getGroups() {
+    throw new NotImplementedByEngineError();
+  }
+
+  public getGroup(id) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public deleteGroup(id) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public leaveGroup(id) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public setDescription(id, description) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public setSubject(id, description) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public getInviteCode(id): Promise<string> {
+    throw new NotImplementedByEngineError();
+  }
+
+  public revokeInviteCode(id): Promise<string> {
+    throw new NotImplementedByEngineError();
+  }
+
+  public getParticipants(id) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public addParticipants(id, request: ParticipantsRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public removeParticipants(id, request: ParticipantsRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public promoteParticipantsToAdmin(id, request: ParticipantsRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public demoteParticipantsToUser(id, request: ParticipantsRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public setPresence(presence: WAHAPresenceStatus, chatId?: string) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public getPresences(): Promise<WAHAChatPresences[]> {
+    throw new NotImplementedByEngineError();
+  }
+
+  public getPresence(id: string): Promise<WAHAChatPresences> {
+    throw new NotImplementedByEngineError();
+  }
+
+  public subscribePresence(id: string): Promise<void> {
+    throw new NotImplementedByEngineError();
+  }
+
+  /**
+   * END - Methods for API
+   */
+
+  /**
+   * Add WhatsApp suffix (@c.us) to the phone number if it doesn't have it yet
+   * @param phone
+   */
+  protected ensureSuffix(phone) {
+    return ensureSuffix(phone);
+  }
+
+  protected deserializeId(messageId: string): MessageId {
+    const parts = messageId.split('_');
+    return {
+      fromMe: parts[0] === 'true',
+      remote: parts[1],
+      id: parts[2],
+      _serialized: messageId,
+    };
+  }
+}

src/core/abc/storage.abc.ts

@@ -1,3 +1,40 @@
-export abstract class MediaStorage {
-    abstract save(messageId: string, mimetype: string, buffer: Buffer): Promise<string>
+import { SessionConfig } from '../../structures/sessions.dto';
+
+abstract class MediaStorage {
+  abstract save(
+    messageId: string,
+    mimetype: string,
+    buffer: Buffer,
+  ): Promise<string>;
 }
+
+abstract class SessionConfigRepository {
+  abstract save(sessionName: string, config: SessionConfig): Promise<void>;
+
+  abstract get(sessionName: string): Promise<SessionConfig>;
+}
+
+abstract class SessionStorage {
+  protected constructor(public engine: string) {
+    this.engine = engine;
+  }
+
+  abstract init(): Promise<void>;
+
+  abstract clean(sessionName: string): Promise<void>;
+
+  abstract getAll(): Promise<string[]>;
+
+  //
+  // Repositories
+  //
+  abstract get configRepository(): SessionConfigRepository;
+}
+
+abstract class LocalSessionStorage extends SessionStorage {
+  public sessionsFolder: string;
+
+  abstract getFolderPath(sessionName: string): string;
+}
+
+export { LocalSessionStorage, MediaStorage, SessionConfigRepository };

src/core/abc/webhooks.abc.ts

@@ -1,5 +1,20 @@
-import {WhatsappSession} from "./session.abc";
+import { ConsoleLogger } from '@nestjs/common';
+
+import { WebhookConfig } from '../../structures/webhooks.dto';
+import { WhatsappSession } from './session.abc';
+
+export abstract class WebhookSender {
+  protected url: string;
+  constructor(
+    protected log: ConsoleLogger,
+    protected webhookConfig: WebhookConfig,
+  ) {
+    this.url = webhookConfig.url;
+  }
+
+  abstract send(json);
+}
 
 export abstract class WebhookConductor {
-    abstract configure(session: WhatsappSession)
+  abstract configure(session: WhatsappSession, webhooks: WebhookConfig[]);
 }

src/core/app.module.core.ts

@@ -1,53 +1,59 @@
-import {ConsoleLogger, Module} from '@nestjs/common';
-import {ScreenshotController} from "../api/screenshot.controller";
-import {ConfigModule} from "@nestjs/config";
-import {WhatsappConfigService} from "../config.service";
-import {ServeStaticModule} from "@nestjs/serve-static";
-import {SessionsController} from "../api/sessions.controller";
-import {ChattingController} from "../api/chatting.controller";
-import {VersionController} from "../api/version.controller";
-import {PassportModule} from "@nestjs/passport";
-import {SessionManager} from "./abc/manager.abc";
-import {SessionManagerCore} from "./manager.core";
+import { ConsoleLogger, Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { PassportModule } from '@nestjs/passport';
+import { ServeStaticModule } from '@nestjs/serve-static';
+
+import { ChattingController } from '../api/chatting.controller';
+import { ContactsController } from '../api/contacts.controller';
+import { GroupsController } from '../api/groups.controller';
+import { PresenceController } from '../api/presence.controller';
+import { ScreenshotController } from '../api/screenshot.controller';
+import { SessionsController } from '../api/sessions.controller';
+import { VersionController } from '../api/version.controller';
+import { WhatsappConfigService } from '../config.service';
+import { SessionManager } from './abc/manager.abc';
+import { SessionManagerCore } from './manager.core';
 
 export const IMPORTS = [
-    ConfigModule.forRoot({
-        isGlobal: true,
-    }),
-    ServeStaticModule.forRootAsync({
-        imports: [],
-        extraProviders: [WhatsappConfigService],
-        inject: [WhatsappConfigService],
-        useFactory: (config: WhatsappConfigService) => {
-            return [{
-                rootPath: config.filesFolder,
-                serveRoot: config.files_uri,
-            }]
+  ConfigModule.forRoot({
+    isGlobal: true,
+  }),
+  ServeStaticModule.forRootAsync({
+    imports: [],
+    extraProviders: [WhatsappConfigService],
+    inject: [WhatsappConfigService],
+    useFactory: (config: WhatsappConfigService) => {
+      return [
+        {
+          rootPath: config.filesFolder,
+          serveRoot: config.files_uri,
         },
-    }),
-    PassportModule,
-]
-export const CONTROLLERS = [
-    SessionsController,
-    ChattingController,
-    ScreenshotController,
-    VersionController,
-]
-const PROVIDERS = [
-    {
-        provide: SessionManager,
-        useClass: SessionManagerCore,
+      ];
     },
-    WhatsappConfigService,
-    ConsoleLogger,
-]
-
+  }),
+  PassportModule,
+];
+export const CONTROLLERS = [
+  SessionsController,
+  ChattingController,
+  ContactsController,
+  GroupsController,
+  PresenceController,
+  ScreenshotController,
+  VersionController,
+];
+const PROVIDERS = [
+  {
+    provide: SessionManager,
+    useClass: SessionManagerCore,
+  },
+  WhatsappConfigService,
+  ConsoleLogger,
+];
 
 @Module({
-    imports: IMPORTS,
-    controllers: CONTROLLERS,
-    providers: PROVIDERS,
+  imports: IMPORTS,
+  controllers: CONTROLLERS,
+  providers: PROVIDERS,
 })
-export class AppModuleCore {
-
-}
+export class AppModuleCore {}

src/core/exceptions.ts

@@ -1,20 +1,21 @@
-import {UnprocessableEntityException} from "@nestjs/common";
+import { UnprocessableEntityException } from '@nestjs/common';
 
-export const DOCS_URL = "https://waha.devlike.pro/"
+export const DOCS_URL = 'https://waha.devlike.pro/';
 
 export class NotImplementedByEngineError extends UnprocessableEntityException {
-    constructor(msg = "") {
-        let error = "The method is not implemented by the engine."
-        if (msg) {
-            error += ` ${msg}`
-        }
-        super(error);
+  constructor(msg = '') {
+    let error = 'The method is not implemented by the engine.';
+    if (msg) {
+      error += ` ${msg}`;
     }
+    super(error);
+  }
 }
 
-
 export class AvailableInPlusVersion extends UnprocessableEntityException {
-    constructor() {
-        super(`The feature is available only in Plus version. Check this out: ${DOCS_URL}`);
-    }
+  constructor() {
+    super(
+      `The feature is available only in Plus version. Check this out: ${DOCS_URL}`,
+    );
+  }
 }

src/core/helpers.proxy.ts

@@ -0,0 +1,73 @@
+import { Agent } from 'https';
+import { HttpsProxyAgent } from 'https-proxy-agent';
+import { URL } from 'url';
+
+import { WhatsappConfigService } from '../config.service';
+import { ProxyConfig } from '../structures/sessions.dto';
+import { WhatsappSession } from './abc/session.abc';
+
+export function getProxyConfig(
+  config: WhatsappConfigService,
+  sessions: Record<string, WhatsappSession>,
+  sessionName?: string,
+): ProxyConfig | undefined {
+  // Single proxy server configuration
+  if (typeof config.proxyServer === 'string') {
+    return {
+      server: config.proxyServer,
+      username: config.proxyServerUsername,
+      password: config.proxyServerPassword,
+    };
+  }
+
+  // Multiple proxy server configuration
+  if (Array.isArray(config.proxyServer)) {
+    const prefix = config.proxyServerIndexPrefix;
+    let indexToUse: number = undefined;
+    if (prefix && sessionName.includes(prefix)) {
+      // match numbers at the end of the string
+      const matches = sessionName.match(/\d+$/);
+      indexToUse = matches ? parseInt(matches[0], 10) : undefined;
+    }
+    let idx = 0;
+    idx = Object.keys(sessions).length % config.proxyServer.length;
+    const index = indexToUse ? indexToUse % config.proxyServer.length : idx;
+    return {
+      server: config.proxyServer[index],
+      username: config.proxyServerUsername,
+      password: config.proxyServerPassword,
+    };
+  }
+
+  // No proxy server configuration
+  return undefined;
+}
+
+function getAuthenticatedUrl(
+  url: string,
+  username: string,
+  password: string,
+): string {
+  const hasSchema = url.startsWith('http://') || url.startsWith('https://');
+  if (!hasSchema) {
+    url = `http://${url}`;
+  }
+  const parsedUrl = new URL(url);
+  parsedUrl.protocol = parsedUrl.protocol || 'http';
+  parsedUrl.username = username;
+  parsedUrl.password = password;
+  return parsedUrl.toString();
+}
+
+/**
+ * Return https Agent proxy for the config
+ * @param proxyConfig
+ */
+export function createAgentProxy(proxyConfig: ProxyConfig): Agent | undefined {
+  const url = getAuthenticatedUrl(
+    proxyConfig.server,
+    proxyConfig.username,
+    proxyConfig.password,
+  );
+  return new HttpsProxyAgent(url);
+}

src/core/manager.core.ts

@@ -1,116 +1,217 @@
-import {ConsoleLogger, Injectable, NotFoundException, UnprocessableEntityException} from "@nestjs/common";
-import {SessionManager} from "./abc/manager.abc";
-import {WhatsappSession} from "./abc/session.abc";
-import {WhatsappEngine} from "../structures/enums.dto";
-import {SessionDTO, SessionStartRequest, SessionStopRequest} from "../structures/sessions.dto";
-import {WhatsappConfigService} from "../config.service";
-import {WhatsappSessionVenomCore} from "./session.venom.core";
-import {WhatsappSessionWebJSCore} from "./session.webjs.core";
-import {DOCS_URL} from "./exceptions";
-import {WebhookConductorCore} from "./webhooks.core";
-import {MediaStorageCore} from "./storage.core";
+import {
+  ConsoleLogger,
+  Injectable,
+  NotFoundException,
+  UnprocessableEntityException,
+} from '@nestjs/common';
+
+import { WhatsappConfigService } from '../config.service';
+import { WAHAEngine, WAHASessionStatus } from '../structures/enums.dto';
+import {
+  ProxyConfig,
+  SessionDTO,
+  SessionLogoutRequest,
+  SessionStartRequest,
+  SessionStopRequest,
+} from '../structures/sessions.dto';
+import { WebhookConfig } from '../structures/webhooks.dto';
+import { SessionManager } from './abc/manager.abc';
+import {
+  SessionParams,
+  WAHAInternalEvent,
+  WhatsappSession,
+} from './abc/session.abc';
+import { DOCS_URL } from './exceptions';
+import { getProxyConfig } from './helpers.proxy';
+import { WhatsappSessionNoWebCore } from './session.noweb.core';
+import { WhatsappSessionVenomCore } from './session.venom.core';
+import { WhatsappSessionWebJSCore } from './session.webjs.core';
+import { MediaStorageCore, SessionStorageCore } from './storage.core';
+import { WebhookConductorCore } from './webhooks.core';
 
 export class OnlyDefaultSessionIsAllowed extends UnprocessableEntityException {
-    constructor() {
-        super(`WAHA Core support only 'default' session. If you want to run more then one WhatsApp account - please get WAHA PLUS version. Check this out: ${DOCS_URL}`);
-    }
+  constructor() {
+    super(
+      `WAHA Core support only 'default' session. If you want to run more then one WhatsApp account - please get WAHA PLUS version. Check this out: ${DOCS_URL}`,
+    );
+  }
 }
 
 @Injectable()
 export class SessionManagerCore extends SessionManager {
-    private session: WhatsappSession;
-    DEFAULT = "default"
+  private session: WhatsappSession;
+  DEFAULT = 'default';
 
+  // @ts-ignore
+  protected MediaStorageClass = MediaStorageCore;
+  // @ts-ignore
+  protected WebhookConductorClass = WebhookConductorCore;
+  protected readonly EngineClass: typeof WhatsappSession;
+
+  constructor(
+    private config: WhatsappConfigService,
+    private log: ConsoleLogger,
+  ) {
+    super();
+
+    this.log.setContext('SessionManager');
+    this.session = undefined;
+    const engineName = this.config.getDefaultEngineName();
+    this.EngineClass = this.getEngine(engineName);
+    this.sessionStorage = new SessionStorageCore(engineName.toLowerCase());
+
+    this.startPredefinedSessions();
+  }
+
+  protected startPredefinedSessions() {
+    const startSessions = this.config.startSessions;
+    startSessions.forEach((sessionName) => {
+      this.start({ name: sessionName });
+    });
+  }
+
+  protected getEngine(engine: WAHAEngine): typeof WhatsappSession {
+    if (engine === WAHAEngine.WEBJS) {
+      return WhatsappSessionWebJSCore;
+    } else if (engine === WAHAEngine.VENOM) {
+      return WhatsappSessionVenomCore;
+    } else if (engine === WAHAEngine.NOWEB) {
+      return WhatsappSessionNoWebCore;
+    } else {
+      throw new NotFoundException(`Unknown whatsapp engine '${engine}'.`);
+    }
+  }
+
+  private onlyDefault(name: string) {
+    if (name !== this.DEFAULT) {
+      throw new OnlyDefaultSessionIsAllowed();
+    }
+  }
+
+  async onApplicationShutdown(signal?: string) {
+    if (!this.session) {
+      return;
+    }
+    await this.stop({ name: this.DEFAULT, logout: false });
+  }
+
+  //
+  // API Methods
+  //
+  async start(request: SessionStartRequest): Promise<SessionDTO> {
+    this.onlyDefault(request.name);
+
+    const name = request.name;
+    this.log.log(`'${name}' - starting session...`);
+    const log = new ConsoleLogger(`WhatsappSession - ${name}`);
+    const storage = new this.MediaStorageClass();
+    const webhookLog = new ConsoleLogger(`Webhook - ${name}`);
+    const webhook = new this.WebhookConductorClass(webhookLog);
+
+    await this.sessionStorage.init();
+
+    const proxyConfig = this.getProxyConfig(request);
+    const sessionConfig: SessionParams = {
+      name,
+      storage,
+      log,
+      sessionStorage: this.sessionStorage,
+      proxyConfig: proxyConfig,
+      sessionConfig: request.config,
+    };
     // @ts-ignore
-    protected MediaStorageClass = MediaStorageCore
-    // @ts-ignore
-    protected WebhookConductorClass = WebhookConductorCore
-    protected readonly EngineClass: typeof WhatsappSession;
+    const session = new this.EngineClass(sessionConfig);
+    this.session = session;
 
+    // configure webhooks
+    const webhooks = this.getWebhooks(request);
+    session.events.on(WAHAInternalEvent.engine_start, () =>
+      webhook.configure(session, webhooks),
+    );
 
-    constructor(
-        private config: WhatsappConfigService,
-        private log: ConsoleLogger,
-    ) {
-        super()
+    // start session
+    await session.start();
+    return {
+      name: session.name,
+      status: session.status,
+      config: session.sessionConfig,
+    };
+  }
 
-        this.log.setContext('SessionManager')
-        this.session = undefined
-        this.EngineClass = this.getEngine(this.config.getDefaultEngineName())
-
-        // Start session from the start
-        if (config.startSession) {
-            this.start({name: config.startSession})
-        }
+  /**
+   * Combine per session and global webhooks
+   */
+  private getWebhooks(request: SessionStartRequest) {
+    let webhooks: WebhookConfig[] = [];
+    if (request.config?.webhooks) {
+      webhooks = webhooks.concat(request.config.webhooks);
     }
+    const globalWebhookConfig = this.config.getWebhookConfig();
+    webhooks.push(globalWebhookConfig);
+    return webhooks;
+  }
 
-    protected getEngine(engine: WhatsappEngine): typeof WhatsappSession {
-        if (engine === WhatsappEngine.WEBJS) {
-            return WhatsappSessionWebJSCore
-        } else if (engine === WhatsappEngine.VENOM) {
-            return WhatsappSessionVenomCore
-        } else {
-            throw new NotFoundException(`Unknown whatsapp engine '${engine}'.`)
-        }
-
+  /**
+   * Get either session's or global proxy if defined
+   */
+  protected getProxyConfig(
+    request: SessionStartRequest,
+  ): ProxyConfig | undefined {
+    if (request.config?.proxy) {
+      return request.config.proxy;
     }
+    const sessions = { [request.name]: this.session };
+    return getProxyConfig(this.config, sessions, request.name);
+  }
 
-    private onlyDefault(name: string) {
-        if (name !== this.DEFAULT) {
-            throw new OnlyDefaultSessionIsAllowed()
-        }
+  async stop(request: SessionStopRequest): Promise<void> {
+    this.onlyDefault(request.name);
+
+    const name = request.name;
+    this.log.log(`Stopping ${name} session...`);
+    const session = this.getSession(name);
+    await session.stop();
+    this.log.log(`"${name}" has been stopped.`);
+    this.session = undefined;
+  }
+
+  async logout(request: SessionLogoutRequest) {
+    await this.sessionStorage.clean(request.name);
+  }
+
+  getSession(name: string, error = true): WhatsappSession {
+    this.onlyDefault(name);
+    const session = this.session;
+    if (!session) {
+      if (error) {
+        throw new NotFoundException(
+          `We didn't find a session with name '${name}'. Please start it first by using POST /sessions/start request`,
+        );
+      }
+      return;
     }
+    return session;
+  }
 
-    getSession(name: string): WhatsappSession {
-        this.onlyDefault(name)
-        if (!this.session) {
-            throw new NotFoundException(
-                `We didn't find a session with name '${name}'. Please start it first by using POST /sessions/start request`,
-            );
-        }
-        return this.session
-    }
-
-    getSessions(): SessionDTO[] {
+  async getSessions(all: boolean): Promise<SessionDTO[]> {
+    if (!this.session) {
+      if (!all) {
         return [];
+      }
+      return [
+        {
+          name: this.DEFAULT,
+          status: WAHASessionStatus.STOPPED,
+          config: undefined,
+        },
+      ];
     }
-
-    async onApplicationShutdown(signal?: string) {
-        if (!this.session){
-            return
-        }
-        await this.stop({name: this.DEFAULT})
-    }
-
-    start(request: SessionStartRequest): SessionDTO {
-        this.onlyDefault(request.name)
-
-        const name = request.name
-        this.log.log(`'${name}' - starting session...`)
-        const log = new ConsoleLogger(`WhatsappSession - ${name}`)
-        const storage = new this.MediaStorageClass()
-        const webhookLog = new ConsoleLogger(`Webhook - ${name}`)
-        const webhook = new this.WebhookConductorClass(
-            webhookLog,
-            this.config.getWebhookUrl(),
-            this.config.getWebhookEvents()
-        )
-
-        // @ts-ignore
-        const session = new this.EngineClass(name, storage, log)
-        this.session = session
-
-        session.start().then(() => webhook.configure(session))
-        return {name: session.name, status: session.status}
-    }
-
-    async stop(request: SessionStopRequest): Promise<void> {
-        const name = request.name
-        this.log.log(`Stopping ${name} session...`)
-        const session = this.getSession(name)
-        await session.stop()
-        this.log.log(`"${name}" has been stopped.`)
-        this.session = undefined
-    }
-
+    return [
+      {
+        name: this.session.name,
+        status: this.session.status,
+        config: this.session.sessionConfig,
+      },
+    ];
+  }
 }

src/core/session.noweb.core.ts

@@ -0,0 +1,628 @@
+import makeWASocket, {
+  DisconnectReason,
+  isJidGroup,
+  makeInMemoryStore,
+  PresenceData,
+  useMultiFileAuthState,
+} from '@adiwajshing/baileys';
+import { WABrowserDescription } from '@adiwajshing/baileys';
+import { UnprocessableEntityException } from '@nestjs/common';
+import * as fs from 'fs/promises';
+import { Agent } from 'https';
+import * as lodash from 'lodash';
+import { Message } from 'whatsapp-web.js';
+
+import { flipObject } from '../helpers';
+import {
+  Button,
+  ChatRequest,
+  CheckNumberStatusQuery,
+  GetMessageQuery,
+  MessageContactVcardRequest,
+  MessageFileRequest,
+  MessageImageRequest,
+  MessageLinkPreviewRequest,
+  MessageLocationRequest,
+  MessageReactionRequest,
+  MessageReplyRequest,
+  MessageTextButtonsRequest,
+  MessageTextRequest,
+  MessageVoiceRequest,
+  SendSeenRequest,
+} from '../structures/chatting.dto';
+import { ContactQuery, ContactRequest } from '../structures/contacts.dto';
+import {
+  SECOND,
+  WAHAEngine,
+  WAHAEvents,
+  WAHAPresenceStatus,
+  WAHASessionStatus,
+} from '../structures/enums.dto';
+import {
+  CreateGroupRequest,
+  ParticipantsRequest,
+} from '../structures/groups.dto';
+import {
+  WAHAChatPresences,
+  WAHAPresenceData,
+} from '../structures/presence.dto';
+import { WAMessage, WANumberExistResult } from '../structures/responses.dto';
+import {
+  ensureSuffix,
+  WAHAInternalEvent,
+  WhatsappSession,
+} from './abc/session.abc';
+import {
+  AvailableInPlusVersion,
+  NotImplementedByEngineError,
+} from './exceptions';
+import { createAgentProxy } from './helpers.proxy';
+import { QR } from './QR';
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const QRCode = require('qrcode');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const logger = require('pino')();
+
+export const BaileysEvents = {
+  CONNECTION_UPDATE: 'connection.update',
+  CREDS_UPDATE: 'creds.update',
+  MESSAGES_UPSERT: 'messages.upsert',
+  GROUPS_UPSERT: 'groups.upsert',
+  PRESENCE_UPDATE: 'presence.update',
+};
+
+const PresenceStatuses = {
+  unavailable: WAHAPresenceStatus.OFFLINE,
+  available: WAHAPresenceStatus.ONLINE,
+  composing: WAHAPresenceStatus.TYPING,
+  recording: WAHAPresenceStatus.RECORDING,
+  paused: WAHAPresenceStatus.PAUSED,
+};
+const ToEnginePresenceStatus = flipObject(PresenceStatuses);
+
+export class WhatsappSessionNoWebCore extends WhatsappSession {
+  engine = WAHAEngine.NOWEB;
+
+  sock: any;
+  store: any;
+  private qr: QR;
+
+  public constructor(config) {
+    super(config);
+    this.qr = new QR();
+  }
+
+  start() {
+    return this.buildClient();
+  }
+
+  getSocketConfig(agent, state) {
+    return {
+      agent: agent,
+      fetchAgent: agent,
+      auth: state,
+      printQRInTerminal: true,
+      browser: ['Linux', 'Chrome', '111.0.5563.64'] as WABrowserDescription,
+      logger: logger,
+      mobile: false,
+    };
+  }
+
+  async makeSocket() {
+    const authFolder = this.sessionStorage.getFolderPath(this.name);
+    await fs.mkdir(authFolder, { recursive: true });
+    const { state, saveCreds } = await useMultiFileAuthState(authFolder);
+    const agent = this.makeAgent();
+    const socketConfig = this.getSocketConfig(agent, state);
+    const sock: any = makeWASocket(socketConfig);
+    sock.ev.on(BaileysEvents.CREDS_UPDATE, saveCreds);
+    return sock;
+  }
+
+  protected makeAgent(): Agent {
+    if (!this.proxyConfig) {
+      return undefined;
+    }
+    return createAgentProxy(this.proxyConfig);
+  }
+
+  connectStore() {
+    if (!this.store) {
+      this.store = makeInMemoryStore({});
+    }
+    this.store.bind(this.sock.ev);
+  }
+
+  resubscribeToKnownPresences() {
+    for (const jid in this.store.presences) {
+      this.sock.presenceSubscribe(jid);
+    }
+  }
+
+  async buildClient() {
+    this.sock = await this.makeSocket();
+    this.connectStore();
+    this.sock.ev.on(BaileysEvents.CONNECTION_UPDATE, async (update) => {
+      const { connection, lastDisconnect, qr } = update;
+      if (connection === 'connecting') {
+        this.qr.save('');
+        this.status = WAHASessionStatus.WORKING;
+        this.resubscribeToKnownPresences();
+        return;
+      } else if (connection === 'close') {
+        const shouldReconnect =
+          lastDisconnect.error?.output?.statusCode !==
+          DisconnectReason.loggedOut;
+        this.log.error(
+          'connection closed due to ',
+          lastDisconnect.error,
+          ', reconnecting ',
+          shouldReconnect,
+        );
+        this.qr.save('');
+        this.status = WAHASessionStatus.FAILED;
+        // reconnect if not logged out
+        if (shouldReconnect) {
+          setTimeout(() => this.buildClient(), 2 * SECOND);
+        }
+      }
+
+      // Save QR
+      if (qr) {
+        this.status = WAHASessionStatus.SCAN_QR_CODE;
+        QRCode.toDataURL(qr).then((url) => {
+          this.qr.save(url);
+        });
+      }
+    });
+    this.events.emit(WAHAInternalEvent.engine_start);
+  }
+
+  stop() {
+    this.sock.ev.removeAllListeners();
+    this.sock.ws.removeAllListeners();
+    this.sock.ws.close();
+    return;
+  }
+
+  /**
+   * START - Methods for API
+   */
+  async getScreenshot(): Promise<Buffer | string> {
+    if (this.status === WAHASessionStatus.STARTING) {
+      throw new UnprocessableEntityException(
+        `The session is starting, please try again after few seconds`,
+      );
+    } else if (this.status === WAHASessionStatus.SCAN_QR_CODE) {
+      return Promise.resolve(this.qr.get());
+    } else if (this.status === WAHASessionStatus.WORKING) {
+      throw new UnprocessableEntityException(
+        `Can not get screenshot for non chrome based engine.`,
+      );
+    } else {
+      throw new UnprocessableEntityException(`Unknown status - ${this.status}`);
+    }
+  }
+
+  async checkNumberStatus(
+    request: CheckNumberStatusQuery,
+  ): Promise<WANumberExistResult> {
+    const phone = request.phone.split('@')[0];
+    const [result] = await this.sock.onWhatsApp(phone);
+    if (!result) {
+      return { numberExists: false };
+    }
+    return { numberExists: result.exists };
+  }
+
+  sendText(request: MessageTextRequest) {
+    const chatId = this.ensureSuffix(request.chatId);
+    const message = {
+      text: request.text,
+      mentions: request.mentions?.map(toJID),
+    };
+    return this.sock.sendMessage(chatId, message);
+  }
+
+  sendTextButtons(request: MessageTextButtonsRequest) {
+    const buttons = request.buttons.map((button: Button) => {
+      return {
+        buttonId: button.id,
+        buttonText: { displayText: button.text },
+        type: 1,
+      };
+    });
+
+    const buttonMessage = {
+      text: request.title,
+      buttons: buttons,
+      headerType: 1,
+    };
+
+    return this.sock.sendMessage(request.chatId, buttonMessage);
+  }
+
+  sendContactVCard(request: MessageContactVcardRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  async reply(request: MessageReplyRequest) {
+    const { id } = parseMessageId(request.reply_to);
+    const quotedMessage = await this.store.loadMessage(
+      toJID(request.chatId),
+      id,
+    );
+    const message = {
+      text: request.text,
+      mentions: request.mentions?.map(toJID),
+    };
+    return await this.sock.sendMessage(request.chatId, message, {
+      quoted: quotedMessage,
+    });
+  }
+
+  sendImage(request: MessageImageRequest) {
+    throw new AvailableInPlusVersion();
+  }
+
+  sendFile(request: MessageFileRequest) {
+    throw new AvailableInPlusVersion();
+  }
+
+  sendVoice(request: MessageVoiceRequest) {
+    throw new AvailableInPlusVersion();
+  }
+
+  sendLocation(request: MessageLocationRequest) {
+    return this.sock.sendMessage(request.chatId, {
+      location: {
+        degreesLatitude: request.latitude,
+        degreesLongitude: request.longitude,
+      },
+    });
+  }
+
+  sendLinkPreview(request: MessageLinkPreviewRequest) {
+    const text = `${request.title}\n${request.url}`;
+    const chatId = this.ensureSuffix(request.chatId);
+    return this.sock.sendMessage(chatId, { text: text });
+  }
+
+  async sendSeen(request: SendSeenRequest) {
+    const key = parseMessageId(request.messageId);
+    const data = {
+      remoteJid: key.remoteJid,
+      id: key.id,
+      participant: request.participant,
+    };
+    return this.sock.readMessages([data]);
+  }
+
+  async startTyping(request: ChatRequest) {
+    return this.sock.sendPresenceUpdate('composing', request.chatId);
+  }
+
+  async stopTyping(request: ChatRequest) {
+    return this.sock.sendPresenceUpdate('paused', request.chatId);
+  }
+
+  async getMessages(query: GetMessageQuery) {
+    throw new NotImplementedByEngineError();
+  }
+
+  async setReaction(request: MessageReactionRequest) {
+    const key = parseMessageId(request.messageId);
+    const reactionMessage = {
+      react: {
+        text: request.reaction,
+        key: key,
+      },
+    };
+    return this.sock.sendMessage(key.remoteJid, reactionMessage);
+  }
+
+  /**
+   * Contacts methods
+   */
+  getContact(query: ContactQuery) {
+    throw new NotImplementedByEngineError();
+  }
+
+  getContacts() {
+    throw new NotImplementedByEngineError();
+  }
+
+  public async getContactAbout(query: ContactQuery) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public async getContactProfilePicture(query: ContactQuery) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public async blockContact(request: ContactRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public async unblockContact(request: ContactRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  /**
+   * Group methods
+   */
+  public createGroup(request: CreateGroupRequest) {
+    const participants = request.participants.map(getId);
+    return this.sock.groupCreate(request.name, participants);
+  }
+
+  public async getGroups() {
+    return await this.sock.groupFetchAllParticipating();
+  }
+
+  public async getGroup(id) {
+    const groups = await this.sock.groupFetchAllParticipating();
+    return groups[id];
+  }
+
+  public async deleteGroup(id) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public async leaveGroup(id) {
+    return this.sock.groupLeave(id);
+  }
+
+  public async setDescription(id, description) {
+    return this.sock.groupUpdateDescription(id, description);
+  }
+
+  public async setSubject(id, subject) {
+    return this.sock.groupUpdateSubject(id, subject);
+  }
+
+  public async getInviteCode(id): Promise<string> {
+    return this.sock.groupInviteCode(id);
+  }
+
+  public async revokeInviteCode(id): Promise<string> {
+    await this.sock.groupRevokeInvite(id);
+    return this.sock.groupInviteCode(id);
+  }
+
+  public async getParticipants(id) {
+    const groups = await this.sock.groupFetchAllParticipating();
+    return groups[id].participants;
+  }
+
+  public async addParticipants(id, request: ParticipantsRequest) {
+    const participants = request.participants.map(getId);
+    return this.sock.groupParticipantsUpdate(id, participants, 'add');
+  }
+
+  public async removeParticipants(id, request: ParticipantsRequest) {
+    const participants = request.participants.map(getId);
+    return this.sock.groupParticipantsUpdate(id, participants, 'remove');
+  }
+
+  public async promoteParticipantsToAdmin(id, request: ParticipantsRequest) {
+    const participants = request.participants.map(getId);
+    return this.sock.groupParticipantsUpdate(id, participants, 'promote');
+  }
+
+  public async demoteParticipantsToUser(id, request: ParticipantsRequest) {
+    const participants = request.participants.map(getId);
+    return this.sock.groupParticipantsUpdate(id, participants, 'demote');
+  }
+
+  public async setPresence(presence: WAHAPresenceStatus, chatId?: string) {
+    const enginePresence = ToEnginePresenceStatus[presence];
+    if (!enginePresence) {
+      throw new NotImplementedByEngineError(
+        `NOWEB engine doesn't support '${presence}' presence.`,
+      );
+    }
+    await this.sock.sendPresenceUpdate(enginePresence, chatId);
+  }
+
+  public async getPresences(): Promise<WAHAChatPresences[]> {
+    const result: WAHAChatPresences[] = [];
+    for (const remoteJid in this.store.presences) {
+      const storedPresences = this.store.presences[remoteJid];
+      result.push(this.toWahaPresences(remoteJid, storedPresences));
+    }
+    return result;
+  }
+
+  public async getPresence(chatId: string): Promise<WAHAChatPresences> {
+    await this.subscribePresence(chatId);
+    const remoteJid = toJID(chatId);
+    const storedPresences = this.store.presences[remoteJid];
+    return this.toWahaPresences(remoteJid, storedPresences || []);
+  }
+
+  public async subscribePresence(chatId: string): Promise<void> {
+    const remoteJid = toJID(chatId);
+    if (this.store.presences[remoteJid]) {
+      return;
+    }
+    // Have no info - subscribe to listen for events
+    await this.sock.presenceSubscribe(remoteJid);
+    return;
+  }
+
+  /**
+   * END - Methods for API
+   */
+
+  subscribe(event, handler) {
+    if (event === WAHAEvents.MESSAGE) {
+      return this.sock.ev.on(BaileysEvents.MESSAGES_UPSERT, ({ messages }) =>
+        this.handleIncomingMessages(messages, handler, false),
+      );
+    } else if (event === WAHAEvents.MESSAGE_ANY) {
+      return this.sock.ev.on(BaileysEvents.MESSAGES_UPSERT, ({ messages }) =>
+        this.handleIncomingMessages(messages, handler, true),
+      );
+    } else if (event === WAHAEvents.STATE_CHANGE) {
+      return this.sock.ev.on(BaileysEvents.CONNECTION_UPDATE, handler);
+    } else if (event === WAHAEvents.GROUP_JOIN) {
+      return this.sock.ev.on(BaileysEvents.GROUPS_UPSERT, handler);
+    } else if (event === WAHAEvents.PRESENCE_UPDATE) {
+      return this.sock.ev.on(BaileysEvents.PRESENCE_UPDATE, (data) =>
+        handler(this.toWahaPresences(data.id, data.presences)),
+      );
+    } else {
+      throw new NotImplementedByEngineError(
+        `Engine does not support webhook event: ${event}`,
+      );
+    }
+  }
+
+  private handleIncomingMessages(messages, handler, includeFromMe) {
+    for (const message of messages) {
+      // if there is no text or media message
+      if (!message) return;
+      if (!message.message) return;
+      // Do not include my messages
+      if (!includeFromMe && message.key.fromMe) {
+        continue;
+      }
+      this.processIncomingMessage(message).then(handler);
+    }
+  }
+
+  private processIncomingMessage(message) {
+    return this.downloadMedia(message).then(this.toWAMessage);
+  }
+
+  protected toWAMessage(message): Promise<WAMessage> {
+    const isGroupMessage = Boolean(message.key.participant);
+    let participant: string;
+    let to: string;
+    if (isGroupMessage) {
+      participant = message.key.participant;
+      to = message.key.remoteJid;
+    }
+    const from = message.key.remoteJid;
+    const id = buildMessageId(message.key);
+    let body = message.message.conversation;
+    if (!body) {
+      // Some of the messages have no conversation, but instead have text in extendedTextMessage
+      // https://github.com/devlikeapro/whatsapp-http-api/issues/90
+      body = message.message.extendedTextMessage?.text;
+    }
+    return Promise.resolve({
+      id: id,
+      timestamp: message.messageTimestamp,
+      from: toCusFormat(from),
+      fromMe: message.key.fromMe,
+      body: body,
+      to: toCusFormat(to),
+      participant: toCusFormat(participant),
+      // @ts-ignore
+      hasMedia: Boolean(message.mediaUrl),
+      // @ts-ignore
+      mediaUrl: message.mediaUrl,
+      // @ts-ignore
+      ack: message.ack,
+      location: message.location,
+      vCards: message.vCards,
+      _data: message,
+    });
+  }
+
+  private toWahaPresences(
+    remoteJid,
+    storedPresences: PresenceData[],
+  ): WAHAChatPresences {
+    const presences: WAHAPresenceData[] = [];
+    for (const participant in storedPresences) {
+      const data: PresenceData = storedPresences[participant];
+      const lastKnownPresence = lodash.get(
+        PresenceStatuses,
+        data.lastKnownPresence,
+        data.lastKnownPresence,
+      );
+      const presence: WAHAPresenceData = {
+        participant: toCusFormat(participant),
+        // @ts-ignore
+        lastKnownPresence: lastKnownPresence,
+        lastSeen: data.lastSeen || null,
+      };
+      presences.push(presence);
+    }
+    const chatId = toCusFormat(remoteJid);
+    return { id: chatId, presences: presences };
+  }
+
+  protected async downloadMedia(message: Message) {
+    if (!message.hasMedia) {
+      return message;
+    }
+
+    // @ts-ignore
+    message.mediaUrl = await this.storage.save(message.key.id, '', undefined);
+    return message;
+  }
+}
+
+/**
+ * Convert from 11111111111@s.whatsapp.net to 11111111111@c.us
+ */
+function toCusFormat(remoteJid) {
+  if (isJidGroup(remoteJid)) {
+    return remoteJid;
+  }
+  if (!remoteJid) {
+    return;
+  }
+  const number = remoteJid.split('@')[0];
+  return ensureSuffix(number);
+}
+
+/**
+ * Convert from 11111111111@c.us to 11111111111@s.whatsapp.net
+ * @param chatId
+ */
+function toJID(chatId) {
+  if (isJidGroup(chatId)) {
+    return chatId;
+  }
+  const number = chatId.split('@')[0];
+  return number + '@s.whatsapp.net';
+}
+
+/**
+ * Build WAHA message id from engine one
+ * {id: "AAA", remoteJid: "11111111111@s.whatsapp.net", "fromMe": false}
+ * false_11111111111@c.us_AA
+ */
+function buildMessageId({ id, remoteJid, fromMe }) {
+  const chatId = toCusFormat(remoteJid);
+  return `${fromMe || false}_${chatId}_${id}`;
+}
+
+/**
+ * Parse message id from WAHA to engine
+ * false_11111111111@c.us_AAA
+ * {id: "AAA", remoteJid: "11111111111@s.whatsapp.net", "fromMe": false}
+ */
+function parseMessageId(messageId) {
+  const parts = messageId.split('_');
+  if (parts.length != 3) {
+    throw new Error(
+      'Message id be in format false_11111111111@c.us_AAAAAAAAAAAAAAAAAAAA',
+    );
+  }
+  const fromMe = parts[0] == 'true';
+  const chatId = parts[1];
+  const remoteJid = toJID(chatId);
+  const id = parts[2];
+  return { fromMe: fromMe, id: id, remoteJid: remoteJid };
+}
+
+function getId(object) {
+  return object.id;
+}

src/core/session.venom.core.ts

@@ -1,229 +1,290 @@
-import {WhatsappSession} from "./abc/session.abc";
+import { UnprocessableEntityException } from '@nestjs/common/exceptions/unprocessable-entity.exception';
+import { create, CreateConfig, Message, Whatsapp } from 'venom-bot';
+
 import {
-    Button,
-    ChatRequest,
-    CheckNumberStatusQuery,
-    MessageContactVcardRequest,
-    MessageFileRequest,
-    MessageImageRequest,
-    MessageLinkPreviewRequest,
-    MessageLocationRequest,
-    MessageReactionRequest,
-    MessageReplyRequest,
-    MessageTextButtonsRequest,
-    MessageTextRequest
-} from "../structures/chatting.dto";
-import {WAMessage, WANumberExistResult} from "../structures/responses.dto";
-import {create, Message, Whatsapp} from "venom-bot";
-import {WAEvents, WhatsappStatus} from "../structures/enums.dto";
-import {NotImplementedByEngineError} from "./exceptions";
-import {MediaStorage} from "./abc/storage.abc";
-import {UnprocessableEntityException} from "@nestjs/common/exceptions/unprocessable-entity.exception";
-import {ConsoleLogger} from "@nestjs/common";
-
-class QR {
-    private base64: string;
-
-    save(base64) {
-        this.base64 = base64.replace(/^data:image\/png;base64,/, '');
-    }
-
-    get(): Buffer {
-        return Buffer.from(this.base64, "base64")
-    }
-
-}
+  Button,
+  ChatRequest,
+  CheckNumberStatusQuery,
+  GetMessageQuery,
+  MessageContactVcardRequest,
+  MessageFileRequest,
+  MessageImageRequest,
+  MessageLinkPreviewRequest,
+  MessageLocationRequest,
+  MessageReactionRequest,
+  MessageReplyRequest,
+  MessageTextButtonsRequest,
+  MessageTextRequest,
+} from '../structures/chatting.dto';
+import {
+  WAHAEngine,
+  WAHAEvents,
+  WAHASessionStatus,
+} from '../structures/enums.dto';
+import { WAMessage, WANumberExistResult } from '../structures/responses.dto';
+import { WAHAInternalEvent, WhatsappSession } from './abc/session.abc';
+import { NotImplementedByEngineError } from './exceptions';
+import { QR } from './QR';
 
 export class WhatsappSessionVenomCore extends WhatsappSession {
-    whatsapp: Whatsapp;
-    private qr: QR
+  engine = WAHAEngine.VENOM;
 
-    public constructor(public name: string, protected storage: MediaStorage, protected log: ConsoleLogger) {
-        super(name, storage, log);
-        this.qr = new QR()
+  whatsapp: Whatsapp;
+  private qr: QR;
+
+  public constructor(config) {
+    super(config);
+    this.qr = new QR();
+  }
+
+  protected buildClient() {
+    const venomOptions: CreateConfig = {
+      headless: true,
+      devtools: false,
+      debug: false,
+      logQR: true,
+      browserArgs: this.getBrowserArgsForPuppeteer(),
+      autoClose: 60000,
+      puppeteerOptions: {},
+    };
+    this.addProxyConfig(venomOptions);
+    return create(this.name, this.getCatchQR(), undefined, venomOptions);
+  }
+
+  protected addProxyConfig(venomOptions: CreateConfig) {
+    if (this.proxyConfig?.server !== undefined) {
+      venomOptions.addProxy = [this.proxyConfig?.server];
+    }
+    if (
+      this.proxyConfig?.username !== undefined &&
+      this.proxyConfig?.password !== undefined
+    ) {
+      venomOptions.userProxy = this.proxyConfig?.username;
+      venomOptions.userPass = this.proxyConfig?.password;
+    }
+  }
+
+  protected getCatchQR() {
+    return (base64Qrimg, asciiQR, attempts, urlCode) => {
+      this.qr.save(base64Qrimg);
+      this.status = WAHASessionStatus.SCAN_QR_CODE;
+      this.log.debug('Number of attempts to read the qrcode: ', attempts);
+      this.log.log('Terminal qrcode:');
+      // Log QR image in console without this.log to make it pretty
+      console.log(asciiQR);
+    };
+  }
+
+  async start() {
+    try {
+      this.whatsapp = await this.buildClient();
+    } catch (error) {
+      this.status = WAHASessionStatus.FAILED;
+      this.log.error(error);
+      this.qr.save('');
+      return;
     }
 
-    async start() {
-        try {
-            this.whatsapp = await create('sessionName',
-                (base64Qrimg, asciiQR, attempts, urlCode) => {
-                    this.qr.save(base64Qrimg)
-                    this.status = WhatsappStatus.SCAN_QR_CODE
-                    this.log.debug('Number of attempts to read the qrcode: ', attempts);
-                    this.log.log('Terminal qrcode:');
-                    // Log QR image in console without this.log to make it pretty
-                    console.log(asciiQR);
-                },
-                undefined,
-                {
-                    headless: true,
-                    devtools: false,
-                    useChrome: true,
-                    debug: false,
-                    logQR: true,
-                    browserArgs: ["--no-sandbox"],
-                    autoClose: 60000,
-                    createPathFileToken: true,
-                    puppeteerOptions: {},
-                    multidevice: false,
-                }
-            )
-        } catch (error) {
-            this.status = WhatsappStatus.FAILED
-            this.log.error(error)
-            this.qr.save("")
-            return
-        }
+    this.status = WAHASessionStatus.WORKING;
+    this.events.emit(WAHAInternalEvent.engine_start);
+    return this;
+  }
 
-        this.status = WhatsappStatus.WORKING
-        return this
+  stop() {
+    return this.whatsapp.close();
+  }
+
+  subscribe(event: WAHAEvents | string, handler: (message) => void) {
+    if (event === WAHAEvents.MESSAGE) {
+      return this.whatsapp.onMessage((message: Message) =>
+        this.processIncomingMessage(message).then(handler),
+      );
+    } else if (event === WAHAEvents.MESSAGE_ANY) {
+      return this.whatsapp.onAnyMessage((message: Message) =>
+        this.processIncomingMessage(message).then(handler),
+      );
+    } else if (event === WAHAEvents.STATE_CHANGE) {
+      return this.whatsapp.onStateChange(handler);
+    } else if (event === WAHAEvents.MESSAGE_ACK) {
+      return this.whatsapp.onAck(handler);
+    } else if (event === WAHAEvents.GROUP_JOIN) {
+      return this.whatsapp.onAddedToGroup(handler);
+    } else {
+      throw new NotImplementedByEngineError(
+        `Engine does not support webhook event: ${event}`,
+      );
     }
+  }
 
-
-    stop() {
-        return this.whatsapp.close()
+  /**
+   * START - Methods for API
+   */
+  getScreenshot(): Promise<Buffer | string> {
+    if (this.status === WAHASessionStatus.STARTING) {
+      throw new UnprocessableEntityException(
+        `The session is starting, please try again after few seconds`,
+      );
+    } else if (this.status === WAHASessionStatus.SCAN_QR_CODE) {
+      return Promise.resolve(this.qr.get());
+    } else if (this.status === WAHASessionStatus.WORKING) {
+      return this.whatsapp.page.screenshot();
+    } else {
+      throw new UnprocessableEntityException(`Unknown status - ${this.status}`);
     }
+  }
 
-    subscribe(event: WAEvents | string, handler: (message) => void) {
-        if (event === WAEvents.MESSAGE) {
-            return this.whatsapp.onMessage((message: Message) => this.processIncomingMessage(message).then(handler))
-        } else if (event === WAEvents.MESSAGE_ANY) {
-            return this.whatsapp.onAnyMessage((message: Message) => this.processIncomingMessage(message).then(handler))
-        } else if (event === WAEvents.STATE_CHANGE) {
-            return this.whatsapp.onStateChange(handler)
-        } else if (event === WAEvents.MESSAGE_ACK) {
-            return this.whatsapp.onAck(handler)
-        } else if (event === WAEvents.GROUP_JOIN) {
-            return this.whatsapp.onAddedToGroup(handler)
-        } else {
-            throw new NotImplementedByEngineError(`Engine does not support webhook event: ${event}`)
-        }
+  async checkNumberStatus(
+    request: CheckNumberStatusQuery,
+  ): Promise<WANumberExistResult> {
+    try {
+      return await this.whatsapp.checkNumberStatus(
+        this.ensureSuffix(request.phone),
+      );
+    } catch (error) {
+      // Catch number doesn't exist error and return it as is
+      if (error.status === 404 && !error.numberExists) {
+        return error;
+      }
+      throw error;
     }
+  }
 
+  sendContactVCard(request: MessageContactVcardRequest) {
+    return this.whatsapp.sendContactVcard(
+      request.chatId,
+      request.contactsId,
+      request.name,
+    );
+  }
 
-    /**
-     * START - Methods for API
-     */
-    getScreenshot(): Promise<Buffer | string> {
-        if (this.status === WhatsappStatus.STARTING) {
-            throw new UnprocessableEntityException(`The session is starting, please try again after few seconds`);
-        } else if (this.status === WhatsappStatus.SCAN_QR_CODE) {
-            return Promise.resolve(this.qr.get())
-        } else if (this.status === WhatsappStatus.WORKING) {
-            return this.whatsapp.page.screenshot()
-        } else {
-            throw new UnprocessableEntityException(`Unknown status - ${this.status}`);
-        }
+  sendText(request: MessageTextRequest) {
+    return this.whatsapp.sendText(
+      this.ensureSuffix(request.chatId),
+      request.text,
+    );
+  }
+
+  reply(request: MessageReplyRequest) {
+    return this.whatsapp.reply(request.chatId, request.text, request.reply_to);
+  }
+
+  sendFile(request: MessageFileRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  sendImage(request: MessageImageRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  async sendVoice(request) {
+    throw new NotImplementedByEngineError();
+  }
+
+  sendLinkPreview(request: MessageLinkPreviewRequest) {
+    return this.whatsapp.sendLinkPreview(
+      request.chatId,
+      request.url,
+      request.title,
+    );
+  }
+
+  sendLocation(request: MessageLocationRequest) {
+    return this.whatsapp.sendLocation(
+      request.chatId,
+      String(request.latitude),
+      String(request.longitude),
+      request.title,
+    );
+  }
+
+  sendSeen(chat: ChatRequest) {
+    return this.whatsapp.markMarkSeenMessage(chat.chatId);
+  }
+
+  sendTextButtons(request: MessageTextButtonsRequest) {
+    const buttons = request.buttons.map((button: Button) => {
+      return {
+        buttonId: button.id,
+        buttonText: {
+          displayText: button.text,
+        },
+      };
+    });
+    return this.whatsapp.sendButtons(
+      this.ensureSuffix(request.chatId),
+      request.title,
+      request.footer,
+      buttons,
+    );
+  }
+
+  startTyping(chat: ChatRequest) {
+    return this.whatsapp.startTyping(chat.chatId, false);
+  }
+
+  stopTyping(chat: ChatRequest) {
+    return;
+    // The method is not available yet in new venom-bot
+    // return this.whatsapp.stopTyping(chat.chatId);
+  }
+
+  async getMessages(query: GetMessageQuery) {
+    const messages = await this.whatsapp.getAllMessagesInChat(
+      query.chatId,
+      true,
+      false,
+    );
+    // Go over messages, download media, and convert to right format.
+    const result = [];
+    for (const [count, message] of messages.entries()) {
+      if (count > query.limit) {
+        // Have enough in the list, stop processing
+        break;
+      }
+      result.push(await this.processIncomingMessage(message));
     }
+    return result;
+  }
 
-    async checkNumberStatus(request: CheckNumberStatusQuery): Promise<WANumberExistResult> {
-        try {
-            const result = await this.whatsapp.checkNumberStatus(this.ensureSuffix(request.phone))
-            return {numberExists: result['numberExists']}
-        } catch (error) {
-            // We need to "touch" the error in order to get unhandled rejections
-            // It logs out the session and stop the app
-            console.log(typeof error)
-            console.log(error)
-            return {numberExists: false}
-        }
+  setReaction(request: MessageReactionRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  /**
+   * END - Methods for API
+   */
+
+  protected async downloadAndDecryptMedia(message: Message) {
+    if (!message.isMMS || !message.isMedia) {
+      return message;
     }
+    // @ts-ignore
+    message.mediaUrl = await this.storage.save(message.id, '', undefined);
+    return message;
+  }
 
-    sendContactVCard(request: MessageContactVcardRequest) {
-        return this.whatsapp.sendContactVcard(request.chatId, request.contactsId, request.name)
-    }
+  private processIncomingMessage(message: Message) {
+    return this.downloadAndDecryptMedia(message).then(this.toWAMessage);
+  }
 
-    sendText(request: MessageTextRequest) {
-        return this.whatsapp.sendText(this.ensureSuffix(request.chatId), request.text)
-    }
-
-    reply(request: MessageReplyRequest) {
-        return this.whatsapp.reply(request.chatId, request.text, request.reply_to)
-    }
-
-    sendFile(request: MessageFileRequest) {
-        throw new NotImplementedByEngineError()
-    }
-
-    sendImage(request: MessageImageRequest) {
-        throw new NotImplementedByEngineError()
-    }
-
-    async sendVoice(request) {
-        throw new NotImplementedByEngineError()
-    }
-
-    sendLinkPreview(request: MessageLinkPreviewRequest) {
-        return this.whatsapp.sendLinkPreview(request.chatId, request.url, request.title)
-    }
-
-    sendLocation(request: MessageLocationRequest) {
-        return this.whatsapp.sendLocation(request.chatId, request.latitude, request.longitude, request.title)
-    }
-
-    sendSeen(chat: ChatRequest) {
-        return this.whatsapp.sendSeen(chat.chatId)
-    }
-
-    sendTextButtons(request: MessageTextButtonsRequest) {
-        const buttons = request.buttons.map((button: Button) => {
-            return {
-                buttonId: button.id,
-                buttonText: {
-                    displayText: button.body
-                }
-            }
-        })
-        return this.whatsapp.sendButtons(this.ensureSuffix(request.chatId), request.title, buttons, request.text)
-    }
-
-    startTyping(chat: ChatRequest) {
-        return this.whatsapp.startTyping(chat.chatId)
-    }
-
-    stopTyping(chat: ChatRequest) {
-        return this.whatsapp.stopTyping(chat.chatId)
-    }
-
-    setReaction(request: MessageReactionRequest) {
-        throw new NotImplementedByEngineError()
-    }
-
-    /**
-     * END - Methods for API
-     */
-
-    protected async downloadAndDecryptMedia(message: Message) {
-        if (!message.isMMS || !message.isMedia) {
-            return message
-        }
-        // @ts-ignore
-        message.mediaUrl = await this.storage.save(message.id, "", undefined)
-        return message
-    }
-
-    private processIncomingMessage(message: Message) {
-        return this.downloadAndDecryptMedia(message).then(this.toWAMessage)
-    }
-
-    protected toWAMessage(message: Message): Promise<WAMessage> {
-        // @ts-ignore
-        return Promise.resolve({
-            id: message.id,
-            timestamp: message.timestamp,
-            from: message.from,
-            fromMe: message.fromMe,
-            to: message.to,
-            body: message.body,
-            // @ts-ignore
-            hasMedia: Boolean(message.mediaUrl),
-            // @ts-ignore
-            mediaUrl: message.mediaUrl,
-            // @ts-ignore
-            ack: message.ack,
-            location: undefined,
-            vCards: undefined,
-            _data: message,
-        })
-    }
+  protected toWAMessage(message: Message): Promise<WAMessage> {
+    // @ts-ignore
+    return Promise.resolve({
+      id: message.id,
+      timestamp: message.timestamp,
+      from: message.from,
+      fromMe: message.fromMe,
+      to: message.to,
+      body: message.body,
+      // @ts-ignore
+      hasMedia: Boolean(message.mediaUrl),
+      // @ts-ignore
+      mediaUrl: message.mediaUrl,
+      // @ts-ignore
+      ack: message.ack,
+      location: undefined,
+      vCards: undefined,
+      _data: message,
+    });
+  }
 }

src/core/session.webjs.core.ts

@@ -1,207 +1,473 @@
-import {UnprocessableEntityException} from "@nestjs/common/exceptions/unprocessable-entity.exception";
-import {Buttons, Chat, Client, Events, Message} from "whatsapp-web.js";
-import {Message as MessageInstance} from "whatsapp-web.js/src/structures"
-import {WAEvents, WhatsappStatus} from "../structures/enums.dto";
-import {WhatsappSession} from "./abc/session.abc";
-import {WAMessage, WANumberExistResult} from "../structures/responses.dto";
+import { UnprocessableEntityException } from '@nestjs/common/exceptions/unprocessable-entity.exception';
 import {
-    ChatRequest,
-    CheckNumberStatusQuery,
-    MessageContactVcardRequest,
-    MessageFileRequest,
-    MessageImageRequest,
-    MessageLinkPreviewRequest,
-    MessageLocationRequest,
-    MessageReactionRequest,
-    MessageReplyRequest,
-    MessageTextButtonsRequest,
-    MessageTextRequest,
-    MessageVoiceRequest
-} from "../structures/chatting.dto";
-import {AvailableInPlusVersion, NotImplementedByEngineError} from "./exceptions";
+  Buttons,
+  Chat,
+  Client,
+  ClientOptions,
+  Contact,
+  Events,
+  GroupChat,
+  Location,
+  Message,
+} from 'whatsapp-web.js';
+import { Message as MessageInstance } from 'whatsapp-web.js/src/structures';
+
+import {
+  Button,
+  ChatRequest,
+  CheckNumberStatusQuery,
+  GetMessageQuery,
+  MessageContactVcardRequest,
+  MessageFileRequest,
+  MessageImageRequest,
+  MessageLinkPreviewRequest,
+  MessageLocationRequest,
+  MessageReactionRequest,
+  MessageReplyRequest,
+  MessageTextButtonsRequest,
+  MessageTextRequest,
+  MessageVoiceRequest,
+  SendSeenRequest,
+} from '../structures/chatting.dto';
+import { ContactQuery, ContactRequest } from '../structures/contacts.dto';
+import {
+  WAHAEngine,
+  WAHAEvents,
+  WAHAPresenceStatus,
+  WAHASessionStatus,
+} from '../structures/enums.dto';
+import {
+  CreateGroupRequest,
+  ParticipantsRequest,
+} from '../structures/groups.dto';
+import { WAMessage, WANumberExistResult } from '../structures/responses.dto';
+import { WAHAInternalEvent, WhatsappSession } from './abc/session.abc';
+import {
+  AvailableInPlusVersion,
+  NotImplementedByEngineError,
+} from './exceptions';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const qrcode = require('qrcode-terminal');
 
-
 export class WhatsappSessionWebJSCore extends WhatsappSession {
-    whatsapp: Client;
+  engine = WAHAEngine.WEBJS;
 
-    protected buildClient() {
-        return new Client({
-            puppeteer: {
-                headless: true,
-                executablePath: "/usr/bin/google-chrome-stable",
-                args: ['--no-sandbox', '--disable-setuid-sandbox'],
-            }
-        });
-    }
+  whatsapp: Client;
 
-    async start() {
-        this.whatsapp = this.buildClient()
+  protected buildClient() {
+    const clientOptions: ClientOptions = {
+      puppeteer: {
+        headless: true,
+        executablePath: this.getBrowserExecutablePath(),
+        args: this.getBrowserArgsForPuppeteer(),
+      },
+    };
+    this.addProxyConfig(clientOptions);
+    return new Client(clientOptions);
+  }
 
-        this.whatsapp.initialize().catch(error => {
-            this.status = WhatsappStatus.FAILED
-            this.log.error(error)
-            return
-        });
+  protected addProxyConfig(clientOptions: ClientOptions) {
+    if (this.proxyConfig?.server !== undefined) {
+      // push the proxy server to the args
+      clientOptions.puppeteer.args.push(
+        `--proxy-server=${this.proxyConfig?.server}`,
+      );
 
-        // Connect events
-        this.whatsapp.on(Events.QR_RECEIVED, (qr) => {
-            qrcode.generate(qr, {small: true});
-            this.status = WhatsappStatus.SCAN_QR_CODE
-        });
-
-        this.whatsapp.on(Events.AUTHENTICATED, () => {
-            this.status = WhatsappStatus.WORKING
-            this.log.log(`Session '${this.name}' has been authenticated!`)
-        });
-        return this
-    }
-
-    stop() {
-        return this.whatsapp.pupPage.close()
-    }
-
-    /**
-     * START - Methods for API
-     */
-    async getScreenshot(): Promise<Buffer | string> {
-        if (this.status === WhatsappStatus.FAILED) {
-            throw new UnprocessableEntityException(`The session under FAILED status. Please try to restart it.`);
-        }
-        return await this.whatsapp.pupPage.screenshot()
-    }
-
-    checkNumberStatus(request: CheckNumberStatusQuery): Promise<WANumberExistResult> {
-        throw new NotImplementedByEngineError()
-    }
-
-    sendText(request: MessageTextRequest): Promise<WAMessage> {
-        return this.whatsapp.sendMessage(this.ensureSuffix(request.chatId), request.text).then(this.toWAMessage)
-    }
-
-    sendTextButtons(request: MessageTextButtonsRequest) {
-        const message = new Buttons("", request.buttons, request.title, request.text)
-        return this.whatsapp.sendMessage(this.ensureSuffix(request.chatId), message).then(this.toWAMessage)
-    }
-
-    sendContactVCard(request: MessageContactVcardRequest) {
-        throw new NotImplementedByEngineError()
-    }
-
-    reply(request: MessageReplyRequest) {
-        const options = {
-            quotedMessageId: request.reply_to,
+      // Authenticate
+      if (this.proxyConfig?.username && this.proxyConfig?.password) {
+        clientOptions.proxyAuthentication = {
+          username: this.proxyConfig?.username,
+          password: this.proxyConfig?.password,
         };
-        return this.whatsapp.sendMessage(request.chatId, request.text, options).then(this.toWAMessage)
+      }
+    }
+  }
+
+  async start() {
+    this.whatsapp = this.buildClient();
+
+    this.whatsapp.initialize().catch((error) => {
+      this.status = WAHASessionStatus.FAILED;
+      this.log.error(error);
+      return;
+    });
+
+    // Connect events
+    this.whatsapp.on(Events.QR_RECEIVED, (qr) => {
+      qrcode.generate(qr, { small: true });
+      this.status = WAHASessionStatus.SCAN_QR_CODE;
+    });
+
+    this.whatsapp.on(Events.AUTHENTICATED, () => {
+      this.status = WAHASessionStatus.WORKING;
+      this.log.log(`Session '${this.name}' has been authenticated!`);
+    });
+    this.events.emit(WAHAInternalEvent.engine_start);
+    return this;
+  }
+
+  stop() {
+    return this.whatsapp.destroy();
+  }
+
+  /**
+   * START - Methods for API
+   */
+  async getScreenshot(): Promise<Buffer | string> {
+    if (this.status === WAHASessionStatus.FAILED) {
+      throw new UnprocessableEntityException(
+        `The session under FAILED status. Please try to restart it.`,
+      );
+    }
+    return await this.whatsapp.pupPage.screenshot();
+  }
+
+  async checkNumberStatus(
+    request: CheckNumberStatusQuery,
+  ): Promise<WANumberExistResult> {
+    const exist = await this.whatsapp.isRegisteredUser(
+      this.ensureSuffix(request.phone),
+    );
+    return { numberExists: exist };
+  }
+
+  sendText(request: MessageTextRequest) {
+    const options = {
+      // It's fine to sent just ids instead of Contact object
+      mentions: request.mentions as unknown as Contact[],
+    };
+    return this.whatsapp.sendMessage(
+      this.ensureSuffix(request.chatId),
+      request.text,
+      options,
+    );
+  }
+
+  sendTextButtons(request: MessageTextButtonsRequest) {
+    const buttons = request.buttons.map((button: Button) => {
+      return {
+        id: button.id,
+        body: button.text,
+      };
+    });
+    const message = new Buttons('', buttons, request.title, request.footer);
+    return this.whatsapp.sendMessage(
+      this.ensureSuffix(request.chatId),
+      message,
+    );
+  }
+
+  sendContactVCard(request: MessageContactVcardRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  reply(request: MessageReplyRequest) {
+    const options = {
+      quotedMessageId: request.reply_to,
+      // It's fine to sent just ids instead of Contact object
+      mentions: request.mentions as unknown as Contact[],
+    };
+    return this.whatsapp.sendMessage(request.chatId, request.text, options);
+  }
+
+  sendImage(request: MessageImageRequest) {
+    throw new AvailableInPlusVersion();
+  }
+
+  sendFile(request: MessageFileRequest) {
+    throw new AvailableInPlusVersion();
+  }
+
+  sendVoice(request: MessageVoiceRequest) {
+    throw new AvailableInPlusVersion();
+  }
+
+  async sendLocation(request: MessageLocationRequest) {
+    const location = new Location(
+      request.latitude,
+      request.longitude,
+      request.title,
+    );
+    return this.whatsapp.sendMessage(request.chatId, location);
+  }
+
+  sendLinkPreview(request: MessageLinkPreviewRequest) {
+    throw new NotImplementedByEngineError();
+  }
+
+  async sendSeen(request: SendSeenRequest) {
+    const chat: Chat = await this.whatsapp.getChatById(request.chatId);
+    await chat.sendSeen();
+  }
+
+  async startTyping(request: ChatRequest) {
+    const chat: Chat = await this.whatsapp.getChatById(request.chatId);
+    await chat.sendStateTyping();
+  }
+
+  async stopTyping(request: ChatRequest) {
+    const chat: Chat = await this.whatsapp.getChatById(request.chatId);
+    await chat.clearState();
+  }
+
+  async getMessages(query: GetMessageQuery) {
+    const chat: Chat = await this.whatsapp.getChatById(
+      this.ensureSuffix(query.chatId),
+    );
+    const messages = await chat.fetchMessages({
+      limit: query.limit,
+    });
+    // Go over messages, download media, and convert to right format.
+    const result = [];
+    for (const message of messages) {
+      result.push(await this.processIncomingMessage(message));
+    }
+    return result;
+  }
+
+  async setReaction(request: MessageReactionRequest) {
+    const messageId = this.deserializeId(request.messageId);
+    // Recreate instance to react on it
+    const message = new MessageInstance(this.whatsapp);
+    message.id = messageId;
+    message._data = { id: messageId };
+
+    return message.react(request.reaction);
+  }
+
+  /**
+   * Contacts methods
+   */
+  getContact(query: ContactQuery) {
+    return this.whatsapp
+      .getContactById(this.ensureSuffix(query.contactId))
+      .then(this.toWAContact);
+  }
+
+  getContacts() {
+    return this.whatsapp
+      .getContacts()
+      .then((contacts) => contacts.map(this.toWAContact));
+  }
+
+  public async getContactAbout(query: ContactQuery) {
+    const contact = await this.whatsapp.getContactById(
+      this.ensureSuffix(query.contactId),
+    );
+    return { about: await contact.getAbout() };
+  }
+
+  public async getContactProfilePicture(query: ContactQuery) {
+    const contact = await this.whatsapp.getContactById(
+      this.ensureSuffix(query.contactId),
+    );
+    return { profilePictureURL: await contact.getProfilePicUrl() };
+  }
+
+  public async blockContact(request: ContactRequest) {
+    const contact = await this.whatsapp.getContactById(
+      this.ensureSuffix(request.contactId),
+    );
+    await contact.block();
+  }
+
+  public async unblockContact(request: ContactRequest) {
+    const contact = await this.whatsapp.getContactById(
+      this.ensureSuffix(request.contactId),
+    );
+    await contact.unblock();
+  }
+
+  /**
+   * Group methods
+   */
+  public createGroup(request: CreateGroupRequest) {
+    const participantIds = request.participants.map(
+      (participant) => participant.id,
+    );
+    return this.whatsapp.createGroup(request.name, participantIds);
+  }
+
+  public getGroups() {
+    return this.whatsapp
+      .getChats()
+      .then((chats) => chats.filter((chat) => chat.isGroup));
+  }
+
+  public getGroup(id) {
+    return this.whatsapp.getChatById(id);
+  }
+
+  public async deleteGroup(id) {
+    const groupChat = (await this.whatsapp.getChatById(id)) as GroupChat;
+    return groupChat.delete();
+  }
+
+  public async leaveGroup(id) {
+    const groupChat = (await this.whatsapp.getChatById(id)) as GroupChat;
+    return groupChat.leave();
+  }
+
+  public async setDescription(id, description) {
+    const groupChat = (await this.whatsapp.getChatById(id)) as GroupChat;
+    return groupChat.setDescription(description);
+  }
+
+  public async setSubject(id, subject) {
+    const groupChat = (await this.whatsapp.getChatById(id)) as GroupChat;
+    return groupChat.setSubject(subject);
+  }
+
+  public async getInviteCode(id): Promise<string> {
+    const groupChat = (await this.whatsapp.getChatById(id)) as GroupChat;
+    return groupChat.getInviteCode();
+  }
+
+  public async revokeInviteCode(id): Promise<string> {
+    const groupChat = (await this.whatsapp.getChatById(id)) as GroupChat;
+    await groupChat.revokeInvite();
+    return groupChat.getInviteCode();
+  }
+
+  public async getParticipants(id) {
+    const groupChat = (await this.whatsapp.getChatById(id)) as GroupChat;
+    return groupChat.participants;
+  }
+
+  public async addParticipants(id, request: ParticipantsRequest) {
+    const groupChat = (await this.whatsapp.getChatById(id)) as GroupChat;
+    const participantIds = request.participants.map(
+      (participant) => participant.id,
+    );
+    return groupChat.addParticipants(participantIds);
+  }
+
+  public async removeParticipants(id, request: ParticipantsRequest) {
+    const groupChat = (await this.whatsapp.getChatById(id)) as GroupChat;
+    const participantIds = request.participants.map(
+      (participant) => participant.id,
+    );
+    return groupChat.removeParticipants(participantIds);
+  }
+
+  public async promoteParticipantsToAdmin(id, request: ParticipantsRequest) {
+    const groupChat = (await this.whatsapp.getChatById(id)) as GroupChat;
+    const participantIds = request.participants.map(
+      (participant) => participant.id,
+    );
+    return groupChat.promoteParticipants(participantIds);
+  }
+
+  public async demoteParticipantsToUser(id, request: ParticipantsRequest) {
+    const groupChat = (await this.whatsapp.getChatById(id)) as GroupChat;
+    const participantIds = request.participants.map(
+      (participant) => participant.id,
+    );
+    return groupChat.demoteParticipants(participantIds);
+  }
+
+  public async setPresence(presence: WAHAPresenceStatus, chatId?: string) {
+    let chat: Chat;
+    switch (presence) {
+      case WAHAPresenceStatus.ONLINE:
+        await this.whatsapp.sendPresenceAvailable();
+        break;
+      case WAHAPresenceStatus.OFFLINE:
+        await this.whatsapp.sendPresenceUnavailable();
+        break;
+      case WAHAPresenceStatus.TYPING:
+        chat = await this.whatsapp.getChatById(chatId);
+        await chat.sendStateTyping();
+        break;
+      case WAHAPresenceStatus.RECORDING:
+        chat = await this.whatsapp.getChatById(chatId);
+        await chat.sendStateRecording();
+        break;
+      case WAHAPresenceStatus.PAUSED:
+        chat = await this.whatsapp.getChatById(chatId);
+        await chat.clearState();
+        break;
+      default:
+        throw new NotImplementedByEngineError(
+          `WEBJS engine doesn't support '${presence}' presence.`,
+        );
+    }
+  }
+
+  /**
+   * END - Methods for API
+   */
+
+  subscribe(event, handler) {
+    if (event === WAHAEvents.MESSAGE) {
+      this.whatsapp.on(Events.MESSAGE_RECEIVED, (message) =>
+        this.processIncomingMessage(message).then(handler),
+      );
+    } else if (event === WAHAEvents.MESSAGE_ANY) {
+      this.whatsapp.on(Events.MESSAGE_CREATE, (message) =>
+        this.processIncomingMessage(message).then(handler),
+      );
+    } else if (event === WAHAEvents.STATE_CHANGE) {
+      this.whatsapp.on(Events.STATE_CHANGED, handler);
+    } else if (event === WAHAEvents.MESSAGE_ACK) {
+      // We do not download media here
+      this.whatsapp.on(Events.MESSAGE_ACK, (message) =>
+        this.toWAMessage(message).then(handler),
+      );
+    } else if (event === WAHAEvents.GROUP_JOIN) {
+      this.whatsapp.on(Events.GROUP_JOIN, handler);
+    } else if (event === WAHAEvents.GROUP_LEAVE) {
+      this.whatsapp.on(Events.GROUP_LEAVE, handler);
+    } else {
+      throw new NotImplementedByEngineError(
+        `Engine does not support webhook event: ${event}`,
+      );
+    }
+  }
+
+  private processIncomingMessage(message: Message) {
+    return this.downloadMedia(message).then(this.toWAMessage);
+  }
+
+  protected toWAMessage(message: Message): Promise<WAMessage> {
+    // @ts-ignore
+    return Promise.resolve({
+      id: message.id._serialized,
+      timestamp: message.timestamp,
+      from: message.from,
+      fromMe: message.fromMe,
+      to: message.to,
+      body: message.body,
+      // @ts-ignore
+      hasMedia: Boolean(message.mediaUrl),
+      // @ts-ignore
+      mediaUrl: message.mediaUrl,
+      // @ts-ignore
+      ack: message.ack,
+      location: message.location,
+      vCards: message.vCards,
+      _data: message.rawData,
+    });
+  }
+
+  protected toWAContact(contact: Contact) {
+    // @ts-ignore
+    contact.id = contact.id._serialized;
+    return contact;
+  }
+
+  protected async downloadMedia(message: Message) {
+    if (!message.hasMedia) {
+      return message;
     }
 
-    sendImage(request: MessageImageRequest) {
-        throw new AvailableInPlusVersion()
-    }
-
-    sendFile(request: MessageFileRequest) {
-        throw new AvailableInPlusVersion()
-    }
-
-    sendVoice(request: MessageVoiceRequest) {
-        throw new AvailableInPlusVersion()
-    }
-
-    sendLinkPreview(request: MessageLinkPreviewRequest) {
-        throw new NotImplementedByEngineError()
-    }
-
-    sendLocation(request: MessageLocationRequest) {
-        throw new NotImplementedByEngineError()
-    }
-
-    async sendSeen(request: ChatRequest) {
-        const chat: Chat = await this.whatsapp.getChatById(request.chatId)
-        await chat.sendSeen()
-    }
-
-    async startTyping(request: ChatRequest) {
-        const chat: Chat = await this.whatsapp.getChatById(request.chatId)
-        await chat.sendStateTyping()
-    }
-
-    async stopTyping(request: ChatRequest) {
-        const chat: Chat = await this.whatsapp.getChatById(request.chatId)
-        await chat.clearState()
-    }
-
-    async setReaction(request: MessageReactionRequest) {
-        const messageId = this.deserializeId(request.messageId)
-        console.log(messageId)
-
-        // Recreate instance to react on it
-        const message = new MessageInstance(this.whatsapp)
-        message.id = messageId
-        message._data = {id: messageId}
-
-        return message.react(request.reaction)
-    }
-
-    /**
-     * END - Methods for API
-     */
-
-    subscribe(event, handler) {
-        if (event === WAEvents.MESSAGE) {
-            this.whatsapp.on(Events.MESSAGE_RECEIVED, (message) => this.processIncomingMessage(message).then(handler))
-        } else if (event === WAEvents.MESSAGE_ANY) {
-            this.whatsapp.on(Events.MESSAGE_CREATE, (message) => this.processIncomingMessage(message).then(handler))
-        } else if (event === WAEvents.STATE_CHANGE) {
-            this.whatsapp.on(Events.STATE_CHANGED, handler)
-        } else if (event === WAEvents.MESSAGE_ACK) {
-            // We do not download media here
-            this.whatsapp.on(Events.MESSAGE_ACK, (message) => this.toWAMessage(message).then(handler))
-        } else if (event === WAEvents.GROUP_JOIN) {
-            this.whatsapp.on(Events.GROUP_JOIN, handler)
-        } else if (event === WAEvents.GROUP_LEAVE) {
-            this.whatsapp.on(Events.GROUP_LEAVE, handler)
-        } else {
-            throw new NotImplementedByEngineError(`Engine does not support webhook event: ${event}`)
-        }
-    }
-
-    private processIncomingMessage(message: Message) {
-        return this.downloadMedia(message).then(this.toWAMessage)
-    }
-
-    protected toWAMessage(message: Message): Promise<WAMessage> {
-        // @ts-ignore
-        return Promise.resolve({
-            id: message.id._serialized,
-            timestamp: message.timestamp,
-            from: message.from,
-            fromMe: message.fromMe,
-            to: message.to,
-            body: message.body,
-            // @ts-ignore
-            hasMedia: Boolean(message.mediaUrl),
-            // @ts-ignore
-            mediaUrl: message.mediaUrl,
-            // @ts-ignore
-            ack: message.ack,
-            location: message.location,
-            vCards: message.vCards,
-            _data: message.rawData,
-        })
-    }
-
-    protected async downloadMedia(message: Message) {
-        if (!message.hasMedia) {
-            return message
-        }
-
-        // @ts-ignore
-        message.mediaUrl = await this.storage.save(message.id._serialized, "", undefined)
-        return message
-    }
-
-
+    // @ts-ignore
+    message.mediaUrl = await this.storage.save(
+      message.id._serialized,
+      '',
+      undefined,
+    );
+    return message;
+  }
 }
-

src/core/storage.core.ts

@@ -1,8 +1,97 @@
-import {DOCS_URL} from "./exceptions";
-import {MediaStorage} from "./abc/storage.abc";
+import * as crypto from 'crypto';
+import * as fs from 'fs/promises';
+import * as os from 'os';
+import * as path from 'path';
+
+import { SessionConfig } from '../structures/sessions.dto';
+import {
+  LocalSessionStorage,
+  MediaStorage,
+  SessionConfigRepository,
+} from './abc/storage.abc';
+import { DOCS_URL } from './exceptions';
 
 export class MediaStorageCore implements MediaStorage {
-    async save(messageId: string, mimetype: string, buffer: Buffer): Promise<string>{
-        return Promise.resolve(`Media attachment's available only in WAHA Plus version. ${DOCS_URL}`)
+  async save(
+    messageId: string,
+    mimetype: string,
+    buffer: Buffer,
+  ): Promise<string> {
+    return Promise.resolve(
+      `Media attachment's available only in WAHA Plus version. ${DOCS_URL}`,
+    );
+  }
+}
+
+class LocalSessionConfigRepository extends SessionConfigRepository {
+  FILENAME = '.waha.session.config.json';
+
+  constructor(private storage: LocalSessionStorage) {
+    super();
+  }
+
+  async get(sessionName: string): Promise<SessionConfig> {
+    const filepath = this.getFilePath(sessionName);
+    // Check file exists
+    try {
+      await fs.access(filepath, fs.constants.F_OK);
+    } catch (error) {
+      return undefined;
     }
+
+    const content = await fs.readFile(filepath, 'utf-8');
+    return JSON.parse(content);
+  }
+
+  async save(sessionName: string, config: SessionConfig) {
+    const filepath = this.getFilePath(sessionName);
+    const content = JSON.stringify(config || null);
+    await fs.writeFile(filepath, content);
+  }
+
+  private getFilePath(sessionName): string {
+    const folder = this.storage.getFolderPath(sessionName);
+    return path.join(folder, this.FILENAME);
+  }
+}
+
+export class SessionStorageCore extends LocalSessionStorage {
+  public sessionsFolder: string;
+
+  constructor(engine: string) {
+    super(engine);
+    this.sessionsFolder = path.join(os.tmpdir(), 'waha-sessions');
+  }
+
+  get engineFolder() {
+    return path.join(this.sessionsFolder, this.engine);
+  }
+
+  async init() {
+    await fs.mkdir(this.engineFolder, { recursive: true });
+  }
+
+  getFolderPath(name: string): string {
+    const suffix = crypto.createHash('md5').update(name).digest('hex');
+    return path.join(this.engineFolder, `${name}-${suffix}`);
+  }
+
+  async clean(sessionName: string) {
+    const folder = this.getFolderPath(sessionName);
+    await fs.rm(folder, { recursive: true });
+  }
+
+  async getAll(): Promise<string[]> {
+    await this.init();
+    const content = await fs.readdir(this.engineFolder, {
+      withFileTypes: true,
+    });
+    return content
+      .filter((dirent) => dirent.isDirectory())
+      .map((dirent) => dirent.name);
+  }
+
+  get configRepository(): LocalSessionConfigRepository {
+    return new LocalSessionConfigRepository(this);
+  }
 }

src/core/swagger.module.core.ts

@@ -0,0 +1,70 @@
+import { INestApplication } from '@nestjs/common';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+
+import { WhatsappConfigService } from '../config.service';
+import { VERSION } from '../version';
+
+export class SwaggerModuleCore {
+  configure(app: INestApplication) {
+    this.setUpAuth(app);
+    const builder = new DocumentBuilder();
+
+    builder
+      .setTitle('WAHA - WhatsApp HTTP API')
+      .setDescription('WhatsApp HTTP API that you can run in a click!')
+      .setExternalDoc('Documentation', 'https://waha.devlike.pro/')
+      .setVersion(VERSION.version)
+      .addTag('sessions', 'Control WhatsApp sessions')
+      .addTag('screenshot', 'Get screenshot of WhatsApp and show QR code')
+      .addTag('chatting', 'Chat methods')
+      .addTag(
+        'contacts',
+        `Contacts methods.<br>
+                Use phone number (without +) or phone number and \`@c.us\` at the end as \`contactId\`.<br>
+                'E.g: \`12312312310\` OR \`12312312310@c.us\`<br>`,
+      )
+      .addTag('groups', `Groups methods.<br>`)
+      .addTag('presence', `Presence information`)
+      .addTag('other', 'Other methods')
+      .addApiKey({
+        type: 'apiKey',
+        description: 'Your secret api key',
+        name: 'X-Api-Key',
+      });
+
+    const config = app.get(WhatsappConfigService);
+    if (config.getSwaggerAdvancedConfigEnabled()) {
+      builder.addServer('{protocol}://{host}:{port}/{baseUrl}', '', {
+        protocol: {
+          default: 'http',
+          enum: ['http', 'https'],
+          description: 'The protocol used to access the server.',
+        },
+        host: {
+          default: config.hostname,
+          description: 'The hostname or IP address of the server.',
+        },
+        port: {
+          default: config.port,
+          description:
+            'The port number on which the server is listening for requests',
+        },
+        baseUrl: {
+          default: '',
+          description:
+            'The base URL path for all API endpoints. This can be used to group related endpoints together under a common path.',
+        },
+      });
+    }
+
+    const options = builder.build();
+    const document = SwaggerModule.createDocument(app, options);
+    SwaggerModule.setup('', app, document, {
+      customSiteTitle: 'WAHA - WhatsApp HTTP API',
+    });
+  }
+
+  protected setUpAuth(app: INestApplication) {
+    return undefined;
+  }
+}

src/core/webhooks.core.ts

@@ -1,76 +1,107 @@
-import {WhatsappSession} from "./abc/session.abc";
-import {ConsoleLogger} from "@nestjs/common";
-import {WAEvents} from "../structures/enums.dto";
-import {WAWebhook} from "../structures/responses.dto";
-import {NotImplementedByEngineError} from "./exceptions";
-import {WebhookConductor} from "./abc/webhooks.abc";
+import { ConsoleLogger } from '@nestjs/common';
+
+import { WAHAEvents } from '../structures/enums.dto';
+import { WAWebhook } from '../structures/responses.dto';
+import { WebhookConfig } from '../structures/webhooks.dto';
+import { WhatsappSession } from './abc/session.abc';
+import { WebhookConductor, WebhookSender } from './abc/webhooks.abc';
+import { NotImplementedByEngineError } from './exceptions';
 import request = require('request');
 
+export class WebhookSenderCore extends WebhookSender {
+  send(json) {
+    this.log.log(`Sending POST to ${this.url}...`);
+    this.log.debug(`POST DATA: ${JSON.stringify(json)}`);
+
+    request.post(this.url, { json: json }, (error, res, body) => {
+      if (error) {
+        this.log.error(error);
+        return;
+      }
+      this.log.log(`POST request was sent with status code: ${res.statusCode}`);
+      this.log.verbose(`Response: ${JSON.stringify(body)}`);
+    });
+  }
+}
 
 export class WebhookConductorCore implements WebhookConductor {
-    constructor(protected log: ConsoleLogger, private readonly url, private readonly events: WAEvents[] | string[]) {
-        this.url = url
-        this.events = this.getSuitableEvents(events)
-        this.log = log
+  constructor(protected log: ConsoleLogger) {
+    this.log = log;
+  }
+
+  protected buildSender(webhookConfig: WebhookConfig): WebhookSender {
+    return new WebhookSenderCore(this.log, webhookConfig);
+  }
+
+  private getSuitableEvents(events: WAHAEvents[] | string[]): WAHAEvents[] {
+    const allEvents = Object.values(WAHAEvents);
+
+    // Enable all events if * in the events
+    // @ts-ignore
+    if (events.includes('*')) {
+      return allEvents;
     }
 
-    private getSuitableEvents(events: WAEvents[] | string[]) {
-        const allEvents = Object.values(WAEvents)
+    // Get only known events, log and ignore others
+    const rightEvents = [];
+    for (const event of events) {
+      // @ts-ignore
+      if (!allEvents.includes(event)) {
+        this.log.error(`Unknown event for webhook: '${event}'`);
+        continue;
+      }
+      rightEvents.push(event);
+    }
+    return rightEvents;
+  }
 
-        // Enable all events if * in the events
-        // @ts-ignore
-        if (events.includes("*")) {
-            return allEvents
+  public configure(session: WhatsappSession, webhooks: WebhookConfig[]) {
+    for (const webhookConfig of webhooks) {
+      this.configureSingleWebhook(session, webhookConfig);
+    }
+  }
+
+  private configureSingleWebhook(
+    session: WhatsappSession,
+    webhook: WebhookConfig,
+  ) {
+    if (!webhook || !webhook.url || webhook.events.length === 0) {
+      return;
+    }
+
+    const url = webhook.url;
+    this.log.log(`Configuring webhooks for ${url}...`);
+    const events = this.getSuitableEvents(webhook.events);
+    const sender = this.buildSender(webhook);
+    for (const event of events) {
+      try {
+        session.subscribe(event, (data: any) =>
+          this.callWebhook(event, session, data, sender),
+        );
+      } catch (error) {
+        if (error instanceof NotImplementedByEngineError) {
+          this.log.error(error);
+        } else {
+          throw error;
         }
-
-        // Get only known events, log and ignore others
-        const rightEvents = []
-        for (const event of events) {
-            // @ts-ignore
-            if (!allEvents.includes(event)) {
-                this.log.error(`Unknown event for webhook: '${event}'`)
-                continue
-            }
-            rightEvents.push(event)
-        }
-        return rightEvents
+      }
+      this.log.log(`Event '${event}' is enabled for url: ${url}`);
     }
+    this.log.log(`Webhooks were configured for ${url}.`);
+  }
 
-    public configure(session: WhatsappSession) {
-        this.log.log('Configuring webhooks...')
-        for (const event of this.events) {
-            try {
-                session.subscribe(event, (data: any) => this.callWebhook(event, data, this.url))
-            } catch (error) {
-                if (error instanceof NotImplementedByEngineError) {
-                    this.log.error(error)
-                } else {
-                    throw error
-                }
-            }
-            this.log.log(`Event '${event}' is enabled for url: ${this.url}`)
-        }
-        this.log.log('Webhooks were configured.')
-    }
-
-    public callWebhook(event, data: any, url) {
-        const json: WAWebhook = {event: event, payload: data}
-        this.log.log(`Sending POST to ${url}...`)
-        this.log.debug(`POST DATA: ${JSON.stringify(json)}`)
-        this.post(json, url)
-    }
-
-    protected post(json, url) {
-        request.post(
-            url,
-            {json: json},
-            (error, res, body) => {
-                if (error) {
-                    this.log.error(error)
-                    return
-                }
-                this.log.log(`POST request was sent with status code: ${res.statusCode}`)
-                this.log.verbose(`Response: ${JSON.stringify(body)}`)
-            })
-    }
+  public callWebhook(
+    event,
+    session: WhatsappSession,
+    data: any,
+    sender: WebhookSender,
+  ) {
+    const json: WAWebhook = {
+      event: event,
+      session: session.name,
+      payload: data,
+      engine: session.engine,
+    };
+    sender.send(json);
+  }
 }

src/helpers.ts

@@ -0,0 +1,28 @@
+function parseBool(value: any): boolean {
+  if (!value) {
+    return false;
+  }
+  if (value.toLowerCase() === 'true' || value.toLowerCase() === '1') {
+    return true;
+  }
+  if (value.toLowerCase() === 'false' || value.toLowerCase() === '0') {
+    return false;
+  }
+
+  console.error(
+    'parseBool got an unexpected value:',
+    value,
+    '(accepted values : "true", "false")',
+  );
+  throw new Error(
+    'Error: parseBool got unexpected value - use "true" or "false" values',
+  );
+}
+
+function flipObject(object) {
+  return Object.fromEntries(
+    Object.entries(object).map(([key, value]) => [value, key]),
+  );
+}
+
+export { flipObject, parseBool };

src/main.ts

@@ -1,54 +1,54 @@
-import {NestFactory} from '@nestjs/core';
-import {DocumentBuilder, SwaggerModule} from "@nestjs/swagger";
-import {WhatsappConfigService} from "./config.service";
-import {AllExceptionsFilter} from "./api/exception.filter";
-import {getWAHAVersion, VERSION, WAHAVersion} from "./version";
+import { NestFactory } from '@nestjs/core';
+import { json, urlencoded } from 'express';
 
-async function getAppModule() {
-    const version = getWAHAVersion()
-    console.log(`WAHA (WhatsApp HTTP API) - Running ${version} version...`)
+import { AllExceptionsFilter } from './api/exception.filter';
+import { WhatsappConfigService } from './config.service';
+import { AppModuleCore } from './core/app.module.core';
+import { SwaggerModuleCore } from './core/swagger.module.core';
+import { getWAHAVersion, WAHAVersion } from './version';
 
-    if (version === WAHAVersion.CORE) {
-        const {AppModuleCore} = await import("./core/app.module.core")
-        return AppModuleCore
-    }
-    // Ignore if it's core version - there's no plus module
-    // @ts-ignore
-    const {AppModulePlus} = await import("./plus/app.module.plus")
-    return AppModulePlus
+async function loadModules(): Promise<
+  [typeof AppModuleCore, typeof SwaggerModuleCore]
+> {
+  const version = getWAHAVersion();
+  console.log(`WAHA (WhatsApp HTTP API) - Running ${version} version...`);
+
+  if (version === WAHAVersion.CORE) {
+    const { AppModuleCore } = await import('./core/app.module.core');
+    const { SwaggerModuleCore } = await import('./core/swagger.module.core');
+    return [AppModuleCore, SwaggerModuleCore];
+  }
+  // Ignore if it's core version - there's no plus module
+  // @ts-ignore
+  const { AppModulePlus } = await import('./plus/app.module.plus');
+  // @ts-ignore
+  const { SwaggerModulePlus } = await import('./plus/swagger.module.plus');
+  return [AppModulePlus, SwaggerModulePlus];
 }
 
 async function bootstrap() {
-    const AppModule = await getAppModule()
-    const app = await NestFactory.create(AppModule, {
-        logger: process.env.DEBUG != undefined ? ['log', 'debug', 'error', 'verbose', 'warn'] :
-            ['log', 'error', 'warn'],
-    });
+  const [AppModule, SwaggerModule] = await loadModules();
+  const app = await NestFactory.create(AppModule, {
+    logger:
+      process.env.DEBUG != undefined
+        ? ['log', 'debug', 'error', 'verbose', 'warn']
+        : ['log', 'error', 'warn'],
+  });
 
-    app.enableShutdownHooks();
-    app.useGlobalFilters(new AllExceptionsFilter());
-    const options = new DocumentBuilder()
-        .setTitle('WAHA - WhatsApp HTTP API')
-        .setDescription('WhatsApp HTTP API that you can configure in a click!')
-        .setExternalDoc("Documentation", "https://waha.devlike.pro/")
-        .setVersion(VERSION.version)
-        .addTag('sessions', 'Control your WhatsApp sessions')
-        .addTag('screenshot', 'Get screenshot of WhatsApp and show QR code')
-        .addTag('chatting', 'Chat methods')
-        .addTag('other', 'Other endpoints')
-        .addApiKey({
-                type: 'apiKey',
-                description: 'Your secret api key',
-                name: 'X-Api-Key'
-            }
-        )
-        .build();
-    const document = SwaggerModule.createDocument(app, options);
-    SwaggerModule.setup('', app, document);
+  app.enableShutdownHooks();
+  app.useGlobalFilters(new AllExceptionsFilter());
 
-    const config = app.get(WhatsappConfigService);
-    await app.listen(config.port);
-    console.log(`WhatsApp HTTP API is running on: ${await app.getUrl()}`);
+  // Allow to send big body - for images and attachments
+  app.use(json({ limit: '50mb' }));
+  app.use(urlencoded({ limit: '50mb', extended: false }));
+
+  // Configure swagger
+  const swagger = new SwaggerModule();
+  swagger.configure(app);
+
+  const config = app.get(WhatsappConfigService);
+  await app.listen(config.port);
+  console.log(`WhatsApp HTTP API is running on: ${await app.getUrl()}`);
 }
 
 bootstrap();

src/structures/base.dto.ts

@@ -0,0 +1,19 @@
+import { IsNotEmpty } from 'class-validator';
+
+export const WHATSAPP_DEFAULT_SESSION_NAME = 'default';
+
+/**
+ * Queries
+ */
+export class SessionQuery {
+  @IsNotEmpty()
+  session: string = WHATSAPP_DEFAULT_SESSION_NAME;
+}
+
+/**
+ * Requests
+ */
+
+export class SessionBaseRequest {
+  session = WHATSAPP_DEFAULT_SESSION_NAME;
+}

src/structures/chatting.dto.ts

@@ -1,199 +1,231 @@
-import {IsNotEmpty, IsString} from "class-validator";
-import {ApiExtraModels, ApiProperty, getSchemaPath} from "@nestjs/swagger";
-
-export const WHATSAPP_DEFAULT_SESSION_NAME = "default"
+import { ApiExtraModels, ApiProperty, getSchemaPath } from '@nestjs/swagger';
+import { IsNumber, IsString } from 'class-validator';
 
+import { SessionBaseRequest, SessionQuery } from './base.dto';
 
 /**
  * Queries
  */
-export class SessionQuery {
-    @IsNotEmpty()
-    sessionName: string = WHATSAPP_DEFAULT_SESSION_NAME;
-}
-
 export class CheckNumberStatusQuery extends SessionQuery {
-    @IsString()
-    phone: string
+  @IsString()
+  phone: string;
 }
 
 export class MessageTextQuery extends SessionQuery {
-    @IsString()
-    phone: string
-    @IsString()
-    text = "Hi there!"
+  @IsString()
+  phone: string;
+  @IsString()
+  text: string;
 }
 
+export class ChatQuery extends SessionQuery {
+  @ApiProperty({
+    example: '11111111111@c.us',
+  })
+  chatId: string;
+}
+
+export class GetMessageQuery extends ChatQuery {
+  @IsNumber()
+  limit: number;
+}
+
+export class GetPresenceQuery extends ChatQuery {}
 
 /**
  * Requests
  */
-
-export class SessionBaseRequest {
-    session = WHATSAPP_DEFAULT_SESSION_NAME
-}
-
 export class ChatRequest extends SessionBaseRequest {
-    @ApiProperty({
-        example: '11111111111@c.us',
-    })
-    chatId: string
+  @ApiProperty({
+    example: '11111111111@c.us',
+  })
+  chatId: string;
 }
 
-export class MessageRequest extends SessionBaseRequest{
-    @ApiProperty({
-        example: "false_11111111111@c.us_AAAAAAAAAAAAAAAAAAAA",
-    })
-    messageId: string
+export class SendSeenRequest extends ChatRequest {
+  @ApiProperty({
+    example: 'false_11111111111@c.us_AAAAAAAAAAAAAAAAAAAA',
+    required: false,
+    description:
+      "NOWEB engine only - it's important to mark ALL messages as seen",
+  })
+  messageId?: string;
+
+  @ApiProperty({
+    example: '11111111111@c.us',
+    required: false,
+    description:
+      'NOWEB engine only - the ID of the user that sent the  message (undefined for individual chats)',
+  })
+  participant?: string;
+}
+
+export class MessageRequest extends SessionBaseRequest {
+  @ApiProperty({
+    example: 'false_11111111111@c.us_AAAAAAAAAAAAAAAAAAAA',
+  })
+  messageId: string;
 }
 
 export class MessageContactVcardRequest extends ChatRequest {
-    contactsId: string;
-    name: string
+  contactsId: string;
+  name: string;
 }
 
 export class MessageTextRequest extends ChatRequest {
-    text = "Hi there!"
+  text = 'Hi there!';
+  @ApiProperty({
+    description:
+      'Mention contact in the message. ' +
+      "The message MUST contain '@123456789' text in order to work with 'mentions' field.",
+    example: ['123456789@c.us'],
+  })
+  mentions?: string[];
 }
 
 export class Button {
-    id: string
-    body: string
+  id: string;
+  text: string;
 }
 
 export class MessageTextButtonsRequest extends ChatRequest {
-    title: string;
-    text: string;
-    buttons?: Array<Button>;
+  title: string;
+  footer?: string;
+  buttons?: Array<Button>;
 }
 
-export class MessageReplyRequest extends ChatRequest {
-    text = "Reply text"
-    @ApiProperty({
-        example: 'false_11111111111@c.us_AAAAAAAAAAAAAAAAAAAA',
-    })
-    reply_to: string;
+export class MessageReplyRequest extends MessageTextRequest {
+  text = 'Reply text';
+  @ApiProperty({
+    example: 'false_11111111111@c.us_AAAAAAAAAAAAAAAAAAAA',
+  })
+  reply_to: string;
 }
 
 export class MessageLocationRequest extends ChatRequest {
-    latitude: string;
-    longitude: string;
-    title: string;
+  latitude: number;
+  longitude: number;
+  title: string;
 }
 
 export class RemoteFile {
-    @ApiProperty({
-        description: "MIME type of the attachment.",
-        example: 'image/jpeg',
-    })
-    mimetype: string
+  @ApiProperty({
+    description: 'MIME type of the attachment.',
+    example: 'image/jpeg',
+  })
+  mimetype: string;
 
-    @ApiProperty({
-        description: "Document file name. Value can be null",
-        example: 'filename.jpg',
-    })
-    filename?: string | null
+  @ApiProperty({
+    description: 'Document file name. Value can be null',
+    example: 'filename.jpg',
+  })
+  filename?: string | null;
 
-    @ApiProperty({
-        example: 'https://github.com/devlikeapro/whatsapp-http-api/raw/core/examples/dev.likeapro.jpg',
-    })
-    url: string
+  @ApiProperty({
+    example:
+      'https://github.com/devlikeapro/whatsapp-http-api/raw/core/examples/dev.likeapro.jpg',
+  })
+  url: string;
 }
 
 export class BinaryFile {
-    @ApiProperty({
-        description: "MIME type of the attachment.",
-        example: 'image/jpeg',
-    })
-    mimetype: string
+  @ApiProperty({
+    description: 'MIME type of the attachment.',
+    example: 'image/jpeg',
+  })
+  mimetype: string;
 
-    @ApiProperty({
-        description: "Document file name. Optional",
-        example: 'filename.jpeg',
-    })
-    filename?: string | null
+  @ApiProperty({
+    description: 'Document file name. Optional',
+    example: 'filename.jpeg',
+  })
+  filename?: string | null;
 
-    @ApiProperty({
-        description: "Base64-encoded data of the file",
-        example: '/9j/4AAQSkZJRgABAQAAAQABAAD/4gIoSUNDX1BST0ZJTEUAAQEAAAIYAAAAAAQwAABtbnRyUkdCIFhZWiAAAAAAAAAAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAAHRyWFlaAAABZAAAABRnWFlaAAABeAAAABRiWFlaAAABjAAAABRyVFJDAAABoAAAAChnVFJDAAABoAAAAChiVFJDAAABoAAAACh3dHB0AAAByAAAABRjcHJ0AAAB3AAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAFgAAAAcAHMAUgBHAEIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFhZWiAAAAAAAABvogAAOPUAAAOQWFlaIAAAAAAAAGKZAAC3hQAAGNpYWVogAAAAAAAAJKAAAA+EAAC2z3BhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABYWVogAAAAAAAA9tYAAQAAAADTLW1sdWMAAAAAAAAAAQAAAAxlblVTAAAAIAAAABwARwBvAG8AZwBsAGUAIABJAG4AYwAuACAAMgAwADEANv/bAEMABgQFBgUEBgYFBgcHBggKEAoKCQkKFA4PDBAXFBgYFxQWFhodJR8aGyMcFhYgLCAjJicpKikZHy0wLSgwJSgpKP/bAEMBBwcHCggKEwoKEygaFhooKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKP/AABEIADAAyAMBIgACEQEDEQH/xAAbAAABBQEBAAAAAAAAAAAAAAAAAwQFBgcCAf/EADwQAAEDBAECAwQGBwkBAAAAAAECAwQABQYRIRIxB0FRExQiYRUlcXOBkQgnMjNCdbEWJENSdJKhssHh/8QAFAEBAAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AMg8UfEO755kUqVMlPJtocUIkILIbab3x8PYqI5JPO/lqqVuk90boFN0bpPdTrOLXR7DJGUobZ+iGJYhLWXR1h0gEDp76+Ic0ENujdJ7o3QKbo3Se6N0Etjh+v7f98mtT3WUY4fr+3/fJrU90Cm6N1INWOc7jj18Qlv6PZfEdaisdXWda+H05HNcSLNcY9njXV6KtFukrLbL5I6VqG9gc7/hPl5UDLdG6kLtZJ1qgWyZMS2li4tF6OUrCiUjXceXcVF7oFN0bpPdG6BTdG6T3RugU3Ruk90boFN0bpPdG6BTde7pLdG6C04Rl1wxe7sPx33DDKwJEYqJQ4jz48iB2NFVbdFBi26N0nuvCdgj1GqDX7PguKY/h1ryLxMuN0bVd0lyBa7WhPtlND/EWpXAB2DrjgjueBZr+jGW/wBGq7qw2Vc3rYu/NKUm5NpQ60vpRtJKeFDWjv5/Ko7x8t0y+454e5HZ4z8q0LsbUQrYbK0tOo7pVrseSPtSfSvHLLc7N+ipc0XaBIhOSb62+yiQgoUtspQArR50SD39KCFRh2IYjYbVO8SJ13Xc7qwJUe02kNpW0wf2VurXwCeeB6efOvL9hOKi1WLLLBdLk9hky4JgT0yEoEuAvudkDpV8PPb07740zxhyq8xoOO5HjmO2G8Y7PtrPTLkWpMpbLg3ttau6QPIHz6h5VlmXZhmN88PnY8/HbfbcZXLbUp2JbPdULe0ekA70o6Sd6B4FBB+LOHnBM3m2ZDrj8NKUPxX1626yobB44JB6gdelPPEPDYWH45ihekyV5DdYnv0uMrp9nHaV+7AGt9R89n+E1q2LY+14xYdgdwlLQZWOy/o28KWoAqhoHtEqO/klKftWr0rFvFfKzmef3e8pJ92dd9nFT5JYR8KBry2Bv7SaCHxw/X9v++TWqbrJ8cP1/b/vk1qm6DRref1GXb+cN/0RURdLMY3h5Y7x9Iznfe5LrXujjm2Gukq+JCfInXP2mpS3H9RV2/nDf/VFGQH9SuKf6+R/VygcZ5HfmYx4dxojS3pD0AobbQNqUo9GgBUBltkteNssW1ya7LyXQXLaYKSxFB7IJ1tS+3AP/m9GXl9uxPHsCenW1x/3i3Kacmtr05EaISFFseatlJ9dJNZxlWNKxK7Q5zbxuNllOJlRZwPX7wnqCiFHzXrv69/XQSM+z4riYjxcwk3WTeXWkvOQ7aEARUq5AWpXdWvIf/TH5bYIMK12y949MdmWW5BYaL6Ql1pxPdtYHG+D+R+03vxUv97t99FwtVmsVwsk9lt6NOdt4fUv4RsKWPP035EVTrjdciv8Ozw8gt8K12F2ehLbkaH7uOtXCiN9/hUTvWt0HKJXhnHbQ1IlZNKf6R1usNIShKtc6BAJG6a5xjjOPy4DlvmGba7jHTKiPKT0qKD5KHqNj86t2a3e/YrlDthw6ww4ENgISw6IHt3ZO0glXUQd8kj145pDxqXPVGw5V4HTcjbyZI6QnTm0dXA4HPkKDjKccwbD7yIt8u93lKW0lxMSGykuoBH7S16CdHyA54qCzjHINrttsvePTXJtiuSFFlbqdONrT3Qrt6H8iKmvHKBMXnftm4clTbkRhKVoZUQogHYBA5pLNWl2Lwoxyx3BJaub7709TCuFtNnqA6h5b6h/z6UC+RYdiuNuwXb5kj8aPJioeTGba9rJWo9yABpKO2iRyd1GWrG7FKYvF+kXSU1iMBxLbb/sv7xJWQNISkjg7Ou3mPmQ58bgn6fsqtDq+h443+KqVtDSr34KXCBbkKem225pmPMoG1ltSeFADv3P+00DeLYsYyqFP/sXJurN1hMmQYNySnb7Y7lCk+fbj5j13VDCtjYrRPBWM7CyCZf5ra2bXbYTyn33ElKdkD4dnueCdfKs4UvqUVa6eo716b8qDvdFJ7ooMW3Rurt4seHF5wDI5caZEeVay4oxJoQS263v4fi7BQHBB538tGqJ1UFzw/xKy7DobkTHL5IhxHFFRZ6UOICj3ISsEJP2U1vWeZPe7fKg3e+TZsSU+JLzby+oKcAAB7caAGgNDjtVW6qOqgtuI+IOVYe2tvHL5LhMrV1KZSQtsn16FAjfz1XmXeIGU5g2hvJL5LnMoV1pZUQlsK9ehICd8nnXnVT6qOqgnrFlV7sEK5Q7Nc5EONcW/ZS22lAB1OiNH8FKHHrUNukuqjqoJbHD9fQPvk1qnVWUY2fr6B98mtS3QP0XW4otq7Yia4m2OOB5cUAdKnBrSvXfA/Kh263F63sW56a4u3R1FbMYgdLajvZHnzs/nTHdG6B9LulwnR4sedNckR4iPZxm1gaZRx8I19g7+ldM3i6M2hdobnu/RCle09zUApCVb3tOxtPPPHz9aj90boJyw5bkmOslixXuRFjEkiOoJcbST30lQOvwpvesgvV/WF3+6yZ+t9KHCAhG+/SkaAqL3RugszOfZmxbU29nJJaYqU9CT0pLqU+gc11fjvdREy7XK4oit3Oe/MRFT7Nj2xBLaOON9z2HJphujdBq3iZ4gXmNl7pxHJvq5UZkaYKHmgvR6tbBAPbeqzKbMl3CW7Luct6bMe/ePPK6lK9B8h8hTRAShOkAJHoK63QP7jdbjdXW3btNcmOtNhptTgAKUDska8hs1zbLncLRORNs05+DMQOkOtHun/KodiPkaZbo3QTt/wAvyXI2UsX68vSoySFewSlLbaiOxUEgb/GobqpPdG6BTqoqyYFh9xy28x48aO6IQWDIklJCG0b5581EcACig//Z',
-    })
-    data: string
+  @ApiProperty({
+    description: 'Base64-encoded data of the file',
+    example:
+      '/9j/4AAQSkZJRgABAQAAAQABAAD/4gIoSUNDX1BST0ZJTEUAAQEAAAIYAAAAAAQwAABtbnRyUkdCIFhZWiAAAAAAAAAAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAAHRyWFlaAAABZAAAABRnWFlaAAABeAAAABRiWFlaAAABjAAAABRyVFJDAAABoAAAAChnVFJDAAABoAAAAChiVFJDAAABoAAAACh3dHB0AAAByAAAABRjcHJ0AAAB3AAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAFgAAAAcAHMAUgBHAEIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFhZWiAAAAAAAABvogAAOPUAAAOQWFlaIAAAAAAAAGKZAAC3hQAAGNpYWVogAAAAAAAAJKAAAA+EAAC2z3BhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABYWVogAAAAAAAA9tYAAQAAAADTLW1sdWMAAAAAAAAAAQAAAAxlblVTAAAAIAAAABwARwBvAG8AZwBsAGUAIABJAG4AYwAuACAAMgAwADEANv/bAEMABgQFBgUEBgYFBgcHBggKEAoKCQkKFA4PDBAXFBgYFxQWFhodJR8aGyMcFhYgLCAjJicpKikZHy0wLSgwJSgpKP/bAEMBBwcHCggKEwoKEygaFhooKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKP/AABEIADAAyAMBIgACEQEDEQH/xAAbAAABBQEBAAAAAAAAAAAAAAAAAwQFBgcCAf/EADwQAAEDBAECAwQGBwkBAAAAAAECAwQABQYRIRIxB0FRExQiYRUlcXOBkQgnMjNCdbEWJENSdJKhssHh/8QAFAEBAAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AMg8UfEO755kUqVMlPJtocUIkILIbab3x8PYqI5JPO/lqqVuk90boFN0bpPdTrOLXR7DJGUobZ+iGJYhLWXR1h0gEDp76+Ic0ENujdJ7o3QKbo3Se6N0Etjh+v7f98mtT3WUY4fr+3/fJrU90Cm6N1INWOc7jj18Qlv6PZfEdaisdXWda+H05HNcSLNcY9njXV6KtFukrLbL5I6VqG9gc7/hPl5UDLdG6kLtZJ1qgWyZMS2li4tF6OUrCiUjXceXcVF7oFN0bpPdG6BTdG6T3RugU3Ruk90boFN0bpPdG6BTde7pLdG6C04Rl1wxe7sPx33DDKwJEYqJQ4jz48iB2NFVbdFBi26N0nuvCdgj1GqDX7PguKY/h1ryLxMuN0bVd0lyBa7WhPtlND/EWpXAB2DrjgjueBZr+jGW/wBGq7qw2Vc3rYu/NKUm5NpQ60vpRtJKeFDWjv5/Ko7x8t0y+454e5HZ4z8q0LsbUQrYbK0tOo7pVrseSPtSfSvHLLc7N+ipc0XaBIhOSb62+yiQgoUtspQArR50SD39KCFRh2IYjYbVO8SJ13Xc7qwJUe02kNpW0wf2VurXwCeeB6efOvL9hOKi1WLLLBdLk9hky4JgT0yEoEuAvudkDpV8PPb07740zxhyq8xoOO5HjmO2G8Y7PtrPTLkWpMpbLg3ttau6QPIHz6h5VlmXZhmN88PnY8/HbfbcZXLbUp2JbPdULe0ekA70o6Sd6B4FBB+LOHnBM3m2ZDrj8NKUPxX1626yobB44JB6gdelPPEPDYWH45ihekyV5DdYnv0uMrp9nHaV+7AGt9R89n+E1q2LY+14xYdgdwlLQZWOy/o28KWoAqhoHtEqO/klKftWr0rFvFfKzmef3e8pJ92dd9nFT5JYR8KBry2Bv7SaCHxw/X9v++TWqbrJ8cP1/b/vk1qm6DRref1GXb+cN/0RURdLMY3h5Y7x9Iznfe5LrXujjm2Gukq+JCfInXP2mpS3H9RV2/nDf/VFGQH9SuKf6+R/VygcZ5HfmYx4dxojS3pD0AobbQNqUo9GgBUBltkteNssW1ya7LyXQXLaYKSxFB7IJ1tS+3AP/m9GXl9uxPHsCenW1x/3i3Kacmtr05EaISFFseatlJ9dJNZxlWNKxK7Q5zbxuNllOJlRZwPX7wnqCiFHzXrv69/XQSM+z4riYjxcwk3WTeXWkvOQ7aEARUq5AWpXdWvIf/TH5bYIMK12y949MdmWW5BYaL6Ql1pxPdtYHG+D+R+03vxUv97t99FwtVmsVwsk9lt6NOdt4fUv4RsKWPP035EVTrjdciv8Ozw8gt8K12F2ehLbkaH7uOtXCiN9/hUTvWt0HKJXhnHbQ1IlZNKf6R1usNIShKtc6BAJG6a5xjjOPy4DlvmGba7jHTKiPKT0qKD5KHqNj86t2a3e/YrlDthw6ww4ENgISw6IHt3ZO0glXUQd8kj145pDxqXPVGw5V4HTcjbyZI6QnTm0dXA4HPkKDjKccwbD7yIt8u93lKW0lxMSGykuoBH7S16CdHyA54qCzjHINrttsvePTXJtiuSFFlbqdONrT3Qrt6H8iKmvHKBMXnftm4clTbkRhKVoZUQogHYBA5pLNWl2Lwoxyx3BJaub7709TCuFtNnqA6h5b6h/z6UC+RYdiuNuwXb5kj8aPJioeTGba9rJWo9yABpKO2iRyd1GWrG7FKYvF+kXSU1iMBxLbb/sv7xJWQNISkjg7Ou3mPmQ58bgn6fsqtDq+h443+KqVtDSr34KXCBbkKem225pmPMoG1ltSeFADv3P+00DeLYsYyqFP/sXJurN1hMmQYNySnb7Y7lCk+fbj5j13VDCtjYrRPBWM7CyCZf5ra2bXbYTyn33ElKdkD4dnueCdfKs4UvqUVa6eo716b8qDvdFJ7ooMW3Rurt4seHF5wDI5caZEeVay4oxJoQS263v4fi7BQHBB538tGqJ1UFzw/xKy7DobkTHL5IhxHFFRZ6UOICj3ISsEJP2U1vWeZPe7fKg3e+TZsSU+JLzby+oKcAAB7caAGgNDjtVW6qOqgtuI+IOVYe2tvHL5LhMrV1KZSQtsn16FAjfz1XmXeIGU5g2hvJL5LnMoV1pZUQlsK9ehICd8nnXnVT6qOqgnrFlV7sEK5Q7Nc5EONcW/ZS22lAB1OiNH8FKHHrUNukuqjqoJbHD9fQPvk1qnVWUY2fr6B98mtS3QP0XW4otq7Yia4m2OOB5cUAdKnBrSvXfA/Kh263F63sW56a4u3R1FbMYgdLajvZHnzs/nTHdG6B9LulwnR4sedNckR4iPZxm1gaZRx8I19g7+ldM3i6M2hdobnu/RCle09zUApCVb3tOxtPPPHz9aj90boJyw5bkmOslixXuRFjEkiOoJcbST30lQOvwpvesgvV/WF3+6yZ+t9KHCAhG+/SkaAqL3RugszOfZmxbU29nJJaYqU9CT0pLqU+gc11fjvdREy7XK4oit3Oe/MRFT7Nj2xBLaOON9z2HJphujdBq3iZ4gXmNl7pxHJvq5UZkaYKHmgvR6tbBAPbeqzKbMl3CW7Luct6bMe/ePPK6lK9B8h8hTRAShOkAJHoK63QP7jdbjdXW3btNcmOtNhptTgAKUDska8hs1zbLncLRORNs05+DMQOkOtHun/KodiPkaZbo3QTt/wAvyXI2UsX68vSoySFewSlLbaiOxUEgb/GobqpPdG6BTqoqyYFh9xy28x48aO6IQWDIklJCG0b5581EcACig//Z',
+  })
+  data: string;
 }
 
 @ApiExtraModels(BinaryFile, RemoteFile)
 class FileRequest extends ChatRequest {
-    @ApiProperty({
-        oneOf: [
-            {$ref: getSchemaPath(BinaryFile)},
-            {$ref: getSchemaPath(RemoteFile)},
-        ],
-    })
-    file: BinaryFile | RemoteFile
+  @ApiProperty({
+    oneOf: [
+      { $ref: getSchemaPath(BinaryFile) },
+      { $ref: getSchemaPath(RemoteFile) },
+    ],
+  })
+  file: BinaryFile | RemoteFile;
 }
 
 export class MessageImageRequest extends FileRequest {
-    caption: string;
+  caption: string;
 }
 
 export class MessageFileRequest extends FileRequest {
+  caption: string;
 }
 
 export class VoiceBinaryFile {
-    @ApiProperty({
-        description: "MIME type of the attachment.",
-    })
-    mimetype = "audio/ogg; codecs=opus"
+  @ApiProperty({
+    description: 'MIME type of the attachment.',
+  })
+  mimetype = 'audio/ogg; codecs=opus';
 
-    @ApiProperty({
-        description: "Document file name. Optional",
-    })
-    filename = "voice-message.mp3"
+  @ApiProperty({
+    description: 'Document file name. Optional',
+  })
+  filename = 'voice-message.mp3';
 
-    @ApiProperty({
-        description: "Base64-encoded data of the file",
-        example: 'SUQzBAAAAAAAI1RTU0UAAAAPAAADTGF2ZjU4Ljc2LjEwMAAAAAAAAAAAAAAA//NkxAAW0D4AVN4YAAYAKqTsSE2Z0IlkQMKANEGBUWH7a99t8eFgGQqfrfJxAsocfid8uizPyg535NQgTSs/z6xwJlJc/XKOE8uQtJsTP7ym4u/ky78nQzJw+t+4TvEiw/UftU4TymUVBiqj2qVLlF8X+bWGBLTBZi2+uOml4gA4HEVKHj2Fw89os529yuxD//NkxCcUAGI0FOJGKNWEHAhP3y5/+LZc5OU6X9RI+9M5IZc/fOaJf5y6cTjSBfLxrzjCnoSUCNUgnzokmHoBlzC6CGSrXGjEOPedHzBCkYcOBBpTTNe9/8tGfO5M4inBdS7PsvVusm91LKv4Ycftpwq4YATDG98/QyhKd3V7mZn7wZb2yrt3Y0fiGYpP4aUa//NkxFokCoIwNOpMRV7E1Kqm9vJ123c1F9bGVSKnasqqcezN/4ar26Uz3P8M/AgXq/+6ctsqX+fW6UmfCJ79o9g/CqpFrrpE78sS2V8ApIpklEE02r9II4IDbdNNnFC4dREiIgJFHHcOZjvE9lBMgBQUZzqdOmMDc97ku5pyFwNDph6+LaOyjKaRA6x4x2sc//NkxEwZkcZIVNpGCBophiL5tglY4Lj3qeQceTdr6ur/R11nlO/6KuHORu5SCMucIAApqsZ1I2CBCFxtWZ1tzE3pcvJD87eocViSFHDFuRXMs+q62dVX4O2GtELkoUrIfEbh7506+CEA0VUxhsBLvWABIfGtS8OCcALHMrWskk2pbXJuOEheYHvtaFW9arRY//NkxGgc+ZY8COJGVJsJX1dZg8q3QVzqEQCJapAB18VGV0Kcf+J8F8mNnEbyRRigCGBwCm4AQGjWWcBwIbSN5OhOjQgmU8f6ry3stZNsXzEDM1r44o0zCIuyJMgAejNzadpOkuIVTwXA/BS9ep5F8IvMiz9tM16cuR2SKoggy2MZQtg8BNAidnuNVpsFLpx5//NkxHcgEjJFdOGGtCyrFeW67L62epUITeB47MPJE/N7DOhVOlzQ3shzlhFM2gkw2MBQ0zxwHeTFmAKsdmTYnkf6VQlp4GCOOLPWCLF3sYHocCoKThOYp41Wo93UtOhKLnDyelr+f407RfQ0loWe5+a43SqraakgBnwG4POuQSELhVgoHwVB0OoeCgYj442U//NkxHkjKbZIyuZQTO/HTN86uNWKDHSjaBJ/RdqIU9N6adPSJcjBpAjd5ZQMRpirXYsZphSRhl2BiwAD9ZAHGGWBEzHAU3Ws11wH6d2fdF/sqG9P8pbEqpa2MNUcah+aizKGY8v4+WWNtiSTbbMmyf3K+U5Rez8xte6f9ZqzAIjDxVp4AEmjlm3KWLyoJw1r//NkxG8kSXpQMu5MWDLiYSGiEC1DUiwsLihhGVbL4DpupqbFV9eMCtpMfeuq2rdVeZVjIMHTE8nDqsWwcQxmk3BgCBxhAbhgGDBVBEP6XAIhRMwmTmYYwZ247Uc+cECwUeim6NFyz5cgE0SixFn+fd5Sb0kClO5up2jHtvXhqfSgK48ZRY+xgCaKhmJRI9lr//NkxGAhIT5UFO4MTFtqa6x7kuCp0aq5TakV0uFEJq1b3N9XYzKlRXJPaSjSxK16nqUZU4nVxqUFGJXeenWhgstGlJWAiyYfWYQCQYElQINEwKcFLFqIG1Zg8UvWrXmn1urARzCgoBTosSTkRcfBUVbsDXM62KmDEAkBJIYuNDHnGAAaYAyAwGwK6dYB7GPQ//NkxF4e4R5YXOMGiLWuWmL28y2xduEEPX16UzKUPFHrolYu8zXv879xhWqbVph6jGInGdqQwcFDlqOMrjUxIck9jAYAaslNTOm3mOyEoAq0pPsjKCa8QSZV7WmomOiijP1smCamch4MWEIfTcdiD/8MysS3MIj1h6NBhMoXeaAARIGjNLI4WOMDQOLS4+kR//NkxGUgaXZYVOGGlIXFBZoDP07hI3oN61pXNfrczNjykgKtFEu64tDaAKkkkkkkkiuSIFcvY9AuCM1psOiZD1e2RL5UFGSfVFOxKiSZcOB/rRbEIby4QS/l7HwSQ50PdnO5vF8uaYLg9T7o/0LGAVoE+AnnUhEqHqN+2EiZOousyjbkKCoGzIXFQGBGBcEg//NkxGY11Dq1vnpNhsAoeI90gZTMogfZUtHJiDaiLhMLEIFjgi/rrIXF+zNMlMwtIAFwQc+pTaGwtePD6+tl7j0comzEIh1EyQYLbHpcQ5SF7kZd1NIWQyNQKRC9JnDD6UFiJIGrIKBzkPl2Uq4cmamQz7+7tOxl7FtEH0h06g4OqqDJTBgSqEvrWRlEECjC//NkxBEhKYKUANPSnD4CG3gCwLkHoBMqTKUaUkraqCzctWV+m1bkb8u0ouTmawYa28AxqoQtKHeXrBv5cEpBP6IK/CcgM8Ey2hPrVRHqMT4cYXQFwbZAcIhcmTBOaMnhVz81zINiN///8sMPC3/7n/+qticPkhrRgq5w0OPcxplVBAMcSK16xyfBu6V5E4VO//NkxA8fQe7SVnsE3sqlEuhK9fjDZLxzi6SLBUEewl/scsTkeqdE9uFRUHGoaSs6r+2lvfUOiQ9kXdOx7B+1x2jPQvKC7RPl2PzZ7uzXe1f/5SkZoy2lzQ2FA6cWKCptRB0u3/6Vf+0SoKiglKox7AQEgJh8ISADd6fuBIAUaKk9cslsqjVbKmbz0PPY5Q1+//NkxBUfIaK01sPSlh5ZFGEiMvdwnWn2oMTLJTM2J8t0RhfRR2tLEUkrDGLOos4rOIYcCqAiKoiuom7r2xebLJIlTx44fjk7d8n83YRe957vMH/cwSKL6Ey973mSpMgGTlosv1ecaUut/hE0ILvvGRox6nk1AL2mPfUBUZaSvgWZbhpRdzWxrQ2qsfS4Qmi6//NkxBsgWWKwFsPMnLLjPbZm/+Hp/Fw44c4jYeLAJohxuQaL0ZST7Y3rG5bVb0kahY09mDWHbJTQ7lcxyAsgLkCImGpSeLFqjKWO+szt1WrMpSDqwjc80JbaLzItpImQmNBnf/t1/SBQZHiEsLNJUhlwbQoEgDWNNauCKdiupuITWqBhmGTVEDhJolUxTqPG//NkxBwc4Wq81nsMlh7aUSRnfU3mOSHKcXHggNr2WWu5xRtopJoCBLrRrL1WX2xrcpnD6LkCyUmR0yUWoJjCR77Sw9mBXULCT54Yu0Xrdb/hVS0I3/mTSw7/w6GyoBSMHjLXpqqgkAv1krkkRYNGdtnWV3uRCZjY3Di3rqbqSNhlzSWI00OhwAAcQvlyZaGo//NkxCsdK+rM9njE+zCBnEkZT8iKUmbJBEcUCMSNAxxiWZoqSN//tlV5mb7aKrPeulvuyohyLP////rv03ns6IrqtNN6p3LrKhFRn0akUwsm8ZkkyhudZqIlO/a1dASkgCFg25A5g4wH3DYgeONWRWR5F0rSuv35UUCWGdFkme7Wioowdlp+tKTOglxQIdDs//NkxDkcgZ7U/lmEllYr/sU44cWEhi+sCpF31D0rAKFKjD0tGAkIsfWlkkkieDodcZLB37qXxcNOSQIHaGhVNV6qqhR1SlSSUm1lRiYWROH6A2xUkPSoFND1ytKPu+bBqK93TKimC1i0iELlCdh2brUzdCKYEJBmO22uLhva2uLZ3EQvGqNqW2+KiYpnIZqf//NkxEodEoLEXmIE3uFdKU1ft6UWWu/NtOV2MFJBARFv915Fwi//ijKZ5QPtahDwbPvMOOPta9UJJad1sibIEcAnXUzOin78wDRaiSuCjubzcE4XF3jy82iLCgZdHNdXe0NttCoCkSCqQUsqtTX1rrQ0VUezN/9/F8WRyxaMdBFmkPGnrCA4XUpoG/xKGlVK//NkxFgdUa6w3nmQkoUGufspBpZEMpRb92LyRGYOuPLBUNETxFC+eZYI1QBiWo7bv9cbC4RBNgU2ZOzJlF2I6hncW0XFxQq5joOD4qV1k0mFqK+c0awzlTSR0s1t3Fwl6uZIKmCg7bWIdsjgSDKRpnRGr8vcxrIbKzUVl7316SOkxjs9CJen///Npyf///f///NkxGUc4869vkoEv/MjM0zQT+PLHf03+FAppQiO26Si0wExQTgQZNKKhYVXL/KdqhblIpuWqJEkZJao2zpmnQJzwo/KzF2SsevxgrWgg8ogPCHJC+ZGYI2ADMGCNweE3kigIuDQFGDEH4qBwcUYUz+bXbe4AMoPu/7s24QUHaPJvozFL7kkmPLhgUeLCPpU//NkxHQdQYKAPsmGkBUB40UDw1eB2YYqrAq9/o+y1xKjtHtsXBr0nSf2Vwmm+QRJlXz1m1IVzyOFGEgDDGZVaz3eRW2U4RFBamZ93qsjBtD5znsr2aIZnVX2RKpDvajaEnvzn37TvfX9f/faT/t///8i6rX3INPKHWGrJkprEf6xqTGg6UAvtPBqpnPTuNw1//NkxIIcA758FspEWAuYStUOFnAwRayKry+iKyESNAqfXOu5qY5aIXsruZdM/Z6b1jIKxB4uh2+ai4eSFYcK4fVqaeiZnNyp575zQoX5/c34fn8L/0fInJ48l+F09KZX4/8eN+rndzx47njOiPmj3Nd6SOQRWBYTMnDxEcIuFllGECkpxosYIVIcSiVJ51w+//NkxJUf9DqIFMGGMBolGBvMSYphcBJDXSmhMFFUsV27MeGBQHxCBzaaMCtwETeeCALA0JwkK1nBt2pRB7HrBckAWrpF4kJn0LYWQwa0URuPUN5l7LLlrWrvMhMuPBVwCCIFDLUqLslhZQTOEZoFjKZSQq07QHBQoX0DkWRTrgWmFVJSeW5NkVpKKXrclWbD//NkxJgcYPqSNoGGDBXTKSmTqRYo2Geff0vxs/Ve9dGEwGFWSYiWdaxBoqdDLZ+WPRaFSICcLmgghZVzUDgKz1IZYOfD3YlyEq1PNCo0XEoCUwGh0Ep0TLyRY
Line truncated
-    })
-    data: string
+  @ApiProperty({
+    description: 'Base64-encoded data of the file',
+    example:
+      'SUQzBAAAAAAAI1RTU0UAAAAPAAADTGF2ZjU4Ljc2LjEwMAAAAAAAAAAAAAAA//NkxAAW0D4AVN4YAAYAKqTsSE2Z0IlkQMKANEGBUWH7a99t8eFgGQqfrfJxAsocfid8uizPyg535NQgTSs/z6xwJlJc/XKOE8uQtJsTP7ym4u/ky78nQzJw+t+4TvEiw/UftU4TymUVBiqj2qVLlF8X+bWGBLTBZi2+uOml4gA4HEVKHj2Fw89os529yuxD//NkxCcUAGI0FOJGKNWEHAhP3y5/+LZc5OU6X9RI+9M5IZc/fOaJf5y6cTjSBfLxrzjCnoSUCNUgnzokmHoBlzC6CGSrXGjEOPedHzBCkYcOBBpTTNe9/8tGfO5M4inBdS7PsvVusm91LKv4Ycftpwq4YATDG98/QyhKd3V7mZn7wZb2yrt3Y0fiGYpP4aUa//NkxFokCoIwNOpMRV7E1Kqm9vJ123c1F9bGVSKnasqqcezN/4ar26Uz3P8M/AgXq/+6ctsqX+fW6UmfCJ79o9g/CqpFrrpE78sS2V8ApIpklEE02r9II4IDbdNNnFC4dREiIgJFHHcOZjvE9lBMgBQUZzqdOmMDc97ku5pyFwNDph6+LaOyjKaRA6x4x2sc//NkxEwZkcZIVNpGCBophiL5tglY4Lj3qeQceTdr6ur/R11nlO/6KuHORu5SCMucIAApqsZ1I2CBCFxtWZ1tzE3pcvJD87eocViSFHDFuRXMs+q62dVX4O2GtELkoUrIfEbh7506+CEA0VUxhsBLvWABIfGtS8OCcALHMrWskk2pbXJuOEheYHvtaFW9arRY//NkxGgc+ZY8COJGVJsJX1dZg8q3QVzqEQCJapAB18VGV0Kcf+J8F8mNnEbyRRigCGBwCm4AQGjWWcBwIbSN5OhOjQgmU8f6ry3stZNsXzEDM1r44o0zCIuyJMgAejNzadpOkuIVTwXA/BS9ep5F8IvMiz9tM16cuR2SKoggy2MZQtg8BNAidnuNVpsFLpx5//NkxHcgEjJFdOGGtCyrFeW67L62epUITeB47MPJE/N7DOhVOlzQ3shzlhFM2gkw2MBQ0zxwHeTFmAKsdmTYnkf6VQlp4GCOOLPWCLF3sYHocCoKThOYp41Wo93UtOhKLnDyelr+f407RfQ0loWe5+a43SqraakgBnwG4POuQSELhVgoHwVB0OoeCgYj442U//NkxHkjKbZIyuZQTO/HTN86uNWKDHSjaBJ/RdqIU9N6adPSJcjBpAjd5ZQMRpirXYsZphSRhl2BiwAD9ZAHGGWBEzHAU3Ws11wH6d2fdF/sqG9P8pbEqpa2MNUcah+aizKGY8v4+WWNtiSTbbMmyf3K+U5Rez8xte6f9ZqzAIjDxVp4AEmjlm3KWLyoJw1r//NkxG8kSXpQMu5MWDLiYSGiEC1DUiwsLihhGVbL4DpupqbFV9eMCtpMfeuq2rdVeZVjIMHTE8nDqsWwcQxmk3BgCBxhAbhgGDBVBEP6XAIhRMwmTmYYwZ247Uc+cECwUeim6NFyz5cgE0SixFn+fd5Sb0kClO5up2jHtvXhqfSgK48ZRY+xgCaKhmJRI9lr//NkxGAhIT5UFO4MTFtqa6x7kuCp0aq5TakV0uFEJq1b3N9XYzKlRXJPaSjSxK16nqUZU4nVxqUFGJXeenWhgstGlJWAiyYfWYQCQYElQINEwKcFLFqIG1Zg8UvWrXmn1urARzCgoBTosSTkRcfBUVbsDXM62KmDEAkBJIYuNDHnGAAaYAyAwGwK6dYB7GPQ//NkxF4e4R5YXOMGiLWuWmL28y2xduEEPX16UzKUPFHrolYu8zXv879xhWqbVph6jGInGdqQwcFDlqOMrjUxIck9jAYAaslNTOm3mOyEoAq0pPsjKCa8QSZV7WmomOiijP1smCamch4MWEIfTcdiD/8MysS3MIj1h6NBhMoXeaAARIGjNLI4WOMDQOLS4+kR//NkxGUgaXZYVOGGlIXFBZoDP07hI3oN61pXNfrczNjykgKtFEu64tDaAKkkkkkkkiuSIFcvY9AuCM1psOiZD1e2RL5UFGSfVFOxKiSZcOB/rRbEIby4QS/l7HwSQ50PdnO5vF8uaYLg9T7o/0LGAVoE+AnnUhEqHqN+2EiZOousyjbkKCoGzIXFQGBGBcEg//NkxGY11Dq1vnpNhsAoeI90gZTMogfZUtHJiDaiLhMLEIFjgi/rrIXF+zNMlMwtIAFwQc+pTaGwtePD6+tl7j0comzEIh1EyQYLbHpcQ5SF7kZd1NIWQyNQKRC9JnDD6UFiJIGrIKBzkPl2Uq4cmamQz7+7tOxl7FtEH0h06g4OqqDJTBgSqEvrWRlEECjC//NkxBEhKYKUANPSnD4CG3gCwLkHoBMqTKUaUkraqCzctWV+m1bkb8u0ouTmawYa28AxqoQtKHeXrBv5cEpBP6IK/CcgM8Ey2hPrVRHqMT4cYXQFwbZAcIhcmTBOaMnhVz81zINiN///8sMPC3/7n/+qticPkhrRgq5w0OPcxplVBAMcSK16xyfBu6V5E4VO//NkxA8fQe7SVnsE3sqlEuhK9fjDZLxzi6SLBUEewl/scsTkeqdE9uFRUHGoaSs6r+2lvfUOiQ9kXdOx7B+1x2jPQvKC7RPl2PzZ7uzXe1f/5SkZoy2lzQ2FA6cWKCptRB0u3/6Vf+0SoKiglKox7AQEgJh8ISADd6fuBIAUaKk9cslsqjVbKmbz0PPY5Q1+//NkxBUfIaK01sPSlh5ZFGEiMvdwnWn2oMTLJTM2J8t0RhfRR2tLEUkrDGLOos4rOIYcCqAiKoiuom7r2xebLJIlTx44fjk7d8n83YRe957vMH/cwSKL6Ey973mSpMgGTlosv1ecaUut/hE0ILvvGRox6nk1AL2mPfUBUZaSvgWZbhpRdzWxrQ2qsfS4Qmi6//NkxBsgWWKwFsPMnLLjPbZm/+Hp/Fw44c4jYeLAJohxuQaL0ZST7Y3rG5bVb0kahY09mDWHbJTQ7lcxyAsgLkCImGpSeLFqjKWO+szt1WrMpSDqwjc80JbaLzItpImQmNBnf/t1/SBQZHiEsLNJUhlwbQoEgDWNNauCKdiupuITWqBhmGTVEDhJolUxTqPG//NkxBwc4Wq81nsMlh7aUSRnfU3mOSHKcXHggNr2WWu5xRtopJoCBLrRrL1WX2xrcpnD6LkCyUmR0yUWoJjCR77Sw9mBXULCT54Yu0Xrdb/hVS0I3/mTSw7/w6GyoBSMHjLXpqqgkAv1krkkRYNGdtnWV3uRCZjY3Di3rqbqSNhlzSWI00OhwAAcQvlyZaGo//NkxCsdK+rM9njE+zCBnEkZT8iKUmbJBEcUCMSNAxxiWZoqSN//tlV5mb7aKrPeulvuyohyLP////rv03ns6IrqtNN6p3LrKhFRn0akUwsm8ZkkyhudZqIlO/a1dASkgCFg25A5g4wH3DYgeONWRWR5F0rSuv35UUCWGdFkme7Wioowdlp+tKTOglxQIdDs//NkxDkcgZ7U/lmEllYr/sU44cWEhi+sCpF31D0rAKFKjD0tGAkIsfWlkkkieDodcZLB37qXxcNOSQIHaGhVNV6qqhR1SlSSUm1lRiYWROH6A2xUkPSoFND1ytKPu+bBqK93TKimC1i0iELlCdh2brUzdCKYEJBmO22uLhva2uLZ3EQvGqNqW2+KiYpnIZqf//NkxEodEoLEXmIE3uFdKU1ft6UWWu/NtOV2MFJBARFv915Fwi//ijKZ5QPtahDwbPvMOOPta9UJJad1sibIEcAnXUzOin78wDRaiSuCjubzcE4XF3jy82iLCgZdHNdXe0NttCoCkSCqQUsqtTX1rrQ0VUezN/9/F8WRyxaMdBFmkPGnrCA4XUpoG/xKGlVK//NkxFgdUa6w3nmQkoUGufspBpZEMpRb92LyRGYOuPLBUNETxFC+eZYI1QBiWo7bv9cbC4RBNgU2ZOzJlF2I6hncW0XFxQq5joOD4qV1k0mFqK+c0awzlTSR0s1t3Fwl6uZIKmCg7bWIdsjgSDKRpnRGr8vcxrIbKzUVl7316SOkxjs9CJen///Npyf///f///NkxGUc4869vkoEv/MjM0zQT+PLHf03+FAppQiO26Si0wExQTgQZNKKhYVXL/KdqhblIpuWqJEkZJao2zpmnQJzwo/KzF2SsevxgrWgg8ogPCHJC+ZGYI2ADMGCNweE3kigIuDQFGDEH4qBwcUYUz+bXbe4AMoPu/7s24QUHaPJvozFL7kkmPLhgUeLCPpU//NkxHQdQYKAPsmGkBUB40UDw1eB2YYqrAq9/o+y1xKjtHtsXBr0nSf2Vwmm+QRJlXz1m1IVzyOFGEgDDGZVaz3eRW2U4RFBamZ93qsjBtD5znsr2aIZnVX2RKpDvajaEnvzn37TvfX9f/faT/t///8i6rX3INPKHWGrJkprEf6xqTGg6UAvtPBqpnPTuNw1//NkxIIcA758FspEWAuYStUOFnAwRayKry+iKyESNAqfXOu5qY5aIXsruZdM/Z6b1jIKxB4uh2+ai4eSFYcK4fVqaeiZnNyp575zQoX5/c34fn8L/0fInJ48l+F09KZX4/8eN+rndzx47njOiPmj3Nd6SOQRWBYTMnDxEcIuFllGECkpxosYIVIcSiVJ51w+//NkxJUf9DqIFMGGMBolGBvMSYphcBJDXSmhMFFUsV27MeGBQHxCBzaaMCtwETeeCALA0JwkK1nBt2pRB7HrBckAWrpF4kJn0LYWQwa0URuPUN5l7LLlrWrvMhMuPBVwCCIFDLUqLslhZQTOEZoFjKZSQq07QHBQoX0DkWRTrgWmFVJSeW5NkVpKKXrclWbD//NkxJgcYPqSNoGGDBXTKSmTqRYo2Geff0vxs/Ve9dGEwGFWSYiWdaxBoqdDLZ+WPRaFSICcLmgghZVzUDgKz1IZYOfD3YlyEq1PNCo0XEoCUwGh0Ep0TLyRYDDhRQUDKSXe
Line truncated
+  })
+  data: string;
 }
 
 export class VoiceRemoteFile {
-    @ApiProperty({
-        description: "MIME type of the attachment.",
-    })
-    mimetype = "audio/ogg; codecs=opus"
+  @ApiProperty({
+    description: 'MIME type of the attachment.',
+  })
+  mimetype = 'audio/ogg; codecs=opus';
 
-    @ApiProperty({
-        description: "Document file name. Optional",
-    })
-    filename = "voice-message.mp3"
-
-    @ApiProperty({
-        example: 'https://github.com/devlikeapro/whatsapp-http-api/raw/core/examples/dev.likeapro.mp3',
-    })
-    url: string
+  @ApiProperty({
+    description: 'Document file name. Optional',
+  })
+  filename = 'voice-message.mp3';
 
+  @ApiProperty({
+    example:
+      'https://github.com/devlikeapro/whatsapp-http-api/raw/core/examples/dev.likeapro.mp3',
+  })
+  url: string;
 }
 
 @ApiExtraModels(VoiceBinaryFile, VoiceRemoteFile)
 export class MessageVoiceRequest extends ChatRequest {
-    @ApiProperty({
-        oneOf: [
-            {$ref: getSchemaPath(VoiceBinaryFile)},
-            {$ref: getSchemaPath(VoiceRemoteFile)},
-        ],
-    })
-    file: VoiceBinaryFile | VoiceRemoteFile
+  @ApiProperty({
+    oneOf: [
+      { $ref: getSchemaPath(VoiceBinaryFile) },
+      { $ref: getSchemaPath(VoiceRemoteFile) },
+    ],
+  })
+  file: VoiceBinaryFile | VoiceRemoteFile;
 }
 
 export class MessageLinkPreviewRequest extends ChatRequest {
-    url: string;
-    title: string;
+  url: string;
+  title: string;
 }
 
 export class MessageReactionRequest extends MessageRequest {
-    @ApiProperty({
-        description: "Emoji to react with. Send an empty string to remove the reaction",
-        example: '👍',
-    })
-    reaction: string
+  @ApiProperty({
+    description:
+      'Emoji to react with. Send an empty string to remove the reaction',
+    example: '👍',
+  })
+  reaction: string;
 }

src/structures/contacts.dto.ts

@@ -0,0 +1,21 @@
+import { IsString } from 'class-validator';
+
+import { SessionBaseRequest, SessionQuery } from './base.dto';
+
+/**
+ * Queries
+ */
+
+export class ContactQuery extends SessionQuery {
+  @IsString()
+  contactId: string;
+}
+
+/**
+ * Requests
+ */
+
+export class ContactRequest extends SessionBaseRequest {
+  @IsString()
+  contactId: string;
+}