API

Dieser Abschnitt enthält die technische Dokumentation zur Integration unseres SMS-Versanddienstes in Ihre Anwendung / Website. Um das für die Verwendung der API erforderliche Token zu erhalten, müssen Sie ein Konto erstellen.

SMS senden

Um eine SMS zu senden oder zu planen, müssen Sie eine Anfrage über die Methode POST an folgende Adresse stellen: https://www.smsadvert.io/api/sms/ Typ application/json

Beispiel für das Senden von SMS mit Ihren eigenen Geräten

Die Zustellung der SMS erfolgt sofort nach Ihrer Anfrage.

POST https://www.smsadvert.io/api/sms/ HTTP/1.1
Authorization: {API_AUTH_TOKEN}
Content-Type: application/json
{
  "phone": "+40740123456",
  "shortTextMessage": "Dies ist der Inhalt der SMS-Nachricht"
}

Beispiel für das Senden von SMS mit Ihren eigenen Geräten mit Failover

Wenn Sie kein eigenes angeschlossenes Gerät haben oder der GSM-Betreiber mit einer Fehlermeldung antwortet, wird die SMS über das smsadvert.ro Netzwerk gesendet

POST https://www.smsadvert.io/api/sms/ HTTP/1.1
Authorization: {API_AUTH_TOKEN}
Content-Type: application/json
{
  "phone": "+40740123456",
  "shortTextMessage": "Dies ist der Inhalt der SMS-Nachricht",
  "failover": "short"
}

Beispiel für das Senden von SMS über das smsadvert.ro Netzwerk

Die Zustellung der SMS erfolgt sofort nach Ihrer Anfrage.

POST https://www.smsadvert.io/api/sms/ HTTP/1.1
Authorization: {API_AUTH_TOKEN}
Content-Type: application/json
{
  "phone": "+40740123456",
  "shortTextMessage": "Dies ist der Inhalt der SMS-Nachricht",
  "sendAsShort": true
}

Beispiel für das Senden von SMS-Zeitplänen

Die Zustellung der SMS erfolgt gemäß den Parametern startDate und endDate.

POST https://www.smsadvert.io/api/sms/ HTTP/1.1
Authorization: {API_AUTH_TOKEN}
Content-Type: application/json
{
  "phone": "+40740123456",
  "shortTextMessage": "Dies ist der Inhalt der SMS-Nachricht",
  "startDate": 1486883578036,
  "endDate": 1486889778036
}

Beispiel SMS-Versand mit mehreren Empfängern

Die Zustellung der SMS an die Empfänger erfolgt nacheinander unmittelbar nach Ihrer Anfrage.

POST https://www.smsadvert.io/api/sms/ HTTP/1.1
Authorization: {API_AUTH_TOKEN}
Content-Type: application/json
{
  "phone": "+40740123456,+40740123457,+40740123458",
  "shortTextMessage": "Dies ist der Inhalt der SMS-Nachricht"
}

Beispiel für das Senden von SMS mit Rückruf von Zustellungsberichten

Die Zustellung der SMS erfolgt sofort nach Ihrer Anfrage. Sie erhalten dann eine Anfrage an die Adresse vom Parameter callback mit Lieferbericht.

POST https://www.smsadvert.io/api/sms/ HTTP/1.1
Authorization: {API_AUTH_TOKEN}
Content-Type: application/json
{
  "phone": "+40740123456",
  "shortTextMessage": "Dies ist der Inhalt der SMS-Nachricht",
  "callback": "http://yourwebsite.com/callback-url/"
}

Beschreibung der Parameter

  • phone

    string, verpflichtend
  • Es repräsentiert die Telefonnummer des Empfängers.
    Die Nummer muss im internationalen Format vorliegen E.164 (Bsp.: +40740123456)

    Bei mehreren Empfängern können Sie Ihre Telefonnummern durch Kommas getrennt eingeben, z. "+40740123456,+40740123457".
    Bis zu 1000 Telefonnummern und die doppelten Nummern werden nicht zur Übermittlung aufgezeichnet.
    Warnung! Komma wird am Ende der Liste nicht akzeptiert.
  • shortTextMessage

    string, verpflichtend
  • Es stellt den Inhalt der SMS-Nachricht dar und muss aus mindestens 3 und höchstens 480 Zeichen bestehen.
  • sendAsShort

    boolean, optional
  • Um SMS über das smsadvert.ro Netzwerk zu senden, muss dieser Parameter den Wert true enthalten. Wenn dieser Parameter den Wert false hat oder nicht vorhanden ist, wird die Nachricht über Ihre Geräte gesendet.
  • startDate

    integer, optional
  • Es gibt das Datum / die Stunde / Minute / Sekunde an, nach dem das Senden der Nachricht beginnt. Das Format ist UNIX-Zeit (Millisekunden).
  • endDate

    integer, optional
  • Es stellt das Datum / die Stunde / Minute / Sekunde dar, nach dem das Senden der Nachricht beendet wird. Das Format ist UNIX-Zeit (Millisekunden).
  • failover

    string, optional
  • Es stellt den sekundären Sendekanal dar.
    Wenn die Nachricht nicht über Ihre Geräte zugestellt werden kann (es ist nicht mindestens ein angeschlossenes Gerät vorhanden oder der GSM-Betreiber antwortet mit einer Fehlermeldung), wird das Senden über den sekundären Kanal versucht.

    Wenn die Wenn der Parameter failover auf "short" gesetzt ist, wird die SMS über das smsadvert.ro Netzwerk gesendet.
  • callback

    string, optional
  • Stellt die Webadresse (URL) dar, an die Sie eine Anfrage mit dem Zustellungsstatus der Nachricht erhalten.

    Die Anfrage ist vom Typ POST (application/json) und enthält zwei Parameter: status mit dem Wert "delivered" oder "failed" und msgId stellen die ID der Nachricht dar, die Sie als Antwort von der Sendeanforderung erhalten haben.

    Beispiel für eine Anfrage, die Sie an Ihre Rückruf-URL erhalten

    POST http://yourwebsite.com/callback-url/ HTTP/1.1
    Content-Type: application/json
    {
      "status": "delivered",
      "msgId": "xxxxxx"
    }

Antwort

Die von der Anfrage empfangene Antwort ist vom Typ application/json.

Beispiel für eine erfolgreiche Antwort

{
  "successMessage": "Your message has been successfully submitted!",
  "msgId": "xxxxxx"
}

Beispiele für Fehlerreaktionen

{
  "errors": {
    "phone": "Ungültige Telefonnummer!",
    "shortTextMessage": "Geben Sie mindestens 3 Zeichen ein!"
  }
}
{
  "errorMessage": "There was a database error!"
}