SMS Versand API

Schnittstellen zum Versand von SMS


Schnittstellen zum Versand von SMS

Die meisten Funktionen unseres Systems lassen sich durch Schnittstellen ansteuern. Damit integrieren Sie unsere Dienste nahtlos in Ihre bestehende Infrastruktur, ohne auf unsere Software zugreifen zu müssen. So können Sie vollautomatisierte Kommunikationsprozesse mit unseren Services realisieren. Versenden und empfangen Sie SMS, löschen Sie zeitversetzte Aufträge oder versenden Sie SMS an bestehende Listen. Die Gateway-URL sowie die komplette Beschreibung aller APIs finden Sie nach der Registrierung im Zugangsbereich.

HTTPS

Parameter ÜbergabeFunktion
receiverPflichtEmpfängernummer
senderPflichtAbsenderkennung
msgPflichtText der Nachricht
idPflichtAccount-ID
pwPflichtPasswort
msgtypePflichtNachrichtentyp
t: Text-SMS mit 160 Zeichen,
c: überlange SMS,
utf8: für non-GSM-Zeichen (kyrillisch, arabisch, Emojis…)*
* bei utf8 wird je 70 Zeichen eine SMS abgerechnet
authTokenOptionAuthentifizierungs-Token, kann anstelle von pw und id verwendet werden
timeOptionAuslieferungszeit bei zeitversetztem Versand
userAccountOptioneigene Kostenstellen zur getrennten Ausweisung auf der Rechnung
testOptionSchnittstellentest, es wird keine SMS erzeugt, jedoch die entsprechende Antwort vom Server zurückgegeben.
getIDOptionzusätzliche Rückgabe der Nachrichten-ID
countMsgOptionzusätzliche Rückgabe der Anzahl der SMS-Teile
getLimitOptionzusätzliche Rückgabe des SMS-Restvolumens (bei prepaid)

Beispiel PHP

<?php
$urlGate="https://gateway";		//API Url
$password="password";			//your password
$accountid="accountID";			//your accountID
$receiver="00491701234567";		//receiver number 
$sender="sender";					//sender address
$msg="test";						//message, should be urlencoded
 
$urlParam="?receiver=" . $receiver . "&sender=" . $sender . "&msg=" . $msg . "&id=" . $accountid . "&pw=" . $password . "&msgtype=c&getID=1";
$strUrl=$urlGate . $urlParam;
 
$messagedata=file_get_contents($strUrl);

if(preg_match("/OK/",$messagedata)){
	echo 'SUCCESS: ' . $messagedata;
	}
	else
	{
	echo 'ERROR: ' . $messagedata;
	}
?>

Classic ASP

<%
urlGate="https://gateway"		'API Url
password="password"			'your password
accountid="accountID"		'your accountID
receiver="00491701234567"	'receiver number 
sender="sender"				'sender address
msg="test"						'message, should be urlencoded
 
urlParam="?receiver=" & receiver & "&sender=" & sender & "&msg=" & msg & "&id=" & accountid & "&pw=" & password & "&msgtype=c&getID=1"
strUrl=urlGate & urlParam
 
Set objHTTP = CreateObject("Microsoft.XMLHTTP")                  
objHTTP.open "GET", strUrl, false
objHTTP.send
respStatus = CStr(objHTTP.Status)   
respText = objHTTP.responseText       
set objHTTP = nothing
 
if respStatus <> "200" OR Instr(respText,"OK")=0 Then
        Response.write("ERROR: " & respText)
else
        Response.write("SUCCESS: " & respText)
end if
%>

E-Mail-to-SMS

Parameter im Betreff: time;sender;receiver;pw;id;msgtype;userAccount (Parameter getrennt durch Semikolon)

Mail-Body: Text der Nachricht. Je E-Mail wird eine SMS erzeugt und versendet.

Parameter ÜbergabeFunktion
timePflichtAuslieferungszeit bei zeitversetztem Versand, sonst ‘0’ setzen
senderPflichtAbsenderkennung
receiverPflichtEmpfängernummer
pwPflichtPasswort
idPflichtAccount-ID
msgtypePflichtNachrichtentyp, t: Text-SMS mit 160 Zeichen, c: überlange SMS
userAccountOptioneigene Kostenstellen zur getrennten Ausweisung auf der Rechnung
Mail-BodyPflichtText der Nachricht

E-Mail-to-Bulk

Parameter im Betreff: time;sender;pw;id;msgtype;userAccount (Parameter getrennt durch Semikolon)

Mail-Body: Der Body der E-Mail enthält den Text der zu versendenden SMS. Es sind fünf Platzhalter als Personalisierungsfelder angelegt, die in folgendem Format innerhalb des SMS-Textes verwendet werden können: %FELD1%, %FELD2%, … %FELD5%. Die Felder werden der Reihe nach durch die Personalisierungsdaten im Dateianhang ersetzt. Die Verwendung der Felder ist optional.

Mail-Anhang: Der Mail-Anhang besteht aus einer Datei im Text- oder CSV-Format, welche die Empfängerdaten enthält. Jede Zeile entspricht einer SMS. Die Empfängerdaten werden in folgendem Format angegeben: Empfängernummer;FELD1;FELD2;FELD3;FELD4;FELD5
In den Feldern 1-5 befinden sich die Daten, welche an Stelle der Platzhalter im SMS-Text eingesetzt werden. Diese Felder müssen nicht gesetzt werden, wenn keine Personalisierung erfolgen soll. Es ist genügt, lediglich die Empfängernummer anzugeben.

Parameter ÜbergabeFunktion
timePflichtAuslieferungszeit bei zeitversetztem Versand, sonst ‘0’ setzen
senderPflichtAbsenderkennung
pwPflichtPasswort
idPflichtAccount-ID
msgtypePflichtNachrichtentyp, t: Text-SMS mit 160 Zeichen, c: überlange SMS
userAccountOptioneigene Kostenstellen zur getrennten Ausweisung auf der Rechnung
Mail-BodyPflichtText der Nachricht
Mail-AnhangPflichtEmpfänger der Nachricht

Http-to-List

Versand an eine bestehende Liste per HTTPS: Im Online-Zugang können mehrere Listen angelegt und dort Nummern bzw. zusätzliche Daten wie Vorname, Nachname, Geburtsdatum etc. eingetragen werden. Der Versand kann anschließend per HTTPS-Request ausgelöst werden.

Parameter ÜbergabeFunktion
pwPflichtPasswort
accountIDPflichtAccount-ID
listenIDPflichtID der Empfängerliste, an welche die Nachricht ausgeliefert werden soll
senderPflichtAbsenderkennung
textPflichtText der Nachricht
sttmOptionAuslieferungszeit bei zeitversetztem Versand

Email-to-List

Versand an eine bestehende Liste per E-Mail: Im Online-Zugang können mehrere Listen angelegt und dort Nummern bzw. zusätzliche Daten wie Vorname, Nachname, Geburtsdatum etc. eingetragen werden. Der Versand kann anschließend per E-Mail ausgelöst werden.

Parameter ÜbergabeFunktion
timePflichtAuslieferungszeit bei zeitversetztem Versand, sonst ‘0’ setzen
senderPflichtAbsenderkennung
pwPflichtPasswort
idPflichtAccount-ID
msgtypePflichtNachrichtentyp, t: Text-SMS mit 160 Zeichen, c: überlange SMS
userAccountOptioneigene Kostenstellen zur getrennten Ausweisung auf der Rechnung
Mail-BodyPflichtText der Nachricht
Mail-AnhangPflichtEmpfänger der Nachricht