Zum Inhalt springen
LOX24 API Docs

SMS senden simulieren (Testumgebung)

POST
/sms/dryrun

Diese Schnittstelle simuliert die Antwort der API auf den SMS Versand, überträgt aber keine SMS ins Mobilfunknetz und verursacht keine Kosten. Die Schnittstelle kann zum Testen im Integrationsprozess verwendet werden. Der Parameter uuid hat immer den Rückgabewert 11111111-2222-3333-4444-55555555555. Die Daten werden bei LOX24 nicht gespeichert, dadurch ist eine Abfrage der übertragenen Daten mit GET /sms/{id} nicht möglich. DLR Zustellberichte werden wie für richtige SMS an Ihre URL oder Mail zurückübertragen, wobei der Status 0 ist.

Authorizations

Abschnitt betitelt „Authorizations “

Request Body required

Abschnitt betitelt „Request Body required “

The new sms resource

Media type application/json

SMS

object
text
required

Der Nachrichtentext kann eine Länge von maximal 1530 Zeichen im GSM Standardzeichensatz enthalten. Mit einer Unicode SMS liegt die maximale Zeichenlänge bei 670 Zeichen. Das interne Encoding ist in beiden Fällen UTF-8.

string
>= 1 characters
sender_id
required

Die Absenderkennung der Nachricht kann eine Rufnummer mit bis zu 15 Ziffern oder einen Text mit bis zu 11 Zeichen enthalten. Im Fall einer Rufnummer als Absender, halten Sie sich bitte möglichst an das E.164 Format. Ein Text Absender kann Leerzeichen enhalten, aber keine anderen Sonderzeichen, Umlaute oder Satzzeichen. Bitte beachten Sie, dass der Absender nicht in jedem Zielland übertragen werden kann und teilweise die Registrierung einer Absenderkennung durch lokale Regulierung erforderlich ist.

Für Sprachnachrichten (text2speech, text2speech_ssml): Wenn sender_id nicht dem E.164-Format entspricht (z. B. fehlendes führendes +, nicht-numerische Zeichen), wird die Nachricht von der Systemstandardnummer +493075435114 gesendet. Einige nachgelagerte Telefonieanbieter können die benutzerdefinierte Absenderrufnummer überschreiben oder nicht berücksichtigen — die tatsächlich beim Empfänger angezeigte Rufnummer hängt von den Fähigkeiten des Anbieters ab.

string
/^(\+?[1-9]\d{0,14}|[a-zA-Z0-9 ]{1,11})$/
phone
required

Zielrufnummer:

  • +491701234567 (E.164)
  • 00491701234567
  • 491701234567
  • 01701234567 (wenn Ihr Account in Deutschland registriert ist) wird es konvertiert zu +491701234567

Wenn Sie Ihre Rufnummer nicht im E.164 Format übertragen, versucht unser System die Rufnummer anhand Ihres Firmensitzes aus Ihren Profildaten in E.164 Format zu konvertieren. Um Probleme bei der automatischen Konvertierung zu vermeiden, nutzen Sie bitte bevorzugt das E.164 Format.

string
>= 7 characters <= 16 characters /^\+[1-9]\d{1,14}$/
delivery_at
One of:

Unix-timestamp einer zeitversetzten SMS. Wenn gleich 0, wird die SMS sofort verschickt.

integer
source

Um Ihre SMS später besser im Einzelverbindungsnachweis identifizieren zu können, gibt es die Möglichkeit eine individuelle nummerische (integer) ID mitzugeben.

integer | null
is_unicode

Definiert ob Sie eine normale GSM 03.38 SMS oder eine Unicode SMS verschicken möchten:

  • GSM: is_unicode = false
  • Unicode: is_unicode = true
  • Auto-Detect: is_unicode = NULL
boolean | null
voice_lang

Sprache der Sprachnachricht. Mögliche Werte: null (automatische Erkennung) oder einer der folgenden Codes: EN (Englisch), DE (Deutsch), FR (Französisch), IT (Italienisch), ES (Spanisch), PL (Polnisch), NL (Niederländisch), RO (Rumänisch), PT (Portugiesisch), CS (Tschechisch), HU (Ungarisch), SV (Schwedisch), DA (Dänisch), FI (Finnisch), SK (Slowakisch), HR (Kroatisch), TR (Türkisch), RU (Russisch), BG (Bulgarisch), UK (Ukrainisch).

string | null
Allowed values: EN DE FR IT ES PL NL RO PT CS HU SV DA FI SK HR TR RU BG UK
callback_data

Wert (String) welcher an Ihren Endpoint zurückgeschickt wird. Sie können z.B. Ihre eigene ID so übergeben und mit dem Zustellbericht (DLR) zurückbekommen.

string | null
<= 36 characters
service_code
One of:

Service code definiert ob Sie eine text2speech oder direct sms verschicken. Wir empfehlen direct sms für eine sichere Zustellung (see /me)

Allowed values: direct text2speech text2speech_ssml
is_text_deleted
One of:

Löschen von Nachrichtentext nach Zustellung der SMS

boolean
attempts_count_max

Maximale Anzahl an Zustellversuchen für Sprachdienste (text2speech, text2speech_ssml). Zulässige Werte: null, 1, 2 oder 3 für text2speech/text2speech_ssml; für andere Dienste muss der Wert null sein.

integer | null
Allowed values: 1 2 3
Examples

Einfache SMS-Nachricht

Beispiel einer einfachen SMS-Nachricht mit nur erforderlichen Feldern

{
  "text": "Hallo! Das ist eine Test-SMS.",
  "sender_id": "+491701234567",
  "phone": "+14155552671"
}

Responses

Abschnitt betitelt „ Responses “

201

Abschnitt betitelt „201 “

Sms resource created

SMS

object
@id

JSON-LD ID

string
@type

JSON-LD type

string
@context
One of:
string
text

Der Nachrichtentext kann eine Länge von maximal 1530 Zeichen im GSM Standardzeichensatz enthalten. Mit einer Unicode SMS liegt die maximale Zeichenlänge bei 670 Zeichen. Das interne Encoding ist in beiden Fällen UTF-8.

string
sender_id

Die Absenderkennung der Nachricht kann eine Rufnummer mit bis zu 15 Ziffern oder einen Text mit bis zu 11 Zeichen enthalten. Im Fall einer Rufnummer als Absender, halten Sie sich bitte möglichst an das E.164 Format. Ein Text Absender kann Leerzeichen enhalten, aber keine anderen Sonderzeichen, Umlaute oder Satzzeichen. Bitte beachten Sie, dass der Absender nicht in jedem Zielland übertragen werden kann und teilweise die Registrierung einer Absenderkennung durch lokale Regulierung erforderlich ist.

Für Sprachnachrichten (text2speech, text2speech_ssml): Wenn sender_id nicht dem E.164-Format entspricht (z. B. fehlendes führendes +, nicht-numerische Zeichen), wird die Nachricht von der Systemstandardnummer +493075435114 gesendet. Einige nachgelagerte Telefonieanbieter können die benutzerdefinierte Absenderrufnummer überschreiben oder nicht berücksichtigen — die tatsächlich beim Empfänger angezeigte Rufnummer hängt von den Fähigkeiten des Anbieters ab.

string
/^(\+?[1-9]\d{0,14}|[a-zA-Z0-9 ]{1,11})$/
phone

Zielrufnummer:

  • +491701234567 (E.164)
  • 00491701234567
  • 491701234567
  • 01701234567 (wenn Ihr Account in Deutschland registriert ist) wird es konvertiert zu +491701234567

Wenn Sie Ihre Rufnummer nicht im E.164 Format übertragen, versucht unser System die Rufnummer anhand Ihres Firmensitzes aus Ihren Profildaten in E.164 Format zu konvertieren. Um Probleme bei der automatischen Konvertierung zu vermeiden, nutzen Sie bitte bevorzugt das E.164 Format.

string
>= 7 characters <= 16 characters /^\+[1-9]\d{1,14}$/
delivery_at

Unix-timestamp einer zeitversetzten SMS. Wenn gleich 0, wird die SMS sofort verschickt.

integer
status_code

Status der SMS, für mehr Informationen: SMS status codes

integer
Allowed values: 0 100 208 400 410 2000 3000 5000 6000
gateway_sent_at

Timestamp der Übertragung der SMS an den Netzbetreiber

integer
source

Um Ihre SMS später besser im Einzelverbindungsnachweis identifizieren zu können, gibt es die Möglichkeit eine individuelle nummerische (integer) ID mitzugeben.

integer | null
dlr_code

Zustellbericht der SMS

integer
Allowed values: 0 1 2 4 8 16
ip

IP-Adresse des Hosts, der die Anfrage gesendet hat

string format: ipv4
created_at

Zeitstempel, wann die Entität vom Benutzer zum System hinzugefügt wurde

integer
is_unicode

Definiert ob Sie eine normale GSM 03.38 SMS oder eine Unicode SMS verschicken möchten:

  • GSM: is_unicode = false
  • Unicode: is_unicode = true
  • Auto-Detect: is_unicode = NULL
boolean | null
uuid

Eindeutige Entitäts-UUID

string
/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
iso2

Ländercode

string
>= 2 characters <= 2 characters /^[A-Z]{2}$/
voice_lang

Sprache der Sprachnachricht. Mögliche Werte: null (automatische Erkennung) oder einer der folgenden Codes: EN (Englisch), DE (Deutsch), FR (Französisch), IT (Italienisch), ES (Spanisch), PL (Polnisch), NL (Niederländisch), RO (Rumänisch), PT (Portugiesisch), CS (Tschechisch), HU (Ungarisch), SV (Schwedisch), DA (Dänisch), FI (Finnisch), SK (Slowakisch), HR (Kroatisch), TR (Türkisch), RU (Russisch), BG (Bulgarisch), UK (Ukrainisch).

string | null
Allowed values: EN DE FR IT ES PL NL RO PT CS HU SV DA FI SK HR TR RU BG UK
parts_count

Anzahl der SMS Teile

integer
>= 1
chars_count

Anzahl der SMS Zeichen

integer | null
callback_data

Wert (String) welcher an Ihren Endpoint zurückgeschickt wird. Sie können z.B. Ihre eigene ID so übergeben und mit dem Zustellbericht (DLR) zurückbekommen.

string | null
<= 36 characters
bulk_id

Bulk ID

null | string
/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
key_id

API-Schlüssel-Kennung

integer
>= 1
service_code

Service code definiert ob Sie eine text2speech oder direct sms verschicken. Wir empfehlen direct sms für eine sichere Zustellung (see /me)

Allowed values: direct text2speech text2speech_ssml
is_text_deleted

Löschen von Nachrichtentext nach Zustellung der SMS

boolean
price

Preis

number
is_sent

True - SMS wurde bereits versendet, False - SMS wurde noch nicht versendet

boolean
requests

Link zu allen Anfragen über eine SMS-Liste

string | null
clicks

Link zur Zählung der Anfrage durch einen kurzen Link

string | null
attempts_count_max

Maximale Anzahl an Zustellversuchen für Sprachdienste (text2speech, text2speech_ssml). Zulässige Werte: null, 1, 2 oder 3 für text2speech/text2speech_ssml; für andere Dienste muss der Wert null sein.

integer | null
Allowed values: 1 2 3
Examples

Basic sms Message response

API response for a successfully request with minimum parameters

{
  "@context": "/contexts/sms",
  "@id": "/sms/11111111-2222-3333-4444-555555555555",
  "@type": "sms",
  "text": "Hello! This is a test SMS message.",
  "sender_id": "+19388888025",
  "phone": "+14155552671",
  "delivery_at": 0,
  "status_code": 0,
  "gateway_sent_at": 0,
  "source": 0,
  "dlr_code": 0,
  "ip": "10.1.1.1",
  "created_at": 1755868416,
  "is_unicode": false,
  "uuid": "11111111-2222-3333-4444-555555555555",
  "iso2": "US",
  "voice_lang": null,
  "parts_count": 1,
  "chars_count": 34,
  "callback_data": null,
  "bulk_id": null,
  "key_id": 8291,
  "service_code": "direct",
  "is_text_deleted": false,
  "price": 0.056,
  "is_sent": false,
  "requests": "/sms/11111111-2222-3333-4444-555555555555/requests",
  "clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks"
}

400

Abschnitt betitelt „400 “

Ungültige Eingabe

401

Abschnitt betitelt „401 “

Kunden-Nr oder API Key sind ungültig oder inaktiv!

403

Abschnitt betitelt „403 “

Account ist noch nicht innerhalb von 24h nach Registrierung aktiviert. Bitte warten oder Support kontaktieren

422

Abschnitt betitelt „422 “

Die Anfrage war korrekt formatiert, konnte aber aufgrund semantischer Fehler nicht verarbeitet werden

429

Abschnitt betitelt „429 “

Die IP-Adresse wurde vorübergehend blockiert, da in kurzer Zeit viele Anfragen mit ungültigen Anmeldeinformationen gesendet wurden. Bitte warten Sie und versuchen Sie es später.

Code Samples

 
#!/usr/bin/env bash
curl -X POST https://api.lox24.eu/sms/dryrun \
  -H 'Content-Type: application/json' \
  -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \
  -d '{
    "sender_id": "My Sender",
    "phone": "+49751234567",
    "source": 111,
    "service_code": "direct",
    "text": "Test message",
    "delivery_at": 1573724611,
    "is_unicode": true,
    "callback_data": "123456",
    "voice_lang": "DE"
}'