Mit unseren Produkten haben Sie die bequeme Möglichkeit, von Ihrem lokalen Rechner aus SMS und Faxe zu versenden. Abseits dieser Möglichkeit bieten wir Ihnen aber auch Zugriff auf das Gateway zur Nutzung aus beliebigen Applikationen. Die folgenden Informationen beziehen sich auf den direkten Schnittstellenzugriff.

Die Schnittstelle sprechen Sie unter der URL http://msggw.phlymail.de/http.php an.

Das Gateway wird wahlweise per HTTP GET oder HTTP POST angesprochen. Ihnen stehen dabei mehrere Anfragemöglichkeiten zur Verfügung (siehe Parameter mode):

• Verbindungstest - Mit dieser Anfrage können Sie prüfen, ob die Schnittstelle funktioniert und ob die von Ihnen angegebenen Logindaten korrekt sind. Liefert diese Anfrage ein positives Ergebnis zurück, können Sie davon ausgehen, dass die Schnittstelle Ihre SMS entgegennehmen wird.
  Beispielaufruf: msggw.phlymail.de/http.php?user=USER&encpass=SECPASS&mode=test
  
  
• Guthabenabfrage - Mit dieser Abfrage können Sie sich Ihr aktuelles Guthaben anzeigen lassen, um z.B. vor dem Versand größerer SMS-Mengen zu prüfen, ob sie diese Anzahl noch mit Ihrem aktuellen Guthaben versenden können.
  Beispielaufruf: msggw.phlymail.de/http.php?user=USER&encpass=SECPASS&mode=synchro
  
  
• SMS-Versand - Das Herzstück des Gateways zum Versand von Kurzmitteilungen. Details zu den möglichen Parametern und deren gültigen Werten entnehmen Sie bitte der untenstehenden Tabelle.
  Beispielaufruf: msggw.phlymail.de/http.php?user=USER&encpass=SECPASS&mode=sms&from=TEL&to=TEL&text=TEXT
  
  
• Fax-Versand - Auch hier finden Sie Details zu den möglichen Parametern und deren gültigen Werten in der untenstehenden Tabelle.
  Beispielaufruf: msggw.phlymail.de/http.php?user=USER&encpass=SECPASS&mode=fax&from=TEL&to=TEL&file=[...]
  
  

Auf Anfragen antwortet das Gateway mit maschinenlesbaren Rückgaben der Form:
<CODE> <Lesbarer englischer Text>\n
Je nach Anfragemodus können nur bestimmte Antwortcodes auftreten. Diese sind wie folgt:

Anfragetyp	mode	Code	Bedeutung
Verbindungstest	test	100	Erfolgreich. Die angegebenen Paramter waren korrekt und die Verbindung zum Gateway funktioniert
		401	Fehlgeschlagen. Entweder der Benutzername oder das Passwort sind falsch.
Guthabenabfrage	synchro	100	Erfolgreich. Die zurückgegebene lesbare Nachricht enthält Ihr aktuelles Guthaben
		402	Fehlgeschlagen. Entweder der Benutzername oder das Passwort sind falsch.
Versand	sms	100	Erfolgreich. Die zurückgegebene lesbare Nachricht enthält am Anfang die resultierende Anzahl an effektiven SMS, also z.B. 1 für eine SMS. Beim Versand von Faxen entfällt diese Angabe natürlich.
		201	Fehlgeschlagen. Der übergebene Nachrichtentext überschreitet die maximal zulässige Länge (bei SMS 918 Zeichen; bei Faxen 600 KB).
		202	Fehlgeschlagen. Eine der Pflichtangaben fehlt.
		203	Fehlgeschlagen. Ihr aktuelles Guthaben reicht nicht aus, um die Nachricht zu versenden.
		402	Fehlgeschlagen. Entweder der Benutzername oder das Passwort sind falsch.

Je nach gewähltem Modus werden bestimmte Parameter als Übergabe an das Gateway erwartet. Desweiteren bestehen bestimmte Restriktionen im Format der übergebenen Daten. Details finden Sie in der unten stehenden Tabelle. Beachten Sie bitte, dass sämtliche Parameterwerte von Ihnen URL-encoded übertragen werden müssen, damit diese per HTTP übertragen werden können.
Das character encoding der Schnittstelle ist ISO-8859-1.

