Erste Schritte
Diese Dokumentation zeigt Ihnen, wie Sie über unsere API SMS versenden, Kontaktlisten importieren oder Ihre Konten verwalten können.. Um es zu benutzen, müssen Sie zunächst ein Konto erstellen. Hier können Sie ein Konto erstellenqui. Sobald Ihr Konto erstellt ist, empfehlen wir Ihnen, sich mit der Plattform zu verbinden, um einen Saldoalarm einzurichten. Mit diesem Alarm können Sie eine E-Mail oder ein SMS erhalten, wenn Ihre SMS-Kredit den von Ihnen festgelegten kritischen Grenzwert erreicht (z. B. 10, 100, 500 SMS).
Unsere Basis-URL für alle API Anfragen lautet https://api.smsup.ch
Authentifizierung
Sobald Sie ein Konto und ein Token-API erstellt haben, können Sie sich über den HTTP-Autorisierungs-Header wie folgt authentifizieren
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMTY1NiIsImlhdCI6MTUxOTEyMDg2NX0.ZnGgbDC0OI3hPm2UXyl4rxU9JlpMTMBcTJT8RVgJbtQ
Content-Types
Unsere API unterstützt application/json und application/xml Content-Types. Sie können einen Content-Type über den Accept-Header des HTTP-Protokolls angeben.
Unsere API erwartet und liefert standardmässig XML.
Accept: application/json
Anfragestatus
Hier ist eine Liste des Anfragestatus, welche unsere API versenden kann:
| status | Beschreibung |
|---|---|
| 1 | OK |
| -1 | Authentifizierungsfehler |
| -2 | XML-Fehler |
| -3 | Nicht genug Kredite |
| -4 | Falsche Datumsfrist |
| -5 | Ressource nicht gefunden |
| -6 | JSON-Fehler |
| -7 | Datenfehler |
| -8 | Ihre Kampagne wird derzeit bearbeitet. Dieser Status bedeutet nicht, dass Ihre SMS nicht verschickt wird, ganz im Gegenteil. Er soll Sie nur darauf hinweisen, dass Ihre Kampagne moderiert wird und schnell angenommen werden sollte. Es ist nicht notwendig, einen Mechanismus zur Wiederholung zu erstellen, da sonst dieselbe SMS mehrmals gesendet wird. |
| -99 | unbekannter Fehler |
Ein paar Worte über das SMS
Wie viele Zeichen hat ein SMS?
Ein SMS hat 160 Zeichen, das sind die internationalen Standards. In den 160 Zeichen sind Leerzeichen, Satzzeichen, Buchstaben, Zahlen und Sonderzeichen enthalten. Sie sind jedoch nicht auf diese 160 Zeichen beschränkt, Sie können problemlos eine längere Nachricht senden, es wird aber folgendermassen gezählt, 1 SMS pro 153 Zeichen.
Welche Zeichen sind in einem SMS erlaubt ?
Erlaubt sind die Zeichen, die in der Codierungstabelle standard GSM-7 definiert sind. Derzeit werden keine UTF-8-Zeichen oder alternative nationale Tabellen unterstützt.
Was sind die zwei Arten von professionellen SMS?
Obwohl es technisch gesehen nur ein SMS gibt, wird je nach Verwendung und Gesetzgebung zwischen zwei Arten von SMS unterschieden: die SMS-Alarmierung und das Werbe-SMS.
Das Werbe-SMS ist für kommerzielle Angebote, private Verkäufe, Geschenke, kommerzielle Veranstaltungen usw. gedacht.
Es ist nur zwischen 8 Uhr morgens und 20 Uhr abends von Montag bis Samstag erlaubt und an Sonn- und Feiertagen verboten. Für diese Art von SMS ist es obligatorisch, den Empfängern eine Möglichkeit zur Abmeldung vorzuschlagen, da es sich um ein kommerzielles Angebot handelt.
Die SMS-Alarmierung ist für Meetings, Versammlungen, Wetterwarnungen, Notfälle, Finanztransaktionen usw. gedacht.
Da es sich um informative SMS und nicht um kommerzielle SMS handelt, unterliegen sie nicht denselben Regeln.
SMS-Alarmierung können jeden Tag und zu jeder Zeit gesendet werden.
Es ist nicht zwingend erforderlich, einen Abmeldungs-Hinweis für die SMS-Alarmierung einzufügen, da diese keinen kommerziellen Charakter hat.
Die Wahl von Werbe-SMS oder SMS-Alarmierung bleibt Ihnen überlassen, wir bitten Sie, diese Regeln zu beachten. Wenn Sie sich nicht sicher sind, welche Art von SMS Sie versenden möchten, wenden Sie sich bitte an unseren Kundenservice, der Ihnen gerne weiterhilft. Seien Sie sich bewusst, dass Sie im Falle eines Problems aufgrund der Nichteinhaltung der Vorschriften, wenn Sie z. B. Marketing-SMS wie Transaktions-SMS ohne Abmeldungsmöglichkeit versenden, zur Verantwortung gezogen werden.
Wie funktioniert die Abmeldung?
Das Anbieten einer Möglichkeit zur Abmeldung ist für Werbe-SMS obligatorisch und für Alarmierung-SMS optional. In der Schweiz können Sie einfach einen Abmeldelink am Ende jeder Nachricht einfügen. Dies macht es den Empfängern leicht, sich durch das Klicken auf diesen Link abzumelden. In Frankreich wird, wenn der Absender der SMS nicht personalisiert ist, eine 5-stellige Nummer als Absender angezeigt, wenn die SMS empfangen wird. Die Empfänger können direkt auf diese Nummer mit STOP antworten, weshalb ein STOP-Hinweis nicht automatisch hinzugefügt wird. Wenn der Absender personalisiert ist, wird am Ende der Nachricht ein STOP-Hinweis hinzugefügt, damit sich der Empfänger abmelden kann (Beispiel: STOP SMS an 36173). Es ist wichtig zu beachten, dass jedes Land seine eigenen Regeln bezüglich des Absenders hat, zögern Sie also nicht, uns zu kontaktieren, um alles über das Land zu erfahren, in das Sie SMS senden möchten. Mit der Umsetzung der neuen europäischen Verordnung zum Schutz personenbezogener Daten, der DSGVO, stellen Sie sicher, dass Sie Ihre Marketing-SMS-Kampagnen nur an Kunden senden, die ihre Zustimmung zum Erhalt gegeben haben, und bieten Sie immer eine Möglichkeit zur Abmeldung an. In jedem Fall können Sie den '<-stop->'-Tag verwenden, um eine Abmeldenachricht (oder einen Link, je nach Land) einzufügen. Unsere API übernimmt automatisch die Konvertierung des Tags.
Wie funktioniert das Antoworten auf die SMS?
Um Antworten zu erhalten, müssen Sie den Absender nicht personalisieren und Ihn leer lassen. Ausserdem sind die Antworten nicht in allen Ländern möglich. Es gibt sie z.B. in Frankreich, Belgien und Schweiz. Wenn Antworten in dem Land, in das Sie den Versand tätigen, erlaubt sind, können Sie einen webhook erstellen, um sie zu empfangen.
Wie funktioniert die Absenderpersonalisierung?
Wie bereits erwähnt, hat jedes Land seine eigenen Regeln. Zum Beispiel kann der Absender für Frankreich und Schweiz bis zu 11 alphanumerische Zeichen enthalten (keine Sonderzeichen erlaubt). Denken Sie daran, dass Ihre Kontakte nicht antworten können, wenn der Absender personalisiert ist. Der Absender kann nicht für Belgien personnalisiert werden.. Für die Schweiz wird automatisch ein Standardabsender eingestellt, wenn er nicht personalisiert ist, um die Antworten zu erhalten. Es ist auch zu beachten, dass einige Handymodelle wie z. B. iPhones dafür bekannt sind, dass sie Absender mit 3 Zeichen oder weniger nicht korrekt anzeigen können.
Wozu sind short Links gedacht?
Das Hinzufügen einer URL zu Ihrer Nachricht kann vorteilhaft sein, würde aber zu viele Zeichen benötigen. Mit short Links können Sie einen 18 bis 20 Zeichen langen Link einfügen.. Ausserdem können Sie die Klicks verfolgen, so dass Sie sehen können, wann und wie oft Ihre Kontakte auf den Link klicken.
Welches Format sollen die Kontaktnummern haben, wenn eine Liste erstellt wird?
Wenn eine Kontaktliste erstellt wird, müssen die Nummern im internationalen Format sein E.164 (exemple: 41781234567). Seien Sie vorsichtig, jedes versandte SMS wird von den Operatoren berechnet, eine aktualisierte Liste ermöglicht es Ihnen, unnötige Kosten zu vermeiden. Denken Sie also daran, falsche Telefonnummern (zu kurze oder zu lange Nummern) zu entfernen, aber auch Nummern, die nicht mehr vergeben sind.
Wie lange werden die Daten aufbewahrt?
Wir lassen unseren Kunden die Wahl, wie lange ihre Daten aufbewahrt werden. Es ist daher möglich, die Aufbewahrungsdauer von Nachrichten, Kampagnen, Kontaktlisten und Umfragen auf unserer Plattform oder über die API anzupassen. Unabhängig davon, ob Sie die Aufbewahrung Ihrer Daten personalisieren möchten oder nicht, sollten Sie wissen, dass wir sie nicht unbegrenzt aufbewahren können: In allen Fällen ist eine maximale Aufbewahrungsdauer vorgeschrieben. Denken Sie also daran, falsche Telefonnummern (zu kurze oder zu lange Nummern) zu entfernen, aber auch Nummern, die nicht mehr vergeben sind.