Zum Inhalt springen
LOX24 API Docs

Bestätigungscode (Verify Code) erstellen

POST
/verify_codes

Initiiert einen Verifizierungsprozess, indem ein neuer Verifizierungscode mit einer festgelegten Routing-Strategie erstellt wird.

Authorizations

Abschnitt betitelt „Authorizations “

Request Body required

Abschnitt betitelt „Request Body required “

The verify code request payload

Media type application/json

Verifizierungscode Schreib-Payload. Erstellt eine neue Verifizierungscode-Anfrage mit einer mehrstufigen Routing-Strategie.

object
phone
required

Empfängerrufnummer im internationalen Format (z.B. +491701234567).

string
>= 5 characters <= 30 characters
code

Benutzerdefinierter Verifizierungscode. Falls nicht angegeben, wird automatisch ein numerischer Code basierend auf code_length generiert.

string | null
>= 4 characters <= 8 characters
code_length

Länge des automatisch generierten Verifizierungscodes. Wird nur verwendet, wenn code nicht angegeben ist. Standard: 4.

integer | null
default: 4 >= 4 <= 8
lang

Sprache für die Standardnachrichtenvorlage. Bestimmt die Sprache des automatisch generierten SMS/Sprachtextes, wenn keine benutzerdefinierte template angegeben ist. Gilt nicht für den telegram-Kanal — Telegram sendet immer eine Systemnachricht in der Sprache der Telegram-App des Benutzers.

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

Benutzerdefinierte Daten, die mit dem Verifizierungscode gespeichert und in Webhook-Ereignissen zurückgegeben werden. Nützlich zur Zuordnung von Verifizierungsanfragen zu Ihren internen Systemen.

string | null
<= 128 characters
is_code_deleted

Wenn true, wird der Verifizierungscode nach dem Versand an den Empfänger aus dem Speicher gelöscht. Standard: false.

boolean | null
routing_strategy
required

Geordnete Liste der Zustellungskanäle. Jeder Schritt definiert einen Kanal. Wenn ein Kanal fehlschlägt oder eine Zeitüberschreitung auftritt, wird der nächste Schritt versucht. Mindestens ein Schritt ist erforderlich. Der Kanal sms kann nur der letzte Schritt sein. Doppelte Kanäle sind nicht erlaubt.

Array
>= 1 items
One of: discriminator: channel

Telegram-Routing-Schritt. Stellt den Verifizierungscode über eine Telegram-Bot-Nachricht zu.

object
channel
required

Zustellungskanal: Telegram.

string
Allowed values: telegram
timeout_sec

Zeit in Sekunden, die auf eine Antwort von Telegram gewartet wird, bevor auf den nächsten Schritt zurückgegriffen wird. Wenn nicht festgelegt, wird ein Systemstandard verwendet.

integer | null
default: 30 >= 30 <= 3600
Examples

Verify code with multi-channel routing

Create a verification code with a 3-step routing strategy: Telegram, Voice, and SMS.

{
  "phone": "+491701234567",
  "code": "1234",
  "is_code_deleted": false,
  "payload": "yours payload here",
  "lang": "EN",
  "routing_strategy": [
    {
      "channel": "telegram",
      "timeout_sec": 30
    },
    {
      "channel": "voice",
      "sender_id": "LOX24",
      "template": "Your code is {{code}}"
    },
    {
      "channel": "sms",
      "sender_id": "LOX24",
      "template": "Your code is {{code}}"
    }
  ]
}

Responses

Abschnitt betitelt „ Responses “

201

Abschnitt betitelt „201 “

Verify code created and delivery process started

Verifizierungscode Lese-Antwort. Enthält die vollständigen Details der Verifizierungscode-Anfrage, einschließlich aktuellem Status, Zustellungsverlauf und Kosteninformationen.

object
id

Eindeutige Kennung (UUID) der Verifizierungscode-Anfrage.

string
user_id

ID des Benutzers, der die Verifizierungscode-Anfrage erstellt hat.

integer
phone

Empfängerrufnummer im internationalen Format.

string
code

Der Wert des Verifizierungscodes. Wenn is_code_deleted gesetzt war und die Aufgabe abgeschlossen ist, fehlt der Code.

string | null
code_length

Länge des Verifizierungscodes.

integer | null
lang

Verwendete Sprache für die Nachrichtenvorlage.

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

Geordnete Liste der Zustellungskanäle, die für diese Anfrage konfiguriert wurden.

Array
One of: discriminator: channel

Telegram-Routing-Schritt. Stellt den Verifizierungscode über eine Telegram-Bot-Nachricht zu.

