Entwickler

Nutzen Sie unsere API, um einfach zu integrieren und zu entwickeln.

Hi, Willkommen zur Dokumentation der Spryng PHP API Library. Diese Anleitung beinhaltet nützliche Informationen zur Nutzung. Das PHPDOC kann in diesem Repository gefunden werden.

Installation und Einrichtung

Composer Verwenden

Der einfachste Weg, um die Library zu installieren, ist die Nutzung von Composern:

composer require spryng/spryng-api-http-php

Wenn die Installation vollständig ist, können Sie Spryng folgendermaßen einrichten:

require ( 'vendor/autoload.php' );
 use SpryngApiHttpPhp\Client;
 $spryng = new Client('username', 'password', 'My Company');

Ohne Composer

Wenn Sie keine Composer verwenden, können Sie den Autoloader nutzen:

$ git clone https://github.com/spryng/SpryngApiHttpPhp.git
require ( 'SpryngApiHttpPhp/src/Spryng/Api/Autoloader.php' );
 use SpryngApiHttpPhp\Client;
 $spryng = new Client( 'username', 'password', 'My Company' );

Sending SMS

Um eine SMS senden zu können, sollten Sie die $spryng->sms->send() Methode verwenden. Nutzen Sie folgende Parameter:

  • $recipient Die Telefonnummer, an die Sie die SMS versenden.
  • $body Inhalt der SMS.
  • $options Zusätzliche Parameter wie Allowlong und Route.

Optionen

Es gibt eine Vielzahl von Optionen, die Sie mit Ihrem Request spezifizieren können. Die Anforderungen für diese Optionen sind in der allgemeinen Dokumentation verfügbar.

    • route Geben Sie Ihre zugeteilte Route ein.
    • reference Eine optionale Referenz für Lieferberichte.
    • allowlong Ob Sie Long SMS erlauben möchten oder nicht. Sollte wahr oder falsch sein.

Vollständiges Beispiel

require ( 'vendor/autoload.php' );

use SpryngApiHttpPhp\Client;
use SpryngApiHttpPhp\Exception\InvalidRequestException;

$spryng = new Client('username', 'password', 'My Company');

try {
    $spryng->sms->send('46612345678', 'A sample message!', array(
        'route' => 'business',
        'allowlong' => true,
        'reference' => 'ABC123456789')
    );
}
catch (InvalidRequestException $e)
 {
    echo $e->getMessage();
 }

Guthaben abfragen

Abgesehen von der Möglichkeit SMS zu versenden, ist es auch möglich, Ihren aktuellen Guthabenstand abzufragen. Diese Methode erfordert keine Parameter und kann folgendermaßen benutzt werden:

require ( 'SpryngApiHttpPhp/src/Spryng/Api/Autoloader.php' );
use SpryngApiHttpPhp\Client;
$spryng = new Client( 'username', 'password', 'My Company' );
echo 'Huidige balans: ' . $spryng->sms->checkBalance();

API – Schnittstelle

Die Spryng SMS-MT HTTP API unterstützt GET und HTTP POST mit einem Content-Typ von ‘application/x-www-form-urlencoded’ via HTTP und HTTPS. Für weitere Informationen über die Spryng SMS-MT HTTP API senden Sie bitte eine E-Mail an unsere Support Abteilung info@spryng.de.

Mit dem Gateway verbinden

Um eine SMS zuzustellen kann ein HTTP GET oder HTTP POST Call an die folgende Adresse ausgeführt werden: https://api.spryngsms.com/api/send.php

 

Parameter

Parameter
USERNAME Benutzer ausgewählt bei der Registrierung auf http://www.spryng.de
PASSWORD Benutzer ausgewählt bei der Registrierung auf http://www.spryng.de
REFERENCE Einzigartige Referenz für Zustellberichte
DESTINATION Empfängernummer
SENDER Absenderadresse
BODY Inhalt der SMS
SERVICE Reference tag hinzufügen, um zwischen End-Benutzern zu unterscheiden
ROUTE Spryng Business, Spryng Economy Route oder Spezial Route
ALLOWLONG Wenn Sie Long SMS senden möchten

Username

Gewähl von Benutzer bei der Registration auf http://www.spryng.de

Option
Erforderlich ja
Typ Alphanumerisch, Case sensitive
Min Länge 2
Max Länge 32
Min Wert <na>
Max Wert <na>
Werte <na>
Ausgangswert <none>
Beispiel USERNAME=username

Password

Ausgewählt vom Benutzer bei der Registrierung auf http://www.spryng.de

Option
Erforderlich ja
Typ Alphanumerisch, Case sensitive
Min Länge 6
Max Länge 32
Min Wert <na>
Max Wert <na>
Werte <na>
Ausganswert <none>
Beispiel PASSWORD=password

Reference

