Zum Inhalt

Cascade-API

Die Cascade-API ermöglicht das Senden von Nachrichten über mehrere Plattformen mit einer einzigen Anfrage und die automatische Weiterleitung an Telegram Bot, Viber Bot, Viber Business Messages, RCS und SMS.

Basis-URL

https://restapi.smsbat.com

Authentifizierung

Die Cascade-API verwendet eine Header-basierte Authentifizierung mit drei möglichen Authentifizierungsheadern:

Methode 1: SMSBAT-API-Schlüssel

curl -X POST https://restapi.smsbat.com/api/CascadeMessage/send_message/async \
  -H "X-Authorization-Key: your-smsbat-api-key" \
  -H "Content-Type: application/json" \
  -d @request.json

Methode 2: Viber-Bot-Token

curl -X POST https://restapi.smsbat.com/api/CascadeMessage/send_message/async \
  -H "X-Viber-Auth-Token: your-viber-bot-token" \
  -H "Content-Type: application/json" \
  -d @request.json

Methode 3: Telegram-Bot-Schlüssel

curl -X POST https://restapi.smsbat.com/api/CascadeMessage/send_message/async \
  -H "X-Tg-Bot-Key: your-telegram-bot-key" \
  -H "Content-Type: application/json" \
  -d @request.json

Verfügbare Endpunkte

Methode Endpunkt Beschreibung
POST /api/CascadeMessage/send_message/async Allgemeiner kaskadierter Nachrichtenversand
POST /api/CascadeMessage/send_message/tg-viber/async Telegramm-priorisierte Kaskade

Wie es funktioniert

Mit einer einzigen API-Anfrage übermittelt Cascade Ihre Nachricht automatisch über mehrere Kanäle:

Telegram Bot → Viber Bot → Viber Business → RCS → SMS

Die Nachricht wird über den ersten verfügbaren Kanal zugestellt, wobei automatisch auf den nächsten Kanal zurückgegriffen wird, wenn die Zustellung fehlschlägt.

Hauptmerkmale

Multi-Channel-Lieferung

Senden Sie eine Nachricht und erreichen Sie Benutzer auf jeder Plattform:

  • Telegramm-Bot
  • Viber Bot
  • Viber-Geschäftsnachrichten
  • RCS (Rich Communication Services)
  • SMS

Variablenersetzung

Verwenden Sie dynamische Inhalte mit variablen Platzhaltern:

  • %name=id% – Textvariablen
  • „%url=id%“ – URL-Variablen
  • „%short_url=id%“ – Verkürzte URL-Variablen

Nachrichtenplanung

Planen Sie Nachrichten für die zukünftige Zustellung:

{
  "scheduledTime": "2025-01-24T12:00:00Z"
}

Lebensdauer (TTL)

Ablaufzeit für Nachrichten festlegen:

{
  "ttl": 3600
}

Nachrichtentypen

Cascade API unterstützt:

  • Transaktional – Auftragsbestätigungen, Benachrichtigungen
  • Promo – Marketing- und Werbebotschaften
  • Viber-Umfragen – Interaktive Umfragen
  • Flash-Anrufe - Telefonverifizierung

Antwortformat

Erfolgreiche Antworten geben Folgendes zurück:

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]
  • „messageId“ – GUID zur Nachrichtenidentifizierung
  • „trackinId“ – Zeichenfolge zur Verfolgung des Lieferstatus

Schnellstart

  1. Nachrichten senden – Beginnen Sie mit dem Senden von Kaskadennachrichten
  2. Nachrichtenvariablen – Dynamischen Inhalt verwenden
  3. Nachrichtentypen – Nachrichtentypen erkunden

Beispiel für Anfrage

{
  "messages": [
    {
      "recipient": "+380XXXXXXXXX",
      "text": "Hello %name=1%, your order #%url=2% is ready!",
      "variables": [
        {
          "id": 1,
          "value": "John"
        },
        {
          "id": 2,
          "value": "12345"
        }
      ]
    }
  ]
}

Fehlerbehandlung

HTTP-Statuscodes:

  • „200 OK“ – Anfrage erfolgreich
  • „400 Bad Request“ – Ungültiges Anforderungsformat
  • „401 Unauthorized“ – Authentifizierung fehlgeschlagen
  • „429 Too Many Requests“ – Ratenlimit überschritten
  • „500 Internal Server Error“ – Serverfehler

Vorteile

Einzelne Integration

Eine API-Integration für alle Messaging-Kanäle – keine separate Integration in jede Plattform erforderlich.

Automatisches Routing

Intelligentes Routing gewährleistet die Nachrichtenübermittlung über den besten verfügbaren Kanal für jeden Empfänger.

Kostenoptimierung

Cascade probiert zunächst günstigere Kanäle aus und greift bei Bedarf automatisch auf teurere Optionen zurück.

Höhere Lieferraten

Mehrere Fallback-Kanäle stellen sicher, dass Ihre Nachricht den Empfänger erreicht, auch wenn der primäre Kanal ausfällt.

Nächste Schritte