Click send sms integration for notifications

2024-11-12 16:44:12 -08:00 · 2021-10-24 15:17:29 -04:00 · 2021-10-24 15:17:29 -04:00 · bc68088350
parent 8a481a1be0
commit bc68088350
29 changed files with 394 additions and 286 deletions
--- a/server/notification-providers/clicksendsms.js
+++ b/server/notification-providers/clicksendsms.js
@ -0,0 +1,43 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+
+class ClickSendSMS extends NotificationProvider {
+
+    name = "clicksendsms";
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        let okMsg = "Sent Successfully.";
+        try {
+            console.log({ notification });
+            let config = {
+                headers: {
+                    "Content-Type": "application/json",
+                    "Authorization": "Basic " + Buffer.from(notification.clicksendsmsLogin + ":" + notification.clicksendsmsPassword).toString('base64'),
+                    "Accept": "text/json",
+                }
+            };
+            let data = {
+                messages: [
+                    {
+                        "body": msg.replace(/[^\x00-\x7F]/g, ""),
+                        // TODO: To phone number concept to be added
+                        "to": "+61411111111",
+                        "source": "uptime-kuma",
+                        "from": notification.clicksendsmsSenderName,
+                    }
+                ]
+            };
+            let resp = await axios.post("https://rest.clicksend.com/v3/sms/send", data, config);
+            if (resp.data.http_code !== 200) {
+                let error = "Something gone wrong. Api returned " + resp.data.response.status + ".";
+                this.throwGeneralAxiosError(error);
+            }
+
+            return okMsg;
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+}
+
+module.exports = ClickSendSMS;
--- a/server/notification.js
+++ b/server/notification.js
@ -8,6 +8,7 @@ const Mattermost = require("./notification-providers/mattermost");
 const Matrix = require("./notification-providers/matrix");
 const Octopush = require("./notification-providers/octopush");
 const PromoSMS = require("./notification-providers/promosms");
+const ClickSendSMS = require("./notification-providers/clicksendsms");
 const Pushbullet = require("./notification-providers/pushbullet");
 const Pushover = require("./notification-providers/pushover");
 const Pushy = require("./notification-providers/pushy");
@ -45,6 +46,7 @@ class Notification {
            new Matrix(),
            new Octopush(),
            new PromoSMS(),
+            new ClickSendSMS(),
            new Pushbullet(),
            new Pushover(),
            new Pushy(),
--- a/src/components/notifications/ClickSendSMS.vue
+++ b/src/components/notifications/ClickSendSMS.vue
@ -0,0 +1,35 @@
+<template>
+    <div class="mb-3">
+        <label for="clicksendsms-login" class="form-label">API Username</label>
+        <div class="form-text">
+            {{ $t("apiCredentials") }}
+            <a href="http://dashboard.clicksend.com/account/subaccounts" target="_blank">here</a>
+        </div>
+        <input id="clicksendsms-login" v-model="$parent.notification.clicksendsmsLogin" type="text" class="form-control" required>
+        <label for="clicksendsms-key" class="form-label">API Key</label>
+        <HiddenInput id="clicksendsms-key" v-model="$parent.notification.clicksendsmsPassword" :required="true" autocomplete="one-time-code"></HiddenInput>
+    </div>
+    <div class="mb-3">
+        <div class="form-text">
+            {{ $t("checkPrice", [$t("clicksendsms")]) }}
+            <a href="https://www.clicksend.com/us/pricing" target="_blank">here</a>
+        </div>
+    </div>
+    <div class="mb-3">
+        <label for="clicksendsms-sender-name" class="form-label">From Name/Number -
+            <a href="https://help.clicksend.com/article/4kgj7krx00-what-is-a-sender-id-or-sender-number" target="_blank">More Info</a>
+        </label>
+        <input id="clicksendsms-sender-name" v-model="$parent.notification.clicksendsmsSenderName" type="text" minlength="3" maxlength="11" class="form-control">
+        <div class="form-text">Leave blank to use a shared sender number.</div>
+    </div>
+</template>
+
+<script>
+import HiddenInput from "../HiddenInput.vue";
+
+export default {
+    components: {
+        HiddenInput,
+    },
+};
+</script>
--- a/src/components/notifications/index.js
+++ b/src/components/notifications/index.js
@ -11,6 +11,7 @@ import Pushover from "./Pushover.vue";
 import Pushy from "./Pushy.vue";
 import Octopush from "./Octopush.vue";
 import PromoSMS from "./PromoSMS.vue";
+import ClickSendSMS from "./ClickSendSMS.vue";
 import LunaSea from "./LunaSea.vue";
 import Feishu from "./Feishu.vue";
 import Apprise from "./Apprise.vue";
@ -40,6 +41,7 @@ const NotificationFormList = {
    "pushy": Pushy,
    "octopush": Octopush,
    "promosms": PromoSMS,
+    "clicksendsms": ClickSendSMS,
    "lunasea": LunaSea,
    "Feishu": Feishu,
    "AliyunSMS": AliyunSMS,
--- a/src/languages/bg-BG.js
+++ b/src/languages/bg-BG.js
@ -191,6 +191,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Поддържа 50+ услуги за инвестяване)",
    pushbullet: "Pushbullet",
--- a/src/languages/da-DK.js
+++ b/src/languages/da-DK.js
@ -193,6 +193,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
--- a/src/languages/de-DE.js
+++ b/src/languages/de-DE.js
@ -192,6 +192,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Unterstützung für 50+ Benachrichtigungsdienste)",
    pushbullet: "Pushbullet",
--- a/src/languages/en.js
+++ b/src/languages/en.js
@ -241,6 +241,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
@ -257,6 +258,7 @@ export default {
    octopushTypePremium: "Premium (Fast - recommended for alerting)",
    octopushTypeLowCost: "Low Cost (Slow - sometimes blocked by operator)",
    checkPrice: "Check {0} prices:",
+    apiCredentials: "API credentials",
    octopushLegacyHint: "Do you use the legacy version of Octopush (2011-2020) or the new version?",
    "Check octopush prices": "Check octopush prices {0}.",
    octopushPhoneNumber: "Phone number (intl format, eg : +33612345678) ",
--- a/src/languages/es-ES.js
+++ b/src/languages/es-ES.js
@ -193,6 +193,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Admite más de 50 servicios de notificación)",
    pushbullet: "Pushbullet",
--- a/src/languages/et-EE.js
+++ b/src/languages/et-EE.js
@ -192,6 +192,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (vahendab üle 65 teavitusteenust)",
    pushbullet: "Pushbullet",
--- a/src/languages/fa.js
+++ b/src/languages/fa.js
@ -200,6 +200,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
--- a/src/languages/fr-FR.js
+++ b/src/languages/fr-FR.js
@ -236,6 +236,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
--- a/src/languages/hu.js
+++ b/src/languages/hu.js
@ -191,6 +191,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
--- a/src/languages/id-ID.js
+++ b/src/languages/id-ID.js
@ -236,6 +236,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Mendukung 50+ layanan notifikasi)",
    pushbullet: "Pushbullet",