Option
Erforderlich Nur, wenn Sie Zustellberichte empfangen wollen
Typ Alphanumerisch
Min Länge 1
Max Länge 256
Werte <na>
Ausgangswert <none>
Beispiel REFERENCE=abc123
Anmerkung muss einzigartig sein

Destination

Emfängernummern

Option
Erforderlich ja
Typ MSISDN-numerisch (international format without leading “00” or
“+”)
Min Länge 1 MSISDN
Max Länge 1.000 MSISDN
Min Wert <na>
Max Wert <na>
Werte <na>
Ausgangswert <none>
Beispiel DESTINATION=49641041106,49612345678
Anmerkungen Mehr Details über Error Handling sehe „Return Values“ am Ende dieser Seite

Sender

Absenderadresse

Option
Erforderlich ja
Typ Numerisch or Alphanumerisch
Min Länge 1
Max Länge 14 for Numerisch or 11 for Alphanumerisch
Min Wert <na>
Max Wert <na>
Werte <na>
Ausgangswert <none>
Beispiel SENDER=0049641041106
Anmerkungen Mehr Details zum Error Handling sehe „Return Values“ am Ende dieser Seite

Body

Inhalt einer SMS

Option
Erforderlich ja
Typ GSM 7-bit alphabet for text message
Min Länge 1
Max Länge 160 Zeichen für Textnachrichten (default : ALLOWLONG=0) 612 Zeichen (ALLOWLONG=1)
Wenn Sie Long SMS verwenden, wird das System Ihre Nachricht automatisch in bis zu 153 Charaktere per SMS zerteilt.
Min Wert <na>
Max Wert <na>
Werte <na>
Fehlwert <none>
Beispiel BODY=This%20is%20a%20test%20SMS
Anmerkungen Mehr Details über Charaktere sehe „Field types“ am Ende dieser Seite.

Service

Reference tag kann verwendet werden, um Filter in Statistiken zu kreieren

Option
Erforderlich no
Typ Alphanumerisch
Min Länge 1
Max Länge 10
Min Wert <na>
Max Wert <na>
Werte <na>
Ausgangswert <none>
Beispiel SERVICE=Client1

Route

Spryng Business, Spryng Economy oder Specific User Route auswählen.

Option
Erforderlich ja
Typ Vorher festgelegt
Min Länge <na>
Max Länge <na>
Min Wert <na>
Max Wert <na>
Werte BUSINESS, ECONOMY, 0-9 (Specific User route)
Ausgangswert BUSINESS
Beispiel ROUTE=BUSINESS

Allowlong

Wenn Sie Long SMS senden möchten

Option
Erforderlich Nur, wenn Sie Long SMS senden möchten
Typ Vorher festgelegt
Min Länge <na>
Max Länge <na>
Min Wert <na>
Max Wert <na>
Werte 0,1
Ausgangswert 0
Beispiel ALLOWLONG=1
Anmerkungen Wenn Sie Long SMS verwenden, wird das System automatisch Ihre Nachricht in Nachrichten bis zu 153 Zeichen pro SMS teilen.

Rückempfangswerte

Rückempfangswerte
1 Erfolgreich empfangen
100 Fehlendes Parameter
101 Benutzername zu kurz
102 Benutzername zu lang
103 Passwort zu kurz
104 Passwort zu lang
105 Empfänger zu kurz
106 Empfänger zu lang
107 Absender zu lang
108 Absender zu kurz
109 Inhalt zu lang
110 Inhalt zu kurz
200 Sicherheitserror
201 Unbekannte Route
202 Route Zugriffsfehler
203 Credits unausreichend
800 Technischer Error

Zustellberichte

Sie können Ihre Zustellungsberichte einstellen, indem Sie sich mit Ihrem
Account auf http://www.spryng.de einloggen und das Menü „Einstellungen“
in Ihrem SMS Dashboard auswählen. Hier können Sie den URL Ihres Skripts
eingeben (servlet, php, perl, etc….) auf welchem Sie Ihre Zustellberichte
empfangen möchten. Das Skript sollte zwei Parameter voraussetzen,
diese werden über HTTP GET gesendet. Wenn Sie Zustellungsberichte
wünschen, sollten Sie nicht mehr als 1 EMPFÄNGER im Antrag spezifizieren.
Die folgenden Statuswerte werden gesendet:

Statuswert
10 Zugestellt
20 Nicht zugestellt
30 Versendet

Beispiel: REFERENCE=abc123&STATUS=10

Field types

Numerisch: Charaktere 0 bis 9 Alphanumerisch: Charaktere von ISO-8859-1
MSISDN-numerische Charaktere 0 bis 9 GSM 7-bit alphabet (erlaubte Zeichen in Textnachricht): Die Charaktere ‚a‚ durch ‚z‚, ‚A‚ durch ‚Z‚,
0‚ durch ‚9‚, Zeilenvorschub, Zeilenumschalter und
@£$¥èéùìòÇØøÅå_^{}\[~]|€ÆæßÉ!“#¤%&'()*+,-./:;<=>?¡ÄÖÑܧ¿äöñüà
Um das  Zeichen zu verwenden, bitte benutzen Sie %80

