1. Home
  2. Gateway
  3. HTTP API
  4. SMS Versand

SMS Versand

Nutzen Sie diese API zum Versand von SMS mit zahlreichen Funktionen an einen oder mehrere Empfänger gleichzeitig.

Bitte richten Sie Ihren Request an folgende URL:
https://gateway.sms77.io/api/sms

Benötigte Parameter

Zusätzlich zur Authentifizierung werden folgende Parameter benötigt:

Parameter Beschreibung Beispiele
to Empfängernummer – möglich sind Nummern und Adressbucheinträge (Gruppen und Kontakte).
Mehrere Empfänger können per Komma separiert angegeben werden.
0049171999999999
0171999999999
49171999999999
+49171999999999
Gruppe1
0171999999999,Gruppe1,Peter
text Der Nachrichteninhalt der Textnachricht.
Die Zeichenlänge kann 1520 Zeichen nicht überschreiten.
Bei mehr als 160 Zeichen wird der Text auf mehrere SMS verteilt, welche einzeln berechnet werden.
Guten Tag Herr Weber, vergessen Sie bitte nicht Ihren Termin für die professionelle Zahnreinigung am Dienstag um 12:00. Viele Grüße von Zahnarzt Mustermann.

Optionale Parameter

1 = Der Parameter ist aktiv
0 = Der Parameter ist inaktiv

Parameter Beschreibung Beispiel(e)
from Absendernummer. Dieser darf maximal 11 alphanumerische oder 16 numerische Zeichen enthalten. Absender
01761234567890
FirmaABC
debug Falls aktiviert werden keine SMS verschickt oder berechnet. 1
0
delay Datum/Zeit für zeitversetzten Versand.
Wahlweise Unix-Timestamp oder ein Zeitstempel im Format yyyy-mm-dd hh:ii.
1141511104
2016-03-14 23:25:04
no_reload Reloadsperre ausschalten. Diese Sperre verhindert den Versand von gleichen SMS (Text, Typ & Empfänger gleich) innerhalb von 180 Sekunden. Diese Sperre können Sie auch dauerhaft in Ihrem Login unter Einstellungen > SMS deaktivieren. 1
0
unicode Versand als Unicode SMS (kyrillisch, arabische etc Schriftzeichen). Die SMS Länge verkürzt sich dadurch auf 70 Zeichen. Bitte beachten Sie, dass unser Gatway die Kodierung automatisch erkennt. Dieser Parameter ist daher nicht notwendig. Sie können hiermit allerdings eine bestimmte Versandart forcieren. Nur Direct SMS unterstützen unicode Nachrichten. 1
0
flash SMS als Flash SMS versenden. Diese werden direkt im Display des Empfängers angezeigt. Flash-SMS haben, mit Ausnahme weniger älterer Modelle, keinen Absender. 1
0
udh Nur für Direct SMS. Individueller User Data Header (UDH) der SMS. Sofern angegeben und Variable text Hexcode enthält, wird die Nachricht als 8-bit Binary SMS versendet. 050003CC0201 (Verkettete Nachricht: Referenznummer 204, Teil 1 von 2)
utf8 Forciert die Erkennung als UTF8 Zeichensatz und überschreibt die automatische Erkennung der API. 1
0
ttl Gibt die Validity Period (Gültigkeitsdauer) der SMS in Minuten an. 2880 48h (Standard)
60 1h
details Zeigt zahlreiche Details zur verschickten SMS an. Praktisch zum Debugging. Hat keine Auswirkung, wenn der Parameter json auf 1 gesetzt ist. 1
0
return_msg_id Ist dieser Parameter gesetzt, wird in in der zweiten Zeile nach dem Statuscode die ID der SMS ausgegeben. Hat keine Auswirkung, wenn der Parameter json auf 1 gesetzt ist. 1 = ID zurückgeben
0 = Nur Statuscode (Standard)
label Setzen Sie optional für jede SMS ein eigenes Label, um diese in Ihren Statistiken zuordnen zu können. Max. 100 Zeichen, erlaubte Zeichen: a-z, A-Z, 0-9, .-_@. Kunde_1
Marketing_22.02.2018
Splittest17
json Die Ausgabe erfolgt detaillierter im JSON-Format. 1 – Ausgabe als JSON
0 – Ausgabe als Text (standard)
performance_tracking Klick und Performance Tracking für im SMS Text gefundene URLs aktivieren. 1 – Performance Tracking aktiv
0 – Performance Tracking deaktiviert (Standard)
foreign_id Geben Sie Ihre eigene ID für diese Nachricht an. Sie erhalten die foreign_id wiederum zurück bei Callbacks für Statusberichte etc. Max. 64 Zeichen, erlaubte Zeichen: a-z, A-Z, 0-9, .-_@. id12345