Paramter	Bedeutung
user	Ihr Benutzername bei uns. Diese Feld muss bei allen Anfragen mit korrektem Inhalt übergeben werden.
pass	Ihr Passwort bei uns im Klartext. Verwenden Sie dieses Feld nur dann, wenn Sie keine Möglichkeit haben, Ihr Passwort als MD5 zu übertragen (siehe Feld encpass). Entweder dieses Feld oder das Feld encpass muss bei jedem Aufruf übertragen werden.
encpass	Ihr Passwort bei uns als MD5-Hash. Die Angabe dieses Feldes ist immer dem Feld pass vorzuziehen, da damit Ihr Passwort nicht im Klartext übertragen wird. Entweder dieses Feld oder das Feld pass muss bei jedem Aufruf übertragen werden.
mode	Bestimmt den Typ der Abfrage. Mögliche Werte sind: test - Testet die Verbindung zur Schnittstelle und die Richtigkeit der Zugangsdaten synchro - Dient der Abfrage Ihres aktuellen Guthabens sms - Versendet eine SMS. Siehe weitere Parameter im Folgenden fax - Versendet ein Fax. Siehe weitere Parameter im Folgenden udh - Versendet eine Binär-SMS. Details auf Anfrage utf - Versendet eine Unicode-SMS. Details auf Anfrage

Paramter	Bedeutung
user	Ihr Benutzername bei uns. Diese Feld muss bei allen Anfragen mit korrektem Inhalt übergeben werden.
pass	Ihr Passwort bei uns im Klartext. Verwenden Sie dieses Feld nur dann, wenn Sie keine Möglichkeit haben, Ihr Passwort als MD5 zu übertragen (siehe Feld encpass). Entweder dieses Feld oder das Feld encpass muss bei jedem Aufruf übertragen werden.
encpass	Ihr Passwort bei uns als MD5-Hash. Die Angabe dieses Feldes ist immer dem Feld pass vorzuziehen, da damit Ihr Passwort nicht im Klartext übertragen wird. Entweder dieses Feld oder das Feld pass muss bei jedem Aufruf übertragen werden.
mode	Für den SMS-Versand muss dieses Feld den Wert sms beinhalten.
from	Absender der SMS im Format 004917712345678 oder als alphanumerische Zeichenkette (Zeichen 0-9 und A-Z) mit maximal 11 Zeichen Länge.
to	Empfänger der SMS im Format 004917712345678. Beachten Sie bitte, dass der Versand in andere als deutsche Mobilfunknetze zwar nicht technisch ausgeschlossen wird, wir die Zustellung in diese Netze jedoch nicht sicherstellen können. Im Zweifel bitten wir Sie, über eine Test-SMS in das gewünschte Zielnetz die Versandfähigkeit zu prüfen.
text	Der zu versendende Nachrichtentext im Zeichensatz ISO-8859-1. Nachrichten über 160 Zeichen Länge werden automatisch in Einzel-SMS aufgeteilt. Standardbedingt beträgt die maximale Länge einer Nachricht 918 Zeichen (6 x 153 Zeichen). Da die Netzbetreiber nach Einzel-SMS abrechnen, müssen wir dieses Abrechnungsmodell leider übernehmen.

Paramter	Bedeutung
user	Ihr Benutzername bei uns. Diese Feld muss bei allen Anfragen mit korrektem Inhalt übergeben werden.
pass	Ihr Passwort bei uns im Klartext. Verwenden Sie dieses Feld nur dann, wenn Sie keine Möglichkeit haben, Ihr Passwort als MD5 zu übertragen (siehe Feld encpass). Entweder dieses Feld oder das Feld encpass muss bei jedem Aufruf übertragen werden.
encpass	Ihr Passwort bei uns als MD5-Hash. Die Angabe dieses Feldes ist immer dem Feld pass vorzuziehen, da damit Ihr Passwort nicht im Klartext übertragen wird. Entweder dieses Feld oder das Feld pass muss bei jedem Aufruf übertragen werden.
mode	Für den Fax-Versand muss dieses Feld den Wert fax haben.
from	Absenderrufnummer des Faxes im Format Vorwahl + Rufnummer, z.B. 03012345678. Optional darf auch das internaitonale Format benutzt werden (00493012345678 bzw. +493012345678).
from_name	Absendername. Dies ist eine alphanumerische Zeichenkette im Zeichensatz ISO-8859-1. Das Feld ist ein Pflichtfeld.
to	Empfängerrufnummer des Faxes im Format Vorwahl + Furnummer. Gültige Empfängernummern sind deutsche Festnetznummern (Normalpreis) oder die Rufnummerngasse 0180 (Sonderpreis laut Preisliste). Die Zustellung von Faxen an ausländische Empfängernummern, deutsche Sonderrufnummern (wie Service 0900 oder 0700) bzw. Mobilfunknummern ist leider ausgeschlossen.
status_to	Geben Sie hier eine Emailadresse an, an die nach Abschluss des Versands eine Statusnachricht gesendet werden soll. Diese enthält Angaben darüber, ob der Versand erfolgreich war oder nicht und im fehlerfalle die Angabe einer Fehlerursache (wie z.B. dauerhaft besetzte Leitung u.a.).
file	Das zu versendende Fax als PDF, als Transferformat wählen Sie bitte Base 64. Die maximale Dateigröße beträgt dabei 600 kByte. Zur sicheren Übertragung des Base-64-kodierten Strings ersetzen Sie die folgenden Zeichen gemäß der folgenden Regeln: Aus + wird -, aus / wird _ und das = wird ersatzlos gelöscht.