Credit Amount API

https://api.spryngsms.com/api/check.php?username=********&password=********

Installation und Initialisierung

Der einfachste Weg, unsere API in Ihrer C#/.NET-Umgebung zu implementieren, ist durch unsere C# Bibliothek, die hier zur Verfügung steht. Mit NuGet können Sie die Bibliothek einfach installieren:

Install-Package SpryngApiHttpDotNet

Um das Spryng HTTP API verwenden zu können, müssen Sie zuerst eine neue Instanz des SpryngHttpClient erstellen:

SpryngHttpClient client = new SpryngHttpClient(username, password);

 

Eine SMS senden

Um eine SMS zu senden, kreieren Sie ein SmsRequest Objekt. Sie können einen ihn wie folgt krieren:

SmsRequest request = new SmsRequest()
{
    Destinations = new string[] { "491123456789", "491987654210" },
    Sender = "Spryng",
    Body = "This is a Test SMS."
};

Sie können jetzt SMS senden, indem Sie den client verwenden:

try
{
    client.ExecuteSmsRequest(request);
    Console.WriteLine("SMS has been send!");
}
catch (SpryngHttpClientException ex)
{
    Console.WriteLine("An Exception occured!\n{0}", ex.Message);
}

Die Schnittstelle biete außerdem eine Async Implementierung, welche in derselben Art und Weise wie die synchrone API verwendet werden kann:

await client.ExecuteSmsRequestAsync(request);

SmsRequest Optionen

Es gibt viele Merkmale, die verändert werden können, im SmsRequest.

  • Destinations Eine Anzahl an Telefonnummern, an die Sie die SMS versenden.
  • Body Inhalt der SMS.
  • Sender Absenderadresse, wie Ihr Firmenname.
  • Route Wählen zwischen Spryng Business, Spryng Economy oder Custom Route. Standardeinstellung business.
  • Reference Eine optionale Referenz für Zustellberichte.
  • AllowLong Ob Sie Long SMS zulassen wollen oder nicht.  Defaults to False.

 

Guthaben anfragen

Mit der Verwendung des client ist auch auch möglich, das Guthaben anzufragen. Diese Methode ist synchron und asynchron verfügbar.

// Synchronous
double remainingCredits = client.GetCreditAmount();

// Asynchronous
double remainingCredits = await client.GetCreditAmountAsync();

 

API

Die Spryng SMS-MT HTTP API unterstützt GET und HTTP POST mit einem Content-Typ von ‘application/x-www-form-urlencoded’ via HTTP und HTTPS. Für mehr Information über Spryng SMS-MT HTTP API bitte senden Sie eine E-mail an info@spryng.de.

Mit dem Gateway verbinden

Um eine SMS zu versenden, kann ein HTTP GET oder HTTP POST Call
über die folgende Adresse ausgeführt werden: https://api.spryngsms.com/api/send.php

 

Parameter

Parameter
USERNAME Gewählt von Benutzer bei Registrierung auf http://www.spryng.de
PASSWORD Gewählt von Benutzer bei Registrierung auf http://www.spryng.de
REFERENCE Einzigartige Referenz für Zustellberichte
DESTINATION Absendernummer
SENDER Absenderadresse
BODY Inhalt der SMS
SERVICE Reference tag, um zwischen Endnutzern zu unterscheiden
ROUTE Wählen zwischen Spryng Business, Spryng Economy Route oder Special Route
ALLOWLONG Wenn Sie Long SMS senden möchten

Username

Gewählt von Benutzer, bei Registrierung auf http://www.spryng.de

Option
Erforderlich ja
Typ Alphanumerisch, Case sensitive
Min Länge 2
Max Länge 32
Min Wert <na>
Max Wert <na>
Werte <na>
Ausgangswert <none>
Beispiel USERNAME=username

Password

Ausgewählt von Benutzer bei Registration auf http://www.spryng.de

Option
Erforderlich ja
Typ Alphanumerisch, Case sensitive
Min Länge 6
Max Länge 32
Min Wert <na>
Max Wert <na>
Werte <na>
Ausgangswert <none>
Beispiel PASSWORD=password

Reference

Option
Erforderlich Nur, wenn Sie Zustellberichte wünschen
Typ Alphanumerisch
Min Länge 1
Max Länge 256
Werte <na>
Ausgangswert <none>
Beispiel REFERENCE=abc123
Anmerkung Muss einzigartig sein

Destination

Destination Number(s)

