New notification provider: SMS Partner API (#4769)

Co-authored-by: Nicolas Verlhiac <nicolas@novariom.com>
Co-authored-by: Frank Elsinga <frank@elsinga.de>

server/notification-providers/smspartner.js

@@ -0,0 +1,46 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+
+class SMSPartner extends NotificationProvider {
+    name = "SMSPartner";
+
+    /**
+     * @inheritdoc
+     */
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        const okMsg = "Sent Successfully.";
+        const url = "https://api.smspartner.fr/v1/send";
+
+        try {
+            // smspartner does not support non ascii characters and only a maximum 639 characters
+            let cleanMsg = msg.replace(/[^\x00-\x7F]/g, "").substring(0, 639);
+
+            let data = {
+                "apiKey": notification.smspartnerApikey,
+                "sender": notification.smspartnerSenderName.substring(0, 11),
+                "phoneNumbers": notification.smspartnerPhoneNumber,
+                "message": cleanMsg,
+            };
+
+            let config = {
+                headers: {
+                    "Content-Type": "application/json",
+                    "cache-control": "no-cache",
+                    "Accept": "application/json",
+                }
+            };
+
+            let resp = await axios.post(url, data, config);
+
+            if (resp.data.success !== true) {
+                throw Error(`Api returned ${resp.data.response.status}.`);
+            }
+
+            return okMsg;
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+}
+
+module.exports = SMSPartner;

server/notification.js

@@ -43,6 +43,7 @@ const RocketChat = require("./notification-providers/rocket-chat");
 const SerwerSMS = require("./notification-providers/serwersms");
 const Signal = require("./notification-providers/signal");
 const Slack = require("./notification-providers/slack");
+const SMSPartner = require("./notification-providers/smspartner");
 const SMSEagle = require("./notification-providers/smseagle");
 const SMTP = require("./notification-providers/smtp");
 const Squadcast = require("./notification-providers/squadcast");
@@ -123,6 +124,7 @@ class Notification {
             new SerwerSMS(),
             new Signal(),
             new SMSManager(),
+            new SMSPartner(),
             new Slack(),
             new SMSEagle(),
             new SMTP(),

src/components/NotificationDialog.vue

@@ -147,6 +147,7 @@ export default {
                 "slack": "Slack",
                 "squadcast": "SquadCast",
                 "SMSEagle": "SMSEagle",
+                "SMSPartner": "SMS Partner",
                 "smtp": this.$t("smtp"),
                 "stackfield": "Stackfield",
                 "teams": "Microsoft Teams",

src/components/notifications/SMSPartner.vue

@@ -0,0 +1,39 @@
+<template>
+    <div class="mb-3">
+        <label for="smspartner-key" class="form-label">{{ $t("API Key") }}</label>
+        <HiddenInput id="smspartner-key" v-model="$parent.notification.smspartnerApikey" :required="true" autocomplete="new-password"></HiddenInput>
+        <div class="form-text">
+            <i18n-t keypath="smspartnerApiurl" as="div" class="form-text">
+                <a href="https://my.smspartner.fr/dashboard/api" target="_blank">my.smspartner.fr/dashboard/api</a>
+            </i18n-t>
+        </div>
+    </div>
+    <div class="mb-3">
+        <label for="smspartner-phone-number" class="form-label">{{ $t("smspartnerPhoneNumber") }}</label>
+        <input id="smspartner-phone-number" v-model="$parent.notification.smspartnerPhoneNumber" type="text" minlength="3" maxlength="20" pattern="^[\d+,]+$" class="form-control" required>
+        <div class="form-text">
+            <i18n-t keypath="smspartnerPhoneNumberHelptext" as="div" class="form-text">
+                <code>+336xxxxxxxx</code>
+                <code>+496xxxxxxxx</code>
+                <code>,</code>
+            </i18n-t>
+        </div>
+    </div>
+    <div class="mb-3">
+        <label for="smspartner-sender-name" class="form-label">{{ $t("smspartnerSenderName") }}</label>
+        <input id="smspartner-sender-name" v-model="$parent.notification.smspartnerSenderName" type="text" minlength="3" maxlength="11" pattern="^[a-zA-Z0-9]*$" class="form-control" required>
+        <div class="form-text">
+            {{ $t("smspartnerSenderNameInfo") }}
+        </div>
+    </div>
+</template>
+
+<script>
+import HiddenInput from "../HiddenInput.vue";
+
+export default {
+    components: {
+        HiddenInput,
+    },
+};
+</script>

src/components/notifications/index.js

@@ -43,6 +43,7 @@ import ServerChan from "./ServerChan.vue";
 import SerwerSMS from "./SerwerSMS.vue";
 import Signal from "./Signal.vue";
 import SMSManager from "./SMSManager.vue";
+import SMSPartner from "./SMSPartner.vue";
 import Slack from "./Slack.vue";
 import Squadcast from "./Squadcast.vue";
 import SMSEagle from "./SMSEagle.vue";
@@ -110,6 +111,7 @@ const NotificationFormList = {
     "serwersms": SerwerSMS,
     "signal": Signal,
     "SMSManager": SMSManager,
+    "SMSPartner": SMSPartner,
     "slack": Slack,
     "squadcast": Squadcast,
     "SMSEagle": SMSEagle,

src/lang/en.json

@@ -753,6 +753,11 @@
     "smseagleUrl": "Your SMSEagle device URL",
     "smseagleEncoding": "Send as Unicode",
     "smseaglePriority": "Message priority (0-9, default = 0)",
+    "smspartnerApiurl": "You can find your API key in your dashboard at {0}",
+    "smspartnerPhoneNumber": "Phone number(s)",
+    "smspartnerPhoneNumberHelptext": "The number must be in the international format {0}, {1}. Multiple numbers must be separated by {2}",
+    "smspartnerSenderName": "SMS Sender Name",
+    "smspartnerSenderNameInfo": "Must be between 3..=11 regular characters",
     "Recipient Number": "Recipient Number",
     "From Name/Number": "From Name/Number",
     "Leave blank to use a shared sender number.": "Leave blank to use a shared sender number.",