object
channel
required

Zustellungskanal: Telegram.

string
Allowed values: telegram
timeout_sec

Zeit in Sekunden, die auf eine Antwort von Telegram gewartet wird, bevor auf den nächsten Schritt zurückgegriffen wird. Wenn nicht festgelegt, wird ein Systemstandard verwendet.

integer | null
default: 30 >= 30 <= 3600
status

Aktueller Status des Verifizierungscodes: 0 = Neu, 5 = In Bearbeitung, 10 = Erfolg, 20 = Fehlgeschlagen, 100 = Fehler.

integer
Allowed values: 0 5 10 20 100
delivered_channel

Der Kanal, der den Verifizierungscode erfolgreich zugestellt hat. Null, falls noch nicht zugestellt oder die Zustellung fehlgeschlagen ist.

string | null
Allowed values: telegram voice sms
cost

Gesamtkosten der Verifizierungsanfrage in Euro-Cent. Null bis die Verarbeitung abgeschlossen ist.

integer | null
currency

Währungscode für die Kosten.

string | null
payload

Benutzerdefinierte Payload-Daten aus der ursprünglichen Anfrage.

string | null
created_at

Unix-Zeitstempel der Erstellung des Verifizierungscodes.

integer
updated_at

Unix-Zeitstempel der letzten Aktualisierung.

integer
history

Verarbeitungsverlauf für jeden Kanalversuch. Ein Eintrag pro Routing-Schritt.

Array<object>
object
id

UUID des Verlaufseintrags.

string
channel

Kanaltyp für diesen Versuch.

string
Allowed values: telegram voice sms
status

Status dieses Kanalversuchs: 0 = Neu, 5 = In Bearbeitung, 10 = Erfolg, 20 = Fehlgeschlagen, 100 = Fehler.

integer
processed_at

Unix-Zeitstempel der Verarbeitung dieses Schritts.

integer
external_id

Externe Anbieter-Nachrichten-ID.

string | null
is_code_deleted

Ob der Verifizierungscode nach dem Versand an den Empfänger aus dem Speicher gelöscht wurde.

boolean | null
Examples
Example multi_channel

Verify code response with multi-channel routing

Successful response after creating a verification code with a 3-step routing strategy. Telegram and voice channels failed, SMS succeeded.

{
  "id": "d7ad7539-fb8f-4dbb-a7f7-7c40babec969",
  "user_id": 12345,
  "phone": "+491701234567",
  "routing_strategy": [
    {
      "channel": "telegram",
      "timeout_sec": 30
    },
    {
      "channel": "voice",
      "sender_id": "LOX24",
      "template": "Your code is {{code}}"
    },
    {
      "channel": "sms",
      "sender_id": "LOX24",
      "template": "Your code is {{code}}"
    }
  ],
  "status": 10,
  "delivered_channel": "sms",
  "cost": 120,
  "currency": "EUR",
  "code": "1234",
  "code_length": 4,
  "payload": "yours payload here",
  "lang": "EN",
  "created_at": 1779903448,
  "updated_at": 1779903510,
  "history": [
    {
      "id": "bccaff09-59f2-11f1-a685-7c10c91d54a1",
      "channel": "telegram",
      "status": 20,
      "processed_at": 1779903478,
      "external_id": "tg_msg_001"
    },
    {
      "id": "bccaff09-59f2-11f1-a685-7c10c91d54a2",
      "channel": "voice",
      "status": 20,
      "processed_at": 1779903490,
      "external_id": "voice_msg_002"
    },
    {
      "id": "bccaff09-59f2-11f1-a685-7c10c91d54a3",
      "channel": "sms",
      "status": 10,
      "processed_at": 1779903510,
      "external_id": "sms_msg_003"
    }
  ],
  "is_code_deleted": false
}

400

Abschnitt betitelt „400 “

Ungültige Eingabe

401

Abschnitt betitelt „401 “

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

402

Abschnitt betitelt „402 “

Es gibt nicht genug Guthaben oder Kreditlinie auf dem Account!

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/verify_codes \
  -H 'Content-Type: application/json' \
  -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \
  -d '{
    "phone": "+491701234567",
    "code": "1234",
    "is_code_deleted": false,
    "payload": "yours payload here",
    "lang": "EN",
    "routing_strategy": [
      {
        "channel": "telegram",
        "timeout_sec": 30
      },
      {
        "channel": "voice",
        "sender_id": "LOX24",
        "template": "Your code is {{code}}"
      },
      {
        "channel": "sms",
        "sender_id": "LOX24",
        "template": "Your code is {{code}}"
      }
    ]
  }'