Option
Erforderlich ja
Typ MSISDN-numerisch (internationales Format ohne “00” oder
“+”)
Min Länge 1 MSISDN
Max Länge 1.000 MSISDN
Min Wert <na>
Max Wert <na>
Werte <na>
Ausgangswert <none>
Beispiel DESTINATION=491141041106,491123456789
Anmerkungen Mehr Details zu Error Handling sehe „Return Values“ am Ende dieser Seite

Sender

Absenderadresse

Option
Erforderlich ja
Typ Numerisch or Alphanumerisch
Min Länge 1
Max Länge 14 für Numerisch oder 11 für Alphanumerisch
Min Wert <na>
Max Wert <na>
Werte <na>
Ausgangswert <none>
Beispiel SENDER=00491141041106
Anmerkung Mehr Details über Error Handling sehe „Return Values“ am Ende dieser Seite

Body

Inhalt der SMS

Option
Erforderlich ja
Typ GSM 7-bit alphabet für Kurznachricht
Min Länge 1
Max Länge 160 Zeichen für Kurznachricht (Fehler : ALLOWLONG=0) 612 Zeichen (ALLOWLONG=1)
Wenn Sie Long SMS verwenden, wird das System Ihre Kurznachricht automatisch in Nachrichten von bis zu   153 Charakteren pro SMS teilen.
Min Wert <na>
Max Wert <na>
Werte <na>
Ausgangswert <none>
Beispiel BODY=This%20is%20a%20test%20SMS
Anmerkung Mehr Details zu den Charakteren sehe „Field types“ am Ende dieser Seite

Service

Reference tag kann verwendet werden, um einen Filter in Statistiken zu kreieren

Option
Erforderlich nein
Typ Alphanumerisch
Min Länge 1
Max Länge 10
Min Wert <na>
Max Wert <na>
Werte <na>
Ausgangswert <none>
Beispiel SERVICE=Client1

Route

Wählen zwischen Spryng Business, Spryng Economy oder Specific User Route.

Option
Erforderlich ja
Typ Vordefiniert
Min Länge <na>
Max Länge <na>
Min Wert <na>
Max Wert <na>
Werte BUSINESS, ECONOMY, 0-9 (Specific User route)
Ausgangswert BUSINESS
Beispiel ROUTE=BUSINESS

Allowlong

Wenn Sie Long SMS senden wollen

Option
Erforderlich Nur, wenn Sie Long SMS senden wollen
Typ Vordefiniert
Min Länge <na>
Max Länge <na>
Min Wert <na>
Max Wert <na>
Werte 0,1
Ausgangswert 0
Beispiel ALLOWLONG=1
Anmerkung Wenn Sie Long SMS verwenden, zerteilt das System automatisch Ihre Nachricht in bis zu 153 characters pro SMS.

Return Values

Return Value
1 Erfolgreich empfangen
100 Fehlendes Parameter
101 Benutzername zu kurz
102 Benutzername zu lang
103 Passwort zu kurz
104 Passwort zu lang
105 Destination zu kurz
106 Destination zu lang
107 Sender zu lang
108 Sender zu kurz
109 Body zu lang
110 Body zu kurz
200 Sicherheitserror
201 Unbekannte Route
202 Routenzugriff Verstoß
203 Unausreichende Credits
800 Technischer Error

Zustellberichte

Sie können Ihre Zustellungsberichte einstellen, indem Sie sich mit Ihrem
Account auf http://www.spryng.de einloggen und das Menü „Einstellungen“
in Ihrem SMS Dashboard auswählen. Hier können Sie den URL Ihres Skripts
eingeben (servlet, php, perl, etc….) auf welchem Sie Ihre Zustellberichte
empfangen möchten. Das Skript sollte zwei Parameter voraussetzen,
diese werden über HTTP GET gesendet. Wenn Sie Zustellungsberichte
wünschen, sollten Sie nicht mehr als 1 EMPFÄNGER im Antrag spezifizieren.
Die folgenden Statuswerte werden gesendet:

Statuswert
10 Zugestellt
20 Nicht zugestellt
30 Gesendet

Beispiel: REFERENCE=abc123&STATUS=10

Field Types

Numerisch: Charaktere 0 to 9 Alphanumerisch: Charaktere von ISO-8859-1
MSISDN-numerische Charaktere von 0 bis 9 GSM 7-bit alphabet (erlaubte Zeichen in der Textnachricht): Die Charaktere ‚a‚ durch ‚z‚, ‚A‚ durch ‚Z‚,
0‚ durch ‚9‚, Zeilenvorschub, Zeilenauslösetaste und
@£$¥èéùìòÇØøÅå_^{}\[~]|€ÆæßÉ!“#¤%&'()*+,-./:;<=>?¡ÄÖÑܧ¿äöñüà
Um zu verwenden, bitte nutzen Sie %80

Credit Menge API

https://api.spryngsms.com/api/check.php?username=********&password=********