--- a/src/languages/it-IT.js
+++ b/src/languages/it-IT.js
@ -192,6 +192,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
--- a/src/languages/ja.js
+++ b/src/languages/ja.js
@ -193,6 +193,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
--- a/src/languages/ko-KR.js
+++ b/src/languages/ko-KR.js
@ -235,6 +235,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (50개 이상 알림 서비스)",
    pushbullet: "Pushbullet",
--- a/src/languages/nb-NO.js
+++ b/src/languages/nb-NO.js
@ -236,6 +236,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
--- a/src/languages/nl-NL.js
+++ b/src/languages/nl-NL.js
@ -193,6 +193,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
@ -203,5 +204,5 @@ export default {
    Headers: "Headers",
    PushUrl: "Push URL",
    HeadersInvalidFormat: "The request headers is geen geldige JSON: ",
-    BodyInvalidFormat: "De request body is geen geldige JSON: "
+    BodyInvalidFormat: "De request body is geen geldige JSON: ",
 };
--- a/src/languages/pl.js
+++ b/src/languages/pl.js
@ -236,6 +236,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Obsługuje 50+ usług powiadomień)",
    pushbullet: "Pushbullet",
--- a/src/languages/pt-BR.js
+++ b/src/languages/pt-BR.js
@ -192,6 +192,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
--- a/src/languages/ru-RU.js
+++ b/src/languages/ru-RU.js
@ -197,6 +197,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Поддержка 50+ сервисов уведомлений)",
    pushbullet: "Pushbullet",
--- a/src/languages/sr-latn.js
+++ b/src/languages/sr-latn.js
@ -193,6 +193,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
--- a/src/languages/sr.js
+++ b/src/languages/sr.js
@ -193,6 +193,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
--- a/src/languages/sv-SE.js
+++ b/src/languages/sv-SE.js
@ -193,6 +193,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
--- a/src/languages/tr-TR.js
+++ b/src/languages/tr-TR.js
@ -192,6 +192,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (Support 50+ Notification services)",
    pushbullet: "Pushbullet",
--- a/src/languages/vi.js
+++ b/src/languages/vi.js
@ -236,6 +236,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Thông báo (Hỗ trợ 50+ dịch vụ thông báo)",
    pushbullet: "Pushbullet",
--- a/src/languages/zh-CN.js
+++ b/src/languages/zh-CN.js
@ -197,6 +197,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (支持50+种通知服务)",
    pushbullet: "Pushbullet",
--- a/src/languages/zh-HK.js
+++ b/src/languages/zh-HK.js
@ -193,6 +193,7 @@ export default {
    pushy: "Pushy",
    octopush: "Octopush",
    promosms: "PromoSMS",
+    clicksendsms: "ClickSend SMS",
    lunasea: "LunaSea",
    apprise: "Apprise (支援 50 多種通知)",
    pushbullet: "Pushbullet",