Cellsynt mobile services (#4625)

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

server/notification-providers/cellsynt.js

@@ -0,0 +1,39 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+
+class Cellsynt extends NotificationProvider {
+    name = "Cellsynt";
+
+    /**
+     * @inheritdoc
+     */
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        const okMsg = "Sent Successfully.";
+        const data = {
+            // docs at https://www.cellsynt.com/en/sms/api-integration
+            params: {
+                "username": notification.cellsyntLogin,
+                "password": notification.cellsyntPassword,
+                "destination": notification.cellsyntDestination,
+                "text": msg.replace(/[^\x00-\x7F]/g, ""),
+                "originatortype": notification.cellsyntOriginatortype,
+                "originator": notification.cellsyntOriginator,
+                "allowconcat": notification.cellsyntAllowLongSMS ? 6 : 1
+            }
+        };
+        try {
+            const resp = await axios.post("https://se-1.cellsynt.net/sms.php", null, data);
+            if (resp.data == null ) {
+                throw new Error("Could not connect to Cellsynt, please try again.");
+            } else if (resp.data.includes("Error:")) {
+                resp.data = resp.data.replaceAll("Error:", "");
+                throw new Error(resp.data);
+            }
+            return okMsg;
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+}
+
+module.exports = Cellsynt;

server/notification.js

@@ -56,6 +56,7 @@ const SMSManager = require("./notification-providers/smsmanager");
 const ServerChan = require("./notification-providers/serverchan");
 const ZohoCliq = require("./notification-providers/zoho-cliq");
 const GtxMessaging = require("./notification-providers/gtx-messaging");
+const Cellsynt = require("./notification-providers/cellsynt");
 
 class Notification {
 
@@ -129,6 +130,7 @@ class Notification {
             new GoAlert(),
             new ZohoCliq(),
             new GtxMessaging(),
+            new Cellsynt(),
         ];
         for (let item of list) {
             if (! item.name) {

src/components/NotificationDialog.vue

@@ -153,7 +153,8 @@ export default {
                 "webhook": "Webhook",
                 "GoAlert": "GoAlert",
                 "ZohoCliq": "ZohoCliq",
-                "gtxmessaging": "GtxMessaging"
+                "gtxmessaging": "GtxMessaging",
+                "Cellsynt": "Cellsynt"
             };
 
             // Put notifications here if it's not supported in most regions or its documentation is not in English

src/components/notifications/Cellsynt.vue

@@ -0,0 +1,54 @@
+<template>
+    <div class="mb-3">
+        <label for="cellsynt-login" class="form-label">{{ $t("Username") }}</label>
+        <input id="cellsynt-login" v-model="$parent.notification.cellsyntLogin" type="text" class="form-control" required>
+    </div>
+    <div class="mb-3">
+        <label for="cellsynt-key" class="form-label">{{ $t("Password") }}</label>
+        <HiddenInput id="cellsynt-key" v-model="$parent.notification.cellsyntPassword" :required="true" autocomplete="new-password"></HiddenInput>
+    </div>
+    <div class="mb-3">
+        <label for="cellsynt-Originatortype" class="form-label">{{ $t("Originator type") }}</label>
+        <select id="cellsynt-Originatortype" v-model="$parent.notification.cellsyntOriginatortype" :required="true" class="form-select">
+            <option value="alpha">{{ $t("Alphanumeric (recommended)") }}</option>
+            <option value="numeric">{{ $t("Telephone number") }}</option>
+        </select>
+        <div class="form-text">
+            <p><b>{{ $t("Alphanumeric (recommended)") }}:</b><br /> {{ $t("Alphanumeric string (max 11 alphanumeric characters). Recipients can not reply to the message.") }}</p>
+            <p><b>{{ $t("Telephone number") }}:</b><br /> {{ $t("Numeric value (max 15 digits) with telephone number on international format without leading 00 (example UK number 07920 110 000 should be set as 447920110000). Recipients can reply to the message.") }}</p>
+        </div>
+    </div>
+    <div class="mb-3">
+        <label for="cellsynt-originator" class="form-label">{{ $t("Originator") }} <small>({{ $parent.notification.cellsyntOriginatortype === 'alpha' ? $t("max 11 alphanumeric characters") : $t("max 15 digits") }})</small></label>
+        <input v-if="$parent.notification.cellsyntOriginatortype === 'alpha'" id="cellsynt-originator" v-model="$parent.notification.cellsyntOriginator" type="text" class="form-control" pattern="[a-zA-Z0-9\s]+" maxlength="11" required>
+        <input v-else id="cellsynt-originator" v-model="$parent.notification.cellsyntOriginator" type="number" class="form-control" pattern="[0-9]+" maxlength="15" required>
+        <div class="form-text"><p>{{ $t("Visible on recipient's mobile phone as originator of the message. Allowed values and function depends on parameter originatortype.") }}</p></div>
+    </div>
+    <div class="mb-3">
+        <label for="cellsynt-destination" class="form-label">{{ $t("Destination") }}</label>
+        <input id="cellsynt-destination" v-model="$parent.notification.cellsyntDestination" type="text" class="form-control" required>
+        <div class="form-text"><p>{{ $t("Recipient's telephone number using international format with leading 00 followed by country code, e.g. 00447920110000 for the UK number 07920 110 000 (max 17 digits in total). Max 25000 comma separated recipients per HTTP request.") }}</p></div>
+    </div>
+    <div class="form-check form-switch">
+        <input id="cellsynt-allow-long" v-model="$parent.notification.cellsyntAllowLongSMS" type="checkbox" class="form-check-input">
+        <label for="cellsynt-allow-long" class="form-label">{{ $t("Allow Long SMS") }}</label>
+        <div class="form-text">{{ $t("Split long messages into up to 6 parts. 153 x 6 = 918 characters.") }}</div>
+    </div>
+    <i18n-t tag="p" keypath="More info on:" style="margin-top: 8px;">
+        <a href="https://www.cellsynt.com/en/" target="_blank">https://www.cellsynt.com/en/</a>
+    </i18n-t>
+</template>
+
+<script>
+import HiddenInput from "../HiddenInput.vue";
+
+export default {
+    components: {
+        HiddenInput
+    },
+    mounted() {
+        this.$parent.notification.cellsyntOriginatortype ||= "alpha";
+        this.$parent.notification.cellsyntOriginator ||= "uptimekuma";
+    }
+};
+</script>

src/components/notifications/index.js

@@ -54,6 +54,7 @@ import WeCom from "./WeCom.vue";
 import GoAlert from "./GoAlert.vue";
 import ZohoCliq from "./ZohoCliq.vue";
 import Splunk from "./Splunk.vue";
+import Cellsynt from "./Cellsynt.vue";
 
 /**
  * Manage all notification form.
@@ -116,6 +117,7 @@ const NotificationFormList = {
     "ServerChan": ServerChan,
     "ZohoCliq": ZohoCliq,
     "gtxmessaging": GtxMessaging,
+    "Cellsynt": Cellsynt,
 };
 
 export default NotificationFormList;

src/lang/en.json

@@ -892,5 +892,18 @@
     "From Phone Number / Transmission Path Originating Address (TPOA)": "From Phone Number / Transmission Path Originating Address (TPOA)",
     "gtxMessagingFromHint": "On mobile phones, your recipients sees the TPOA displayed as the sender of the message. Allowed are up to 11 alphanumeric characters, a shortcode, the local longcode or international numbers ({e164}, {e212} or {e214})",
     "To Phone Number": "To Phone Number",
-    "gtxMessagingToHint": "International format, with leading \"+\" ({e164}, {e212} or {e214})"
+    "gtxMessagingToHint": "International format, with leading \"+\" ({e164}, {e212} or {e214})",
+    "Originator type": "Originator type",
+    "Alphanumeric (recommended)": "Alphanumeric (recommended)",
+    "Telephone number": "Telephone number",
+    "cellsyntOriginatortypeAlphanumeric": "Alphanumeric string (max 11 alphanumeric characters). Recipients can not reply to the message.",
+    "cellsyntOriginatortypeNumeric": "Numeric value (max 15 digits) with telephone number on international format without leading 00 (example UK number 07920 110 000 should be set as 447920110000). Recipients can reply to the message.",
+    "Originator": "Originator",
+    "cellsyntOriginator": "Visible on recipient's mobile phone as originator of the message. Allowed values and function depends on parameter originatortype.",
+    "Destination": "Destination",
+    "cellsyntDestination": "Recipient's telephone number using international format with leading 00 followed by country code, e.g. 00447920110000 for the UK number 07920 110 000 (max 17 digits in total). Max 25000 comma separated recipients per HTTP request.",
+    "Allow Long SMS": "Allow Long SMS",
+    "cellsyntSplitLongMessages": "Split long messages into up to 6 parts. 153 x 6 = 918 characters.",
+    "max 15 digits": "max 15 digits",
+    "max 11 alphanumeric characters": "max 11 alphanumeric characters"
 }