feat: new notification provider `46elks` (#5184)

Co-authored-by: Frank Elsinga <frank@elsinga.de>

server/notification-providers/46elks.js

@@ -0,0 +1,35 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+
+class Elks extends NotificationProvider {
+    name = "Elks";
+
+    /**
+     * @inheritdoc
+     */
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        const okMsg = "Sent Successfully.";
+        const url = "https://api.46elks.com/a1/sms";
+
+        try {
+            let data = new URLSearchParams();
+            data.append("from", notification.elksFromNumber);
+            data.append("to", notification.elksToNumber );
+            data.append("message", msg);
+
+            const config = {
+                headers: {
+                    "Authorization": "Basic " + Buffer.from(`${notification.elksUsername}:${notification.elksAuthToken}`).toString("base64")
+                }
+            };
+
+            await axios.post(url, data, config);
+
+            return okMsg;
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+}
+
+module.exports = Elks;

server/notification.js

@@ -11,6 +11,7 @@ const CallMeBot = require("./notification-providers/call-me-bot");
 const SMSC = require("./notification-providers/smsc");
 const DingDing = require("./notification-providers/dingding");
 const Discord = require("./notification-providers/discord");
+const Elks = require("./notification-providers/46elks");
 const Feishu = require("./notification-providers/feishu");
 const FreeMobile = require("./notification-providers/freemobile");
 const GoogleChat = require("./notification-providers/google-chat");
@@ -95,6 +96,7 @@ class Notification {
             new SMSC(),
             new DingDing(),
             new Discord(),
+            new Elks(),
             new Feishu(),
             new FreeMobile(),
             new GoogleChat(),

src/components/NotificationDialog.vue

@@ -118,6 +118,7 @@ export default {
                 "clicksendsms": "ClickSend SMS",
                 "CallMeBot": "CallMeBot (WhatsApp, Telegram Call, Facebook Messanger)",
                 "discord": "Discord",
+                "Elks": "46elks",
                 "GoogleChat": "Google Chat (Google Workspace)",
                 "gorush": "Gorush",
                 "gotify": "Gotify",

src/components/notifications/46elks.vue

@@ -0,0 +1,48 @@
+<template>
+    <div class="mb-3">
+        <label for="ElksUsername" class="form-label">{{ $t("Username") }}</label>
+        <input id="ElksUsername" v-model="$parent.notification.elksUsername" type="text" class="form-control" required>
+        <label for="ElksPassword" class="form-label">{{ $t("Password") }}</label>
+    </div>
+    <div class="form-text">
+        <HiddenInput id="ElksPassword" v-model="$parent.notification.elksAuthToken" :required="true" autocomplete="new-password"></HiddenInput>
+        <i18n-t tag="p" keypath="Can be found on:">
+            <a href="https://46elks.com/account" target="_blank">https://46elks.com/account</a>
+        </i18n-t>
+    </div>
+    <div class="mb-3">
+        <label for="Elks-from-number" class="form-label">{{ $t("From") }}</label>
+        <input id="Elks-from-number" v-model="$parent.notification.elksFromNumber" type="text" class="form-control" required>
+        <div class="form-text">
+            {{ $t("Either a text sender ID or a phone number in E.164 format if you want to be able to receive replies.") }}
+            <i18n-t tag="p" keypath="More info on:">
+                <a href="https://46elks.se/kb/text-sender-id" target="_blank">https://46elks.se/kb/text-sender-id</a>
+            </i18n-t>
+        </div>
+    </div>
+
+    <div class="mb-3">
+        <label for="Elks-to-number" class="form-label">{{ $t("To Number") }}</label>
+        <input id="Elks-to-number" v-model="$parent.notification.elksToNumber" type="text" class="form-control" required>
+        <div class="form-text">
+            {{ $t("The phone number of the recipient in E.164 format.") }}
+            <i18n-t tag="p" keypath="More info on:">
+                <a href="https://46elks.se/kb/e164" target="_blank">https://46elks.se/kb/e164</a>
+            </i18n-t>
+        </div>
+    </div>
+
+    <i18n-t tag="p" keypath="More info on:" style="margin-top: 8px;">
+        <a href="https://46elks.com/docs/send-sms" target="_blank">https://46elks.com/docs/send-sms</a>
+    </i18n-t>
+</template>
+
+<script>
+import HiddenInput from "../HiddenInput.vue";
+
+export default {
+    components: {
+        HiddenInput,
+    },
+};
+</script>

src/components/notifications/index.js

@@ -9,6 +9,7 @@ import CallMeBot from "./CallMeBot.vue";
 import SMSC from "./SMSC.vue";
 import DingDing from "./DingDing.vue";
 import Discord from "./Discord.vue";
+import Elks from "./46elks.vue";
 import Feishu from "./Feishu.vue";
 import FreeMobile from "./FreeMobile.vue";
 import GoogleChat from "./GoogleChat.vue";
@@ -82,6 +83,7 @@ const NotificationFormList = {
     "smsc": SMSC,
     "DingDing": DingDing,
     "discord": Discord,
+    "Elks": Elks,
     "Feishu": Feishu,
     "FreeMobile": FreeMobile,
     "GoogleChat": GoogleChat,

src/lang/en.json

@@ -1047,5 +1047,9 @@
     "Pop":"Pop",
     "Custom sound to override default notification sound": "Custom sound to override default notification sound",
     "Time Sensitive (iOS Only)": "Time Sensitive (iOS Only)",
-    "Time sensitive notifications will be delivered immediately, even if the device is in do not disturb mode.": "Time sensitive notifications will be delivered immediately, even if the device is in do not disturb mode."
+    "Time sensitive notifications will be delivered immediately, even if the device is in do not disturb mode.": "Time sensitive notifications will be delivered immediately, even if the device is in do not disturb mode.",
+    "From":"From",
+    "Can be found on:": "Can be found on: {0}",
+    "The phone number of the recipient in E.164 format.": "The phone number of the recipient in E.164 format.",
+    "Either a text sender ID or a phone number in E.164 format if you want to be able to receive replies.":"Either a text sender ID or a phone number in E.164 format if you want to be able to receive replies."
 }