From 4d1b495a5e568d61360686e7692734670349e678 Mon Sep 17 00:00:00 2001 From: Luc <8822552+luc-github@users.noreply.github.com> Date: Mon, 25 Nov 2024 15:46:51 +0800 Subject: [PATCH] Add what's App / callmebot documentation for https://github.com/luc-github/ESP3D/issues/888 --- .../documentation/notifications/index.md | 4 +++ .../documentation/notifications/whatsapp.md | 34 +++++++++++++++++++ .../documentation/update/esp3dcnf.ini | 2 +- src/mkdocs.yml | 1 + 4 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 src/docs/ESP3D/Version_3.X/documentation/notifications/whatsapp.md diff --git a/src/docs/ESP3D/Version_3.X/documentation/notifications/index.md b/src/docs/ESP3D/Version_3.X/documentation/notifications/index.md index 4cd6f80f..45e456a8 100644 --- a/src/docs/ESP3D/Version_3.X/documentation/notifications/index.md +++ b/src/docs/ESP3D/Version_3.X/documentation/notifications/index.md @@ -32,6 +32,10 @@ A free service Please follow this [link](telegram/) for more information on how to setup a telegram notification service +### [What's App using callmebot ](https://www.callmebot.com/blog/free-api-whatsapp-messages/) +A free service + +Please follow this [link](whatsapp/) for more information on how to setup a what's app notification service The notification will also be sent to the WebUi diff --git a/src/docs/ESP3D/Version_3.X/documentation/notifications/whatsapp.md b/src/docs/ESP3D/Version_3.X/documentation/notifications/whatsapp.md new file mode 100644 index 00000000..b32090cb --- /dev/null +++ b/src/docs/ESP3D/Version_3.X/documentation/notifications/whatsapp.md @@ -0,0 +1,34 @@ +--- +archetype : "section" +title : " What's App Notification" +weight : 6 +--- +[What's App](https://www.whatsapp.com/) is free service + +Considering you have line account and you already installed line on you phone/PC: +To use automatic notifications you need to use a bot called [callmebot](https://www.callmebot.com/blog/free-api-whatsapp-messages/), no worry no registration needed, just get some API Key. + + +1 - Add the phone number `+34 644 95 42 75` into your Phone Contacts. (Name it it as you wish, I personally named it callmebot) + +2 - Using your What's App, send this message `I allow callmebot to send me messages` to the new Contact created. + +3 - Wait until you receive the message `API Activated for your phone number. Your APIKEY is 123123` from the bot. + +!!! info "Note" + If you don't receive the ApiKey in 2 minutes, please try again after 24hs. + +4 - Once API key is created you need to copy it + + +5 - Save the your phone number including country code as token 1 and the generated api key as token 2 in ESP3D, and set WhatsAPP as notification supplier +`[ESP610]type=WhatsApp T1=336XXXXXXXXX T2=XXXXXXXX` + +!!! info "Note" + Do not put the internationnal prefix on the phone number, just prefix with your country code. + +6 - type `[ESP610]` to verify (T1/T2 won't be displayed) + +7 - Try to send message: +`[ESP600]Hi there, test from ESP3D` + diff --git a/src/docs/ESP3D/Version_3.X/documentation/update/esp3dcnf.ini b/src/docs/ESP3D/Version_3.X/documentation/update/esp3dcnf.ini index 9293d132..8c0476cc 100644 --- a/src/docs/ESP3D/Version_3.X/documentation/update/esp3dcnf.ini +++ b/src/docs/ESP3D/Version_3.X/documentation/update/esp3dcnf.ini @@ -108,7 +108,7 @@ FTP_Passive_Port = 55600 #Auto notification AUTONOTIFICATION = Yes -#Notification type None / PushOver / Line / Email / Telegram / IFTTT / HomeAssistant +#Notification type None / PushOver / Line / Email / Telegram / IFTTT / HomeAssistant / WhatsApp NOTIF_TYPE = None #Notification token 1 string of 64 chars max diff --git a/src/mkdocs.yml b/src/mkdocs.yml index 1abb3603..dec70e41 100644 --- a/src/mkdocs.yml +++ b/src/mkdocs.yml @@ -77,6 +77,7 @@ nav: - ESP3D/Version_3.X/documentation/notifications/email_and_smtp.md - ESP3D/Version_3.X/documentation/notifications/ifttt.md - ESP3D/Version_3.X/documentation/notifications/telegram.md + - ESP3D/Version_3.X/documentation/notifications/whatsapp.md - ESP3D/Version_3.X/documentation/notifications/home-assistant.md - ESP3D/Version_3.X/documentation/camera/index.md - ESP3D/Version_3.X/documentation/update/index.md