Dateianhänge

Sie können direkt per API Dateianhänge versenden. Hierzu müssen ein Parameter namens files als assoziatives Array die jeweiligen Dateien übergeben werden.

Parameter Beschreibung Beispiele
name Dateiname. Dieser muss exakt so im SMS Text als Platzhalter eingefügt werden. Hier wäre es [[dokument.pdf]] dokument.pdf
contents Inhalt der Datei als base64 kodiert. iVBORw0KGgoAAAANSUhEUgAAAdoAAACWCAYAAAB5CUk.......
validity (optional) Gültigkeit in Tagen 3
password (optional) Gewünschtes Zugangspasswort zu der Datei passwort123

Hier wäre zum Beispiel files[0][name]=dokument.pdf, files[0][contents]=iVBORw0KGgoAAAANSUhEUgAAAdoAAACWCAYAAAB5CUk......., files[0][validity]=3 und files[0][password]=passwort123

Im SMS Text geben Sie bitte an der gewünschten Stelle den jeweiligen Platzhalter ein: Hier die Datei: [[dokument.pdf]]

Rückgabe

Als Antwort auf Ihren Request erhalten Sie einen numerischen Rückgabewert und die Msg ID der gesendeten Nachricht. Mittels der ID können Sie später z.B. Statusberichte zuordnen. Bei Angabe des Parameters details erhalten Sie zahlreiche weitere Informationen – unter anderem den Guthabenstand und das verbuchte Guthaben. Die Rückgabe erfolgt als einfacher Text wobei jeder Wert jeweils getrennt durch \n in einer Zeile steht.

Folgende Rückgabecodes sind möglich:
100
SMS wurde vom Gateway angenommen
101
Versand an mindestens einen Empfänger fehlgeschlagen
201
Absender ungültig. Erlaubt sind max 11 alphanumerische oder 16 numerische Zeichen.
202
Empfängernummer ungültig
301
Variable to nicht gesetzt
305
Variable text nicht gesetzt
401
Variable text ist zu lang
402
Reloadsperre – diese SMS wurde bereits innerhalb der letzten 180 Sekunden verschickt
403
Maximales Limit pro Tag für diese Nummer erreicht.
500
Zu wenig Guthaben vorhanden.
600
Carrier Zustellung misslungen
700
Unbekannter Fehler
900
Authentifizierung ist fehlgeschlagen. Bitte Api Key prüfen
901
Verifizierung des Signierhashes ist fehlgeschlagen
902
API Schlüssel hat kein Zugriffsrecht auf diesen Endpunkt
903
Server IP ist falsch

Zeichensatz

SMS unterstützen einen ganz eigenen 7-bit Zeichensatz (GSM 0338), der einige UTF-8 Zeichen wie z.B. deutsche Umlaute enthält, nicht aber z.B. ó oder chinesische, arabische, kyrillische Zeichen etc. Hierzu müsste eine unicode SMS versendet werden, welche mit 8 Bit kodiert ist und daher nur 70 Zeichen Platz je SMS benötigt. Eine Unicode SMS mit z.B. 120 Zeichen würde also das doppelte einer normalen SMS kosten.

Hier erfahren Sie mehr zu den Spezifikationen des SMS Zeichensatz und können die komplette Liste der erlaubten Zeichen in normalen (nicht unicode) SMS einsehen: https://en.wikipedia.org/wiki/GSM_03.38#GSM_7-bit_default_alphabet_and_extension_table_of_3GPP_TS_23.038_.2F_GSM_03.38.

Beispiele

1. Einfacher SMS Versand

Der Aufruf folgender URL sendet eine SMS mit dem Inhalt meine erste nachricht als Direct SMS mit dem Absender sms77.de an die Rufnummer 49160999999999:

Anfrage:
https://gateway.sms77.io/api/sms?p=api-schlüssel&to=49160999999999&text=meine%20erste%20nachricht&from=sms77.de&return_msg_id=1

Antwort:
100
123456789

Die SMS wurde erfolgreich übertragen – die Msg ID lautet 123456789.

2. Debugmodus mit detaillierter Ausgabe

Dieser Aufruf sendet aufgrund des gesetzten Parameters debug keine SMS, zeigt aber zahlreiche Details zu der Nachricht.

Request: http://gateway.sms77.io/api/sms?p=api-schlüssel&to=Gruppe1&text=Test+SMS&from=SMS&flash=0&details=1&debug=1

Response:
100
Verbucht: 0
Preis: 0.089
Guthaben: 27.38
Text: Test SMS
SMS-Typ: direct
Flash SMS: off
Encoding: ASCII
GSM0338: true
Debug: true

Menü