CSOv210 de:SMS Gateway

Es ist möglich, Cryptshare for Outlook mit einem SMS-Gateway zu verbinden. Im konfigurierten Zustand erhält der Empfänger eine SMS mit folgenden Daten: Name des Absenders, Betreff des Cryptshare-Transfers, Tracking-ID und das Transfer-Passwort.
Wir unterstützen SMS-Gateways, die eine HTTP/S API anbieten, Requests vom Typ GET oder POST akzeptieren und eine Antwort vom Typ application/json oder text/plain zurückliefern.

Damit Benutzer in der Lage sind, das Transfer-Passwort via SMS an die Empfänger zu versenden, ist es erforderlich, eine entsprechende Konfiguration bereitzustellen. Im Folgenden wird erklärt, was bei der Einrichtung eines SMS-Gateways zu beachten ist. Alle nachfolgenden Einstellungen sind mit dem Config Creator vorzunehmen.

ACTIVATE SMS GATEWAY

Diese Checkbox aktiviert die Möglichkeit, das Transfer-Passwort via SMS zu versenden. Dem Benutzer wird daraufhin für die Passwort-Optionen Passwort generieren und Passwort vergeben die Option angeboten, das Passwort via SMS zu versenden.

GATEWAY URL

Gibt den HTTP/HTTPS-Endpunkt des SMS-Gateways an.

REQUEST TYPE

Gibt an, in welcher Form die HTTP-Anfrage an das SMS-Gateway übergeben werden soll. Es stehen hierbei die Optionen GET (kein Request-Body), POST_FORM (Request-Body vom Typ application/x-www-form-urlencoded) und POST_RAW (Request-Body vom Typ application/json) zur Verfügung.

REQUEST BODY TEMPLATE (nur bei POST_RAW)

Erfordert das von Ihnen genutzte SMS-Gateway ein JSON Request-Body, so können Sie hier das JSON-Body-Template definieren. Es stehen Ihnen folgende Platzhalter zur Verfügung:

• from: Der vollständiger Name des Absenders im Format "Vorname Nachname".
• to: Die Rufnummer des Empfängers gemäß vorheriger Eingabe durch den Benutzer.
• message: Die SMS-Nachricht, die an den Empfänger versendet wird. Der Inhalt dieser Nachricht ist in einer Vorlage definiert, die als Teil der Outlook-Sprachpakete (Version 12 und höher) mitgeliefert wird.

Alle angegebenen Platzhalter sind mit zwei geschweiften Klammern (z.B. {{from}}) zu umschließen. Beispiel:

{
    "senderName": "{{from}}",
    "recipient": "{{to}}",
    "content": "{{message}}",n
    "custom": "parameter"
}

USE CREDENTIALS

Falls Ihr SMS-Gateway eine Basisauthentifizierung nach RFC 7617 erfordert, können Sie die entsprechenden Benutzerdaten hier eingeben.

HTTP HEADERS

Erlaubt Ihnen, ggf. erforderliche HTTP-Header zu übergeben.

HTTP PARAMETERS

Erlaubt Ihnen bspw. bei Nutzung des Request-Typs GET oder POST_FORM, die SMS-Informationen als HTTP-Parameter zu übergeben. Bei der Option POST_FORM wird der konstruierte Query-String in den Body der POST-Anfrage platziert. Aktivieren Sie für Parameter wie bspw. den API-Schlüssel die Option Encrypt value, damit dieser Parameter nicht im Klartext in der Konfigurationsdatei abgelegt wird. Beachten Sie jedoch, dass dies keine sichere Verschlüsselung darstellt und lediglich Benutzer davon abhalten soll, Zugriff auf diese Parameter zu erlangen.

RESPONSE TYPE

Gibt an, in welcher Form die HTTP-Antwort des SMS-Gateways erwartet wird. Es stehen die Optionen text/plain und application/json zur Verfügung.

EXPECTED RESPONSE ON SUCCESS

Gibt an, welche Antwort erwartet wird, um einen erfolgreichen SMS-Versand zu signalisieren. Entspricht die tatsächliche Antwort nicht der erwarteten Antwort, wird dem Benutzer eine Fehlermeldung präsentiert. Die Eingabe wird als regulärer Ausdruck evaluiert; daher entspricht bspw. die Eingabe 100 einer Volltextsuche nach dieser Nummer. Sie können auch komplexere Ausdrücke wie 100|101 verwenden, falls bspw. eine dieser Antworten einen erfolgreichen Versand signalisiert.

RESPONSE MESSAGE LOCATION (nur bei HTTP-Antwort der Form application/json)

Gibt an, welche JSON-Property den Status des SMS-Versands liefert. Geben Sie den Pfad der Property in JsonPath an, damit auch verschachtelte Properties angegeben werden können. Bitte beachten Sie, dass Sie kein Präfix "$." angeben müssen, da das Ergebnis implizit als "root member object" angesehen wird.

ERROR MESSAGE LOCATION (nur bei HTTP-Antwort der Form application/json)

Gibt an, welche JSON-Property die Fehlermeldung im Fehlerfall liefert. Geben Sie den Pfad der Property in JsonPath an, damit auch verschachtelte Properties angegeben werden können. Diese Fehlermeldung wird dem Benutzer präsentiert, falls die Antwort des SMS-Gateways nicht der erwarteten Antwort entspricht. Bitte beachten Sie, dass Sie kein Präfix "$." angeben müssen, da das Ergebnis implizit als "root member object" angesehen wird.