diff --git a/404.html b/404.html index b004520d..d336b934 100644 --- a/404.html +++ b/404.html @@ -7,4 +7,4 @@

Page not found :(

The page you are looking for doesn't exist or has been moved.

- \ No newline at end of file + \ No newline at end of file diff --git a/blog/index.html b/blog/index.html index cf8541c7..7cce8e5d 100644 --- a/blog/index.html +++ b/blog/index.html @@ -7,4 +7,4 @@

Blog

Say hello to Doks 👋

Say hello to Doks 👋

Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.

Posted in News on November 4, 2020 by Henk Verlinde ‐ 1 min read

- \ No newline at end of file + \ No newline at end of file diff --git a/blog/say-hello-to-doks/index.html b/blog/say-hello-to-doks/index.html index ba6c1600..914d585c 100644 --- a/blog/say-hello-to-doks/index.html +++ b/blog/say-hello-to-doks/index.html @@ -9,4 +9,4 @@ SEO - \ No newline at end of file + \ No newline at end of file diff --git a/categories/index.html b/categories/index.html index cf43f636..e7749684 100644 --- a/categories/index.html +++ b/categories/index.html @@ -7,4 +7,4 @@

Categories

- \ No newline at end of file + \ No newline at end of file diff --git a/categories/news/index.html b/categories/news/index.html index 1a098fc3..0e873c1e 100644 --- a/categories/news/index.html +++ b/categories/news/index.html @@ -7,4 +7,4 @@

News

Say hello to Doks 👋

Say hello to Doks 👋

Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.

Posted in News on November 4, 2020 by Henk Verlinde ‐ 1 min read

- \ No newline at end of file + \ No newline at end of file diff --git a/contributors/henk-verlinde/index.html b/contributors/henk-verlinde/index.html index c35c5417..0df7c15a 100644 --- a/contributors/henk-verlinde/index.html +++ b/contributors/henk-verlinde/index.html @@ -7,4 +7,4 @@

Henk Verlinde

Creator of Hyas.

@HenkVerlinde

Say hello to Doks 👋

Say hello to Doks 👋

Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.

Posted in News on November 4, 2020 by Henk Verlinde ‐ 1 min read

- \ No newline at end of file + \ No newline at end of file diff --git a/contributors/index.html b/contributors/index.html index 54376270..4adc4d1a 100644 --- a/contributors/index.html +++ b/contributors/index.html @@ -7,4 +7,4 @@

Contributors

The Doks contributors.

- \ No newline at end of file + \ No newline at end of file diff --git a/docs/examples/index.html b/docs/examples/index.html index 66e96803..4b22ea8a 100644 --- a/docs/examples/index.html +++ b/docs/examples/index.html @@ -13,4 +13,4 @@ Examples
- \ No newline at end of file + \ No newline at end of file diff --git a/docs/examples/python/index.html b/docs/examples/python/index.html index 7989c1e1..1980a80a 100644 --- a/docs/examples/python/index.html +++ b/docs/examples/python/index.html @@ -16,4 +16,4 @@ Examples

Python

WhatsApp HTTP API Python examples.

We’ve created a few examples on how to interact with WAHA WhatsApp HTTP API with Python.

You can find the examples in examples folder on GitHub with detailed instructions in README.md

← Changelog
Security →
- \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/chats/index.html b/docs/how-to/chats/index.html index 42475f14..11e5d50e 100644 --- a/docs/how-to/chats/index.html +++ b/docs/how-to/chats/index.html @@ -21,4 +21,4 @@ GET /api/{session}/chats

Get messages from chat

Get 100 messages from the chat

GET /api/{session}/chats/{chatId}/messages?limit=100

Get 100 messages from the chat, skip downloading media (images, files)

GET /api/{session}/chats/{chatId}/messages?limit=100&downloadMedia=false

Delete chat

Use the method to delete chat

DELETE /api/{session}/chats/{chatId}

Clear messages

Use the method to clear all messages from the chat

DELETE /api/{session}/chats/{chatId}/messages

← Polls
FAQ →
- \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/config/index.html b/docs/how-to/config/index.html index de98ebcc..11f969c0 100644 --- a/docs/how-to/config/index.html +++ b/docs/how-to/config/index.html @@ -54,4 +54,4 @@
← Security
Engines →
- \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/contacts/index.html b/docs/how-to/contacts/index.html index 48e8fac6..45e0d2de 100644 --- a/docs/how-to/contacts/index.html +++ b/docs/how-to/contacts/index.html @@ -60,4 +60,4 @@
← FAQ
Groups →
- \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/deploy/index.html b/docs/how-to/deploy/index.html index 73e2324b..c631fc5f 100644 --- a/docs/how-to/deploy/index.html +++ b/docs/how-to/deploy/index.html @@ -37,4 +37,4 @@ 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.

← Presence
WAHA Plus →
- \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/engines/index.html b/docs/how-to/engines/index.html index e2221b8d..60dd2600 100644 --- a/docs/how-to/engines/index.html +++ b/docs/how-to/engines/index.html @@ -31,4 +31,4 @@ please create an issue

WEBJSNOWEBVENOM
Session
POST /api/sessions/start✔️✔️✔️
POST /api/sessions/stop✔️✔️✔️
POST /api/sessions/logout✔️✔️✔️
GET /api/sessions/✔️✔️✔️
GET /api/sessions/{session}/me✔️✔️➖
Authentication
POST /api/{session}/auth/qr✔️✔️➖
POST /api/{session}/auth/request-code➖✔️➖
POST /api/{session}/auth/authorize-code➖✔️➖
Screenshot
POST /api/screenshot✔️➖✔️
ChattingWEBJSNOWEBVENOM
GET /api/checkNumberStatus✔️✔️✔️
GET /api/sendContactVcard➖➖✔️
GET /api/sendText✔️✔️✔️
POST /api/sendText✔️✔️✔️
POST /api/sendPoll➖✔️➖
POST /api/sendLocation✔️✔️✔️
POST /api/sendLinkPreview➖✔️✔️
POST /api/sendImage ✔️✔️✔️
POST /api/sendFile ✔️✔️✔️
POST /api/sendVoice ✔️✔️✔️
POST /api/reply✔️✔️✔️
POST /api/sendSeen✔️✔️✔️
POST /api/startTyping✔️✔️✔️
POST /api/stopTyping✔️✔️➖
POST /api/reaction✔️✔️➖
GET /api/messages✔️➖✔️
WEBJSNOWEBVENOM
Status
POST /api/{session}/status/text➖✔️➖
POST /api/{session}/status/image ➖✔️➖
POST /api/{session}/status/voice ➖✔️➖
POST /api/{session}/status/video ➖✔️➖
Chats
GET /api/{session}/chats✔️➖➖
DELETE /api/{session}/chats/{chatId}✔️➖➖
GET /api/{session}/chats/{chatId}/messages✔️➖✔️
DELETE /api/{session}/chats/{chatId}/messages✔️➖➖
Contacts
GET /api/contacts✔️➖➖
GET /api/contacts/all✔️➖➖
GET /api/contacts/check-exists✔️✔️✔️
GET /api/contacts/about✔️➖➖
GET /api/contacts/profile-picture✔️➖➖
POST /api/contacts/block✔️➖➖
POST /api/contacts/unblock✔️➖➖
GroupsWEBJSNOWEBVENOM
POST /api/{session}/groups✔️✔️➖
GET /api/{session}/groups✔️✔️➖
GET /api/{session}/groups/{id}✔️✔️➖
DELETE /api/{session}/groups/{id}✔️➖➖
PUT /api/{session}/groups/{id}/settings/security/info-admin-only✔️➖➖
POST /api/{session}/groups/{id}/leave✔️✔️➖
PUT /api/{session}/groups/{id}/description✔️✔️➖
PUT /api/{session}/groups/{id}/subject✔️✔️➖
GET /api/{session}/groups/{id}/invite-code✔️✔️➖
POST /api/{session}/groups/{id}/invite-code/revoke✔️✔️➖
GET /api/{session}/groups/{id}/participants✔️✔️➖
POST /api/{session}/groups/{id}/participants/add✔️✔️➖
POST /api/{session}/groups/{id}/participants/remove✔️✔️➖
POST /api/{session}/groups/{id}/admin/promote✔️✔️➖
POST /api/{session}/groups/{id}/admin/demote✔️✔️➖
WEBJSNOWEBVENOM
Presence
POST /api/{session}/presence➖✔️➖
GET /api/{session}/presence➖✔️➖
GET /api/{session}/presence/{chatId}➖✔️➖
POST /api/{session}/presence/{chatId}/subscribe➖✔️➖
Other
POST /api/version➖✔️➖
WebhooksWEBJSNOWEBVENOM
message✔️✔️✔️
message with files ✔️✔️✔️
message.any✔️✔️✔️
message.ack✔️✔️✔️
message.revoked✔️➖➖
state.change✔️✔️✔️
group.join✔️✔️✔️
group.leave✔️➖➖
presence.update➖✔️➖
poll.vote➖✔️➖
poll.vote.failed➖✔️➖
← Configuration
Presence →
- \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/groups/index.html b/docs/how-to/groups/index.html index 88f390f4..03464e26 100644 --- a/docs/how-to/groups/index.html +++ b/docs/how-to/groups/index.html @@ -82,4 +82,4 @@
← Contacts
Changelog →
- \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/index.html b/docs/how-to/index.html index d02b55ce..5628085c 100644 --- a/docs/how-to/index.html +++ b/docs/how-to/index.html @@ -13,4 +13,4 @@ Examples
- \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/index.xml b/docs/how-to/index.xml index 29f63c50..f8879a4e 100644 --- a/docs/how-to/index.xml +++ b/docs/how-to/index.xml @@ -14,7 +14,7 @@ Start a new session with configured message event in webhooks - call POST /api/s 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.Sessionshttps://waha.devlike.pro/docs/how-to/sessions/Tue, 06 Oct 2020 08:48:45 +0000https://waha.devlike.pro/docs/how-to/sessions/Sessions # +You can define webhooks configuration per session when you start it with POST /api/sessions/start request data.Sessionshttps://waha.devlike.pro/docs/how-to/sessions/Tue, 06 Oct 2020 08:48:45 +0000https://waha.devlike.pro/docs/how-to/sessions/Endpoints # See the list of engines that support the features ->. Start # In order to start a new session - call POST /api/sessions/start diff --git a/docs/how-to/install/index.html b/docs/how-to/install/index.html index 4554625d..b1eb08c0 100644 --- a/docs/how-to/install/index.html +++ b/docs/how-to/install/index.html @@ -54,4 +54,4 @@
← Introduction
Quick Start →
  • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
    The official WhatsApp website can be found at https://whatsapp.com/.
    "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
    - \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/plus-version/index.html b/docs/how-to/plus-version/index.html index ceb64d2e..dea68792 100644 --- a/docs/how-to/plus-version/index.html +++ b/docs/how-to/plus-version/index.html @@ -31,4 +31,4 @@

    Then in all commands use Plus image devlikeapro/whatsapp-http-api-plus instead of Core devlikeapro/whatsapp-http-api.

    ← Deploy
    • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
      The official WhatsApp website can be found at https://whatsapp.com/.
      "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
      - \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/polls/index.html b/docs/how-to/polls/index.html index 5eb00760..94821211 100644 --- a/docs/how-to/polls/index.html +++ b/docs/how-to/polls/index.html @@ -122,4 +122,4 @@ prepared for such cases!

      ← Sessions
      Chats →
      • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
        The official WhatsApp website can be found at https://whatsapp.com/.
        "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
        - \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/presence/index.html b/docs/how-to/presence/index.html index ba254503..636bca9d 100644 --- a/docs/how-to/presence/index.html +++ b/docs/how-to/presence/index.html @@ -95,4 +95,4 @@
        ← Engines
        Deploy →
        • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
          The official WhatsApp website can be found at https://whatsapp.com/.
          "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
          - \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/receive-messages/index.html b/docs/how-to/receive-messages/index.html index 8edec16b..43d0c37f 100644 --- a/docs/how-to/receive-messages/index.html +++ b/docs/how-to/receive-messages/index.html @@ -135,4 +135,4 @@ GitHub, in examples folder ->.

          ← How to Avoid Blocking
          Webhooks →
          • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
            The official WhatsApp website can be found at https://whatsapp.com/.
            "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
            - \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/security/index.html b/docs/how-to/security/index.html index 24f4419b..b0dba609 100644 --- a/docs/how-to/security/index.html +++ b/docs/how-to/security/index.html @@ -33,4 +33,4 @@ Read more about it on Webhooks page ->

            ← Python
            Configuration →
            • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
              The official WhatsApp website can be found at https://whatsapp.com/.
              "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
              - \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/send-messages/index.html b/docs/how-to/send-messages/index.html index 52694ac7..959d304b 100644 --- a/docs/how-to/send-messages/index.html +++ b/docs/how-to/send-messages/index.html @@ -152,4 +152,4 @@
              ← Quick Start
              How to Avoid Blocking →
              • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
                The official WhatsApp website can be found at https://whatsapp.com/.
                "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
                - \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/sessions/index.html b/docs/how-to/sessions/index.html index e01d8742..73bfdfeb 100644 --- a/docs/how-to/sessions/index.html +++ b/docs/how-to/sessions/index.html @@ -15,9 +15,9 @@ How-to guides

                • Sessions

                Sessions

                Sessions

                See the list of engines that support the features ->.

                Start

                In order to start a new session - call POST /api/sessions/start

                {
+ExpandCollapse
                On this page
                Endpoints 
                See the list of engines that support the features ->.
                Start 
                In order to start a new session - call POST /api/sessions/start
                {
   "name": "default"
 }
 
                Configure webhooks 
                You can configure webhooks for a session:
                {
@@ -78,14 +78,32 @@
   "pushName": "string"
 }
 
                Stopped or not authenticated session returns null:
                null
-
                Authentication 
                See the list of engines that support the features ->.
                Get QR 
                The simplest way to authenticate a new session - get QR code and scan it on your device.
                GET /api/{session}/auth/qr
-
                You’ll get QR image that you can scan and get authenticated
                Get pairing code 
                You can link a session with phone number - make a request to the endpoint.
                POST /api/{session}/auth/request-code
+
                Get QR 
                See the list of engines that support the features ->.
                The simplest way to authenticate a new session - get QR code and scan it on your device.
                GET /api/{session}/auth/qr
+
                You’ll get QR image that you can scan and get authenticated
                Get pairing code 
                See the list of engines that support the features ->.
                You can link a session with phone number - make a request to the endpoint.
                POST /api/{session}/auth/request-code
 
                Body example:
                {
   "phoneNumber": "12132132130"
 }
 
                You’ll get code in the response that you can use on your WhatsApp app to connect the session:
                {
   "code": "ABCD-ABCD"
 }
+
                Webhooks 
                See the list of engines that support the feature ->.
                session.status 
                The session.status event is triggered when the session status changes.
                • STOPPED - session is stopped
                • STARTING - session is starting
                • SCAN_QR_CODE - session is required to scan QR code or login via phone number
                • WORKING - session is working and ready to use
                • FAILED - session is failed due to some error. It’s likely that authorization is required again or device has been disconnected from that account.
+Try to restart the session and if it doesn’t help - logout and start the session again.
                {
+    "event": "session.status",
+    "session": "default",
+    "me": {
+        "id": "7911111@c.us",
+        "pushName": "~"
+    },
+    "payload": {
+        "status": "WORKING"
+    },
+    "engine": "WEBJS",
+    "environment": {
+        "version": "2023.10.12",
+        "engine": "WEBJS",
+        "tier": "PLUS"
+    }
+}
 
                Advanced sessions  
                With WAHA 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 part to the command:
                -v `pwd`/.sessions:/app/.sessions
@@ -101,4 +119,4 @@
 Plus version supports multiple sessions in one container.
                ← Webhooks
                Polls →
                • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
                  The official WhatsApp website can be found at https://whatsapp.com/.
                  "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
                  - \ No newline at end of file + \ No newline at end of file diff --git a/docs/how-to/webhooks/index.html b/docs/how-to/webhooks/index.html index eb3b678c..ef8820f5 100644 --- a/docs/how-to/webhooks/index.html +++ b/docs/how-to/webhooks/index.html @@ -15,9 +15,9 @@ How-to guides

                  • Webhooks

                  Webhooks

                  The project uses Webhooks to send the messages and events from WhatsApp to your +ExpandCollapse

                  On this page

                  The project uses Webhooks 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:

                  {
@@ -78,7 +78,25 @@
   }
 }

                  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.

                  Run the bellow command and see look at the logs - it prints body request for all events that happen in your WhatsApp!

                  docker run -it -e "WHATSAPP_HOOK_EVENTS=*" -e WHATSAPP_HOOK_URL=https://httpbin.org/post -p 3000:3000 devlikeapro/whatsapp-http-api
-

                  Webhooks

                  See the list of engines that support the features ->.

                  message

                  Incoming message (text/audio/files)

                  {
+

                  Webhooks

                  See the list of engines that support the features ->.

                  session.status

                  The session.status event is triggered when the session status changes.

                  • STOPPED - session is stopped
                  • STARTING - session is starting
                  • SCAN_QR_CODE - session is required to scan QR code or login via phone number
                  • WORKING - session is working and ready to use
                  • FAILED - session is failed due to some error. It’s likely that authorization is required again or device has been disconnected from that account. +Try to restart the session and if it doesn’t help - logout and start the session again.
                  {
+    "event": "session.status",
+    "session": "default",
+    "me": {
+        "id": "7911111@c.us",
+        "pushName": "~"
+    },
+    "payload": {
+        "status": "WORKING"
+    },
+    "engine": "WEBJS",
+    "environment": {
+        "version": "2023.10.12",
+        "engine": "WEBJS",
+        "tier": "PLUS"
+    }
+}
+

                  message

                  Incoming message (text/audio/files)

                  {
   "event": "message",
   "session": "default",
   "engine": "WEBJS",
@@ -323,4 +341,4 @@
 GitHub, in examples folder ->.
                  ← Receive messages
                  Sessions →
                  • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
                    The official WhatsApp website can be found at https://whatsapp.com/.
                    "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
                    - \ No newline at end of file + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index d78fd30a..3280420d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -13,4 +13,4 @@ Examples
                    • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
                      The official WhatsApp website can be found at https://whatsapp.com/.
                      "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
                      - \ No newline at end of file + \ No newline at end of file diff --git a/docs/overview/changelog/index.html b/docs/overview/changelog/index.html index 827e5a2d..425c5795 100644 --- a/docs/overview/changelog/index.html +++ b/docs/overview/changelog/index.html @@ -17,7 +17,7 @@ On this page ExpandCollapse

                      On this page

                      Changelog

                      You can find here the list of changes made to WAHA.

                      If you wish to get and read Release Notes - read them on one of our platforms, these posts are FREE.

                      You even can subscribe to get new updates there!

                      2023.10

                      October 2023

                      • Add message.revoked event in WEBJS engine
                      • Add me field in webhook payload - now you can know which number is associated with the session
                      • Add enviroment field in webhook payload - now you can know which environment is used for the session

                      2023.9

                      September 2023

                      2023.8

                      August 2023

                      • Added stories (aka status) endpoints to NOWEB engine!
                        • POST /api/{session}/status/text|image|voice|video - choose one that suites your!
                      • Added chats endpoints
                        • Get all chats - GET /api/{session/chats
                        • Delete chat - DELETE /api/{session/chats/{chatId}
                        • Get messages from chat - GET /api/{session/chats/{chatId}/messages?limit=1000?downloadMedia=true
                        • Clear messages in the chat DELETE /api/{session/chats/{chatId}/messages
                      • Added downloadMedia flag to speed up GET /api/messages and GET /api/{session/chats/{chatId}/messages performance.
                      • Added set presence endpoint!
                        • With online presence you can show your status as online #121
                        • With offline presence you can get notifications for your device #28
                      • Added security settings for edit group info PUT /api/{session}/groups/{groupId}/settings/security/info-admin-only - updates the group settings to only allow admins to edit group info (title, description, photo).

                      2023.7

                      July 2023

                      • Now session can have their own Webhooks - +ExpandCollapse

                        On this page

                        If you wish to get and read Release Notes - read them on one of our platforms, these posts are FREE.

                        You even can subscribe to get new updates there!

                        2023.10

                        October 2023

                        • Add session.status event for all engines! Now you can get the latest session’s status immediately after it changes.
                        • Add message.revoked event in WEBJS engine
                        • Add me field in webhook payload - now you can know which number is associated with the session
                        • Add enviroment field in webhook payload - now you can know which environment is used for the session

                        2023.9

                        September 2023

                        2023.8

                        August 2023

                        • Added stories (aka status) endpoints to NOWEB engine!
                          • POST /api/{session}/status/text|image|voice|video - choose one that suites your!
                        • Added chats endpoints
                          • Get all chats - GET /api/{session/chats
                          • Delete chat - DELETE /api/{session/chats/{chatId}
                          • Get messages from chat - GET /api/{session/chats/{chatId}/messages?limit=1000?downloadMedia=true
                          • Clear messages in the chat DELETE /api/{session/chats/{chatId}/messages
                        • Added downloadMedia flag to speed up GET /api/messages and GET /api/{session/chats/{chatId}/messages performance.
                        • Added set presence endpoint!
                          • With online presence you can show your status as online #121
                          • With offline presence you can get notifications for your device #28
                        • Added security settings for edit group info PUT /api/{session}/groups/{groupId}/settings/security/info-admin-only - updates the group settings to only allow admins to edit group info (title, description, photo).

                        2023.7

                        July 2023

                        • Now session can have their own 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 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 - now you can get online status for @@ -51,4 +51,4 @@
                          ← Groups
                          Python →
                      • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
                        The official WhatsApp website can be found at https://whatsapp.com/.
                        "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
                        - \ No newline at end of file + \ No newline at end of file diff --git a/docs/overview/faq/index.html b/docs/overview/faq/index.html index abde7991..add2faf6 100644 --- a/docs/overview/faq/index.html +++ b/docs/overview/faq/index.html @@ -22,4 +22,4 @@ 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 ->

                        ← Chats
                        Contacts →
                        • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
                          The official WhatsApp website can be found at https://whatsapp.com/.
                          "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
                          - \ No newline at end of file + \ No newline at end of file diff --git a/docs/overview/how-to-avoid-blocking/index.html b/docs/overview/how-to-avoid-blocking/index.html index 9a9e4839..02719680 100644 --- a/docs/overview/how-to-avoid-blocking/index.html +++ b/docs/overview/how-to-avoid-blocking/index.html @@ -31,4 +31,4 @@ guidelines and reduces the risk of being blocked.

                          ← Send messages
                          Receive messages →
                          • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
                            The official WhatsApp website can be found at https://whatsapp.com/.
                            "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
                            - \ No newline at end of file + \ No newline at end of file diff --git a/docs/overview/index.html b/docs/overview/index.html index c0b836da..d3f390b8 100644 --- a/docs/overview/index.html +++ b/docs/overview/index.html @@ -13,4 +13,4 @@ Examples
                            • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
                              The official WhatsApp website can be found at https://whatsapp.com/.
                              "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
                              - \ No newline at end of file + \ No newline at end of file diff --git a/docs/overview/index.xml b/docs/overview/index.xml index 133e239f..e473eada 100644 --- a/docs/overview/index.xml +++ b/docs/overview/index.xml @@ -19,4 +19,4 @@ Accounts (sessions) in the container CPU Memory 1 30% 400MB 10 270% 1.5GB The na Boosty -> Patreon -> You even can subscribe to get new updates there! 2023.10 # October 2023 -Add message.revoked event in WEBJS engine Add me field in webhook payload - now you can know which number is associated with the session Add enviroment field in webhook payload - now you can know which environment is used for the session 2023.                               \ No newline at end of file +Add session.status event for all engines! Now you can get the latest session’s status immediately after it changes. Add message.revoked event in WEBJS engine Add me field in webhook payload - now you can know which number is associated with the session Add enviroment field in webhook payload - now you can know which environment is used for the session 2023. \ No newline at end of file diff --git a/docs/overview/introduction/index.html b/docs/overview/introduction/index.html index d463f473..7e61007b 100644 --- a/docs/overview/introduction/index.html +++ b/docs/overview/introduction/index.html @@ -21,4 +21,4 @@ Quick Start →.

                              Features

                              WAHA is distributed in two versions:

                              See the list of engines that support the features ->.

                              Here’s the available features:

                              Messages

                              Groups

                              Contacts

                              Sessions

                              Security

                              Updates

                              Install →
                              • This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
                                The official WhatsApp website can be found at https://whatsapp.com/.
                                "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
                                - \ No newline at end of file + \ No newline at end of file diff --git a/docs/overview/quick-start/index.html b/docs/overview/quick-start/index.html index ee75231a..2a83126a 100644 --- a/docs/overview/quick-start/index.html +++ b/docs/overview/quick-start/index.html @@ -60,4 +60,4 @@

                                What is next?

                                ← Install
                                Send messages →
                                - \ No newline at end of file + \ No newline at end of file diff --git a/index.html b/index.html index 42ff05e1..c6331772 100644 --- a/index.html +++ b/index.html @@ -9,4 +9,4 @@ totally safe.

                                - \ No newline at end of file + \ No newline at end of file diff --git a/index.min.f6470370b0431480bdedf9355603f15971214eab1b1561cad6e6bf82d4d0334e70386952693a2096d3ff21c6da17a394b5b1b5f35733cc0682ac34ff085ab38a.js b/index.min.9a12c849a00011b43d48c58640b019789d5b05493e2c85d697ecaf3b2ead1bd43683f49e3a28bfd24e3e17b3c5d4bd9efce1cc07b3aeb7d696979d82965606de.js similarity index 98% rename from index.min.f6470370b0431480bdedf9355603f15971214eab1b1561cad6e6bf82d4d0334e70386952693a2096d3ff21c6da17a394b5b1b5f35733cc0682ac34ff085ab38a.js rename to index.min.9a12c849a00011b43d48c58640b019789d5b05493e2c85d697ecaf3b2ead1bd43683f49e3a28bfd24e3e17b3c5d4bd9efce1cc07b3aeb7d696979d82965606de.js index 32e02654..96dcf0ad 100644 --- a/index.min.f6470370b0431480bdedf9355603f15971214eab1b1561cad6e6bf82d4d0334e70386952693a2096d3ff21c6da17a394b5b1b5f35733cc0682ac34ff085ab38a.js +++ b/index.min.9a12c849a00011b43d48c58640b019789d5b05493e2c85d697ecaf3b2ead1bd43683f49e3a28bfd24e3e17b3c5d4bd9efce1cc07b3aeb7d696979d82965606de.js @@ -125,7 +125,8 @@ Webhook payload # On the URL that you set you\u0026rsquo;ll receive HTTP POST re Below the list of all events that WhatsApp HTTP API sends to your. 👉 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! docker run -it -e \u0026quot;WHATSAPP_HOOK_EVENTS=*\u0026quot; -e WHATSAPP_HOOK_URL=https://httpbin.org/post -p 3000:3000 devlikeapro/whatsapp-http-api Webhooks # See the list of engines that support the features -\u0026gt;. -message # Incoming message (text/audio/files) +session.status # The session.status event is triggered when the session status changes. +STOPPED - session is stopped STARTING - session is starting SCAN_QR_CODE - session is required to scan QR code or login via phone number WORKING - session is working and ready to use FAILED - session is failed due to some error. It\u0026rsquo;s likely that authorization is required again or device has been disconnected from that account. Try to restart the session and if it doesn\u0026rsquo;t help - logout and start the session again. { \u0026quot;event\u0026quot;: \u0026quot;session.status\u0026quot;, \u0026quot;session\u0026quot;: \u0026quot;default\u0026quot;, \u0026quot;me\u0026quot;: { \u0026quot;id\u0026quot;: \u0026quot;7911111@c.us\u0026quot;, \u0026quot;pushName\u0026quot;: \u0026quot;~\u0026quot; }, \u0026quot;payload\u0026quot;: { \u0026quot;status\u0026quot;: \u0026quot;WORKING\u0026quot; }, \u0026quot;engine\u0026quot;: \u0026quot;WEBJS\u0026quot;, \u0026quot;environment\u0026quot;: { \u0026quot;version\u0026quot;: \u0026quot;2023.10.12\u0026quot;, \u0026quot;engine\u0026quot;: \u0026quot;WEBJS\u0026quot;, \u0026quot;tier\u0026quot;: \u0026quot;PLUS\u0026quot; } } message # Incoming message (text/audio/files) { \u0026quot;event\u0026quot;: \u0026quot;message\u0026quot;, \u0026quot;session\u0026quot;: \u0026quot;default\u0026quot;, \u0026quot;engine\u0026quot;: \u0026quot;WEBJS\u0026quot;, \u0026quot;payload\u0026quot;: { \u0026quot;id\u0026quot;: \u0026quot;true_11111111111@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\u0026quot;, \u0026quot;timestamp\u0026quot;: 1667561485, \u0026quot;from\u0026quot;: \u0026quot;11111111111@c.us\u0026quot;, \u0026quot;fromMe\u0026quot;: true, \u0026quot;to\u0026quot;: \u0026quot;11111111111@c.us\u0026quot;, \u0026quot;body\u0026quot;: \u0026quot;Hi there!\u0026quot;, \u0026quot;hasMedia\u0026quot;: false, \u0026quot;ack\u0026quot;: 1, \u0026quot;vCards\u0026quot;: [], \u0026quot;_data\u0026quot;: { \u0026quot;id\u0026quot;: { \u0026quot;fromMe\u0026quot;: true, \u0026quot;remote\u0026quot;: \u0026quot;11111111111@c.us\u0026quot;, \u0026quot;id\u0026quot;: \u0026quot;AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\u0026quot;, \u0026quot;_serialized\u0026quot;: \u0026quot;true_11111111111@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\u0026quot; }, \u0026quot;body\u0026quot;: \u0026quot;Hi there!\u0026quot;, \u0026quot;type\u0026quot;: \u0026quot;chat\u0026quot;, \u0026quot;t\u0026quot;: 1667561485, \u0026quot;notifyName\u0026quot;: \u0026quot;MyName\u0026quot;, \u0026quot;from\u0026quot;: \u0026quot;11111111111@c.us\u0026quot;, \u0026quot;to\u0026quot;: \u0026quot;11111111111@c.us\u0026quot;, \u0026quot;self\u0026quot;: \u0026quot;in\u0026quot;, \u0026quot;ack\u0026quot;: 1, \u0026quot;isNewMsg\u0026quot;: true, \u0026quot;star\u0026quot;: false, \u0026quot;kicNotified\u0026quot;: false, \u0026quot;recvFresh\u0026quot;: true, \u0026quot;isFromTemplate\u0026quot;: false, \u0026quot;pollInvalidated\u0026quot;: false, \u0026quot;latestEditMsgKey\u0026quot;: null, \u0026quot;latestEditSenderTimestampMs\u0026quot;: null, \u0026quot;broadcast\u0026quot;: false, \u0026quot;mentionedJidList\u0026quot;: [], \u0026quot;isVcardOverMmsDocument\u0026quot;: false, \u0026quot;isForwarded\u0026quot;: false, \u0026quot;hasReaction\u0026quot;: false, \u0026quot;ephemeralOutOfSync\u0026quot;: false, \u0026quot;productHeaderImageRejected\u0026quot;: false, \u0026quot;lastPlaybackProgress\u0026quot;: 0, \u0026quot;isDynamicReplyButtonsMsg\u0026quot;: false, \u0026quot;isMdHistoryMsg\u0026quot;: false, \u0026quot;stickerSentTs\u0026quot;: 0, \u0026quot;isAvatar\u0026quot;: false, \u0026quot;requiresDirectConnection\u0026quot;: false, \u0026quot;pttForwardedFeaturesEnabled\u0026quot;: true, \u0026quot;isEphemeral\u0026quot;: false, \u0026quot;isStatusV3\u0026quot;: false, \u0026quot;links\u0026quot;: [] } } } message.any # Fired on all message creations, including your own. The payload is the same as for message event. { \u0026quot;event\u0026quot;: \u0026quot;message.any\u0026quot;, \u0026quot;session\u0026quot;: \u0026quot;default\u0026quot;, \u0026quot;engine\u0026quot;: \u0026quot;WEBJS\u0026quot;, \u0026quot;payload\u0026quot;: { ... } } message.ack # Receive events when server or recipient gets the message, read or played it. ackName field contains message status (ack has the same meaning, but show the value in int, but we keep it for backward compatability, they much to each other) @@ -144,7 +145,7 @@ You can configure those parameters by settings config.retries structure when POS { \u0026quot;name\u0026quot;: \u0026quot;default\u0026quot;, \u0026quot;config\u0026quot;: { \u0026quot;webhooks\u0026quot;: [ { \u0026quot;url\u0026quot;: \u0026quot;https://httpbin.org/post\u0026quot;, \u0026quot;events\u0026quot;: [ \u0026quot;message\u0026quot; ], \u0026quot;customHeaders\u0026quot;: [ { \u0026quot;name\u0026quot;: \u0026quot;X-My-Custom-Header\u0026quot;, \u0026quot;value\u0026quot;: \u0026quot;Value\u0026quot; } ] } ] } } Examples # Here\u0026rsquo;s few examples of how to handle webhook in different languages: Python guide 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 -\u0026gt;. -`}),e.add({id:8,href:"/docs/how-to/sessions/",title:"Sessions",description:"Sessions",content:`Sessions # See the list of engines that support the features -\u0026gt;. +`}),e.add({id:8,href:"/docs/how-to/sessions/",title:"Sessions",description:"Sessions",content:`Endpoints # See the list of engines that support the features -\u0026gt;. Start # In order to start a new session - call POST /api/sessions/start { \u0026quot;name\u0026quot;: \u0026quot;default\u0026quot; } Configure webhooks # You can configure webhooks for a session: { \u0026quot;name\u0026quot;: \u0026quot;default\u0026quot;, \u0026quot;config\u0026quot;: { \u0026quot;webhooks\u0026quot;: [ { \u0026quot;url\u0026quot;: \u0026quot;https://httpbin.org/post\u0026quot;, \u0026quot;events\u0026quot;: [ \u0026quot;message\u0026quot; ] } ] } } Read more about available options on Webhooks page -\u0026gt; @@ -162,13 +163,16 @@ Stop # In order to stop a new session - call POST /api/sessions/stop 👉 You must stop session first. { \u0026quot;name\u0026quot;: \u0026quot;default\u0026quot;, \u0026quot;logout\u0026quot;: true } Get me # Get information about the associated account for that session (if any). GET /api/sessions/{session}/me Authenticated and working session\u0026rsquo;s response: { \u0026quot;id\u0026quot;: \u0026quot;11111111111@c.us\u0026quot;, \u0026quot;pushName\u0026quot;: \u0026quot;string\u0026quot; } Stopped or not authenticated session returns null: -null Authentication # See the list of engines that support the features -\u0026gt;. -Get QR # The simplest way to authenticate a new session - get QR code and scan it on your device. +null Get QR # See the list of engines that support the features -\u0026gt;. +The simplest way to authenticate a new session - get QR code and scan it on your device. GET /api/{session}/auth/qr You\u0026rsquo;ll get QR image that you can scan and get authenticated -Get pairing code # You can link a session with phone number - make a request to the endpoint. +Get pairing code # See the list of engines that support the features -\u0026gt;. +You can link a session with phone number - make a request to the endpoint. POST /api/{session}/auth/request-code Body example: { \u0026quot;phoneNumber\u0026quot;: \u0026quot;12132132130\u0026quot; } You\u0026rsquo;ll get code in the response that you can use on your WhatsApp app to connect the session: -{ \u0026quot;code\u0026quot;: \u0026quot;ABCD-ABCD\u0026quot; } Advanced sessions # With WAHA 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! +{ \u0026quot;code\u0026quot;: \u0026quot;ABCD-ABCD\u0026quot; } Webhooks # See the list of engines that support the feature -\u0026gt;. +session.status # The session.status event is triggered when the session status changes. +STOPPED - session is stopped STARTING - session is starting SCAN_QR_CODE - session is required to scan QR code or login via phone number WORKING - session is working and ready to use FAILED - session is failed due to some error. It\u0026rsquo;s likely that authorization is required again or device has been disconnected from that account. Try to restart the session and if it doesn\u0026rsquo;t help - logout and start the session again. { \u0026quot;event\u0026quot;: \u0026quot;session.status\u0026quot;, \u0026quot;session\u0026quot;: \u0026quot;default\u0026quot;, \u0026quot;me\u0026quot;: { \u0026quot;id\u0026quot;: \u0026quot;7911111@c.us\u0026quot;, \u0026quot;pushName\u0026quot;: \u0026quot;~\u0026quot; }, \u0026quot;payload\u0026quot;: { \u0026quot;status\u0026quot;: \u0026quot;WORKING\u0026quot; }, \u0026quot;engine\u0026quot;: \u0026quot;WEBJS\u0026quot;, \u0026quot;environment\u0026quot;: { \u0026quot;version\u0026quot;: \u0026quot;2023.10.12\u0026quot;, \u0026quot;engine\u0026quot;: \u0026quot;WEBJS\u0026quot;, \u0026quot;tier\u0026quot;: \u0026quot;PLUS\u0026quot; } } Advanced sessions # With WAHA 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 part to the command: -v \`pwd\`/.sessions:/app/.sessions The full command would be: @@ -255,7 +259,7 @@ Webhooks # See the list of engines that support the feature -\u0026gt;. group.join # { \u0026quot;event\u0026quot;: \u0026quot;group.join\u0026quot;, \u0026quot;session\u0026quot;: \u0026quot;default\u0026quot;, \u0026quot;engine\u0026quot;: \u0026quot;WEBJS\u0026quot;, \u0026quot;payload\u0026quot;: { ... } } group.leave # { \u0026quot;event\u0026quot;: \u0026quot;group.left\u0026quot;, \u0026quot;session\u0026quot;: \u0026quot;default\u0026quot;, \u0026quot;engine\u0026quot;: \u0026quot;WEBJS\u0026quot;, \u0026quot;payload\u0026quot;: { ... } } `}),e.add({id:14,href:"/docs/overview/changelog/",title:"Changelog",description:"WAHA's changelog",content:`If you wish to get and read Release Notes - read them on one of our platforms, these posts are FREE. Boosty -\u0026gt; Patreon -\u0026gt; You even can subscribe to get new updates there! 2023.10 # October 2023 -Add message.revoked event in WEBJS engine Add me field in webhook payload - now you can know which number is associated with the session Add enviroment field in webhook payload - now you can know which environment is used for the session 2023.9 # September 2023 +Add session.status event for all engines! Now you can get the latest session\u0026rsquo;s status immediately after it changes. Add message.revoked event in WEBJS engine Add me field in webhook payload - now you can know which number is associated with the session Add enviroment field in webhook payload - now you can know which environment is used for the session 2023.9 # September 2023 Add GET /api/sessions/{session/me endpoint so you can get the phone number associated with the session Add polls support in NOWEB engine Add dedicated Get QR endpoint! Support pairing method (NOWEB) - you can connect with a code instead of QR. Add string field ackName: DEVICE|READ|... in message.ack payload Support message.ack event webhook in NOWEB engine 2023.8 # August 2023 Added stories (aka status) endpoints to NOWEB engine! POST /api/{session}/status/text|image|voice|video - choose one that suites your! Added chats endpoints Get all chats - GET /api/{session/chats Delete chat - DELETE /api/{session/chats/{chatId} Get messages from chat - GET /api/{session/chats/{chatId}/messages?limit=1000?downloadMedia=true Clear messages in the chat DELETE /api/{session/chats/{chatId}/messages Added downloadMedia flag to speed up GET /api/messages and GET /api/{session/chats/{chatId}/messages performance. Added set presence endpoint! With online presence you can show your status as online #121 With offline presence you can get notifications for your device #28 Added security settings for edit group info PUT /api/{session}/groups/{groupId}/settings/security/info-admin-only - updates the group settings to only allow admins to edit group info (title, description, photo). 2023.7 # July 2023 Now session can have their own 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 with supporting proxy authentication. Thanks puntolino for the contribution! You can control proxy\u0026rsquo;s settings per session with POST /api/session/start or globally with environment variables. Added presence information - 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 -\u0026gt; 2023.6 # June 2023 diff --git a/tags/index.html b/tags/index.html index 9f5ce82f..b4ff8020 100644 --- a/tags/index.html +++ b/tags/index.html @@ -7,4 +7,4 @@

                                Tags

                                - \ No newline at end of file + \ No newline at end of file diff --git a/tags/performance/index.html b/tags/performance/index.html index e6b325de..9ebf7b06 100644 --- a/tags/performance/index.html +++ b/tags/performance/index.html @@ -7,4 +7,4 @@

                                performance

                                Say hello to Doks 👋

                                Say hello to Doks 👋

                                Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.

                                Posted in News on November 4, 2020 by Henk Verlinde ‐ 1 min read

                                - \ No newline at end of file + \ No newline at end of file diff --git a/tags/security/index.html b/tags/security/index.html index 81850113..566542c0 100644 --- a/tags/security/index.html +++ b/tags/security/index.html @@ -7,4 +7,4 @@

                                security

                                Say hello to Doks 👋

                                Say hello to Doks 👋

                                Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.

                                Posted in News on November 4, 2020 by Henk Verlinde ‐ 1 min read

                                - \ No newline at end of file + \ No newline at end of file diff --git a/tags/seo/index.html b/tags/seo/index.html index f6162594..4f3ea387 100644 --- a/tags/seo/index.html +++ b/tags/seo/index.html @@ -7,4 +7,4 @@

                                SEO

                                Say hello to Doks 👋

                                Say hello to Doks 👋

                                Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.

                                Posted in News on November 4, 2020 by Henk Verlinde ‐ 1 min read

                                - \ No newline at end of file + \ No newline at end of file