Email2SMS-API

Transcrição

Email2SMS-API
Email2SMS API - Ausführliche Spezifikationen
Version 2.0, gültig ab 19.10.2009
smstrade Email2SMS API - Spezifikationen
Um leicht automatisiert SMS-Nachrichten zu versenden, steht zusätzlich zum HTTP-Gateway eine
E-Mail-Schnittstelle zur Verfügung, die im folgenden dokumentiert wird.
Inhaltsverzeichnis
1. E-Mail-Schnittstelle
1.1 Empfänger-Rufnummer
1.2 Nachrichtentext
1.3 Weitere Parameter
.............................................................................
.............................................................................
.............................................................................
2
2
3
2. Beispiele
2.1 Variante 1
.............................................................................
2.2 Variante 2 - Einzelversand .............................................................................
2.3 Variante 2 - Massenversand ............................................................................
4
5
6
Seite 1 von 6
© CM Telecom Germany GmbH, Herriotstraβe 1, 60528 Frankfurt am Main, Deutschland
Email2SMS API - Ausführliche Spezifikationen
Version 2.0, gültig ab 19.10.2009
1. E-Mail-Schnittstelle
Die E-Mail-Schnittstelle bietet eine einfache Möglichkeit SMS-Text-Nachrichten zu versenden, indem
eine E-Mail mit bestimmtem Inhalt an das smstrade Email2SMS Gateway übermittelt wird. Bei
syntaktischen Fehlern wird eine Fehler-Mail an den Absender zurückgeschickt.
1.1 Empfänger-Rufnummer
Für die Angabe des Empfängers gibt es 2 Varianten:
Variante 1
E-Mail Adresse
[email protected]
[email protected]
[email protected]
Handynummer
01701234657
01701234657
01701234657
Variante 2
E-Mail Adresse
Handynummer
[email protected] Wird im Nachrichtenbody übergeben
1.2 Nachrichtentext
Der Text der SMS-Nachricht wird aus dem Betreff der E-Mail ausgelesen.
Es gelten folgende Richtlinien:
• Maximale Länge: 1530 Zeichen
• Bei einer Länge von mehr als 160 Zeichen werden SMS automatisch verkettet
Die E-Mail-Nachricht sollte UTF-8-encodiert an die Schnittstelle übermittelt werden.
MIME-Header, wie von Mozilla Thunderbird verwendet, werden automatisch dekodiert.
Absätze in der SMS Nachricht können Sie mit \n erzeugen.
Seite 2 von 6
© CM Telecom Germany GmbH, Herriotstraβe 1, 60528 Frankfurt am Main, Deutschland
Email2SMS API - Ausführliche Spezifikationen
Version 2.0, gültig ab 19.10.2009
1.3 Weitere Parameter
Im Inhalt bzw. Body der E-Mail-Nachricht befinden sich die Steuer-Befehle für den SMS Versand. Die
einzelnen Teile können durch ein Rautezeichen getrennt werden (#).
Wichtig: Die Nachricht muss als Text-Nachricht und darf nicht als HTML-Nachricht verfasst sein!
E-Mail-Clients wie Microsoft Outlook oder Mozilla Thunderbird haben eine Menü-Option, um die
Nachricht als "Text“ bzw. "Nur Text" zu versenden. Genauere Informationen entnehmen Sie bitte der
Dokumentation zu Ihrem Mailprogramm.
Der Body der Nachricht muss folgendes Format haben:
Variante 1 (Versand über [email protected])
#Key#Route #From#
Variante 2 (Versand über [email protected])
#Key#To#Route #From#
key
Parameter
Beschreibung
Ihr persönlicher Identifikationskey
Beispielwerte
abcdefghijklmnop
to
Ihren Gateway Key finden Sie im
Kundencenter unter dem Punkt "HTTP
Schnittstelle".
Empfänger der SMS getrennt durch Komma
00491701234567,00491711234567
from
Die Rufnummern der NachrichtenEmpfänger mit Landesvorwahl. Deutsche
Nummern können auch ohne Landescode
übergeben werden.
Absenderkennung
route
Bei Gold und Direct SMS können Sie eine
eigene individuelle Absenderkennung
angeben. Diese darf 11 alpha-numerische
Zeichen oder bis zu 16 numerische Zeichen
beinhalten.
Versandroute
Jede SMS kann über eine der smstrade
Routen versendet werden. Weitere
Informationen über die Routen entnehmen
Sie bitte der Routenübersicht im
Kundencenter.
SMSTRADE
00491701234567
basic
gold
direct
Seite 3 von 6
© CM Telecom Germany GmbH, Herriotstraβe 1, 60528 Frankfurt am Main, Deutschland
Email2SMS API - Ausführliche Spezifikationen
Version 2.0, gültig ab 19.10.2009
2. Beispiele
2.1 Variante 1
Versand über [email protected]
Seite 4 von 6
© CM Telecom Germany GmbH, Herriotstraβe 1, 60528 Frankfurt am Main, Deutschland
Email2SMS API - Ausführliche Spezifikationen
Version 2.0, gültig ab 19.10.2009
2.2 Variante 2 - Einzelversand
Versand über [email protected]
Seite 5 von 6
© CM Telecom Germany GmbH, Herriotstraβe 1, 60528 Frankfurt am Main, Deutschland
Email2SMS API - Ausführliche Spezifikationen
Version 2.0, gültig ab 19.10.2009
2.3 Variante 2 - Massenversand
Versand über [email protected]
Seite 6 von 6
© CM Telecom Germany GmbH, Herriotstraβe 1, 60528 Frankfurt am Main, Deutschland