Ga naar inhoud

Cascade-API

Met de Cascade API kunnen berichten via meerdere platforms worden verzonden met één enkel verzoek, waarbij de berichten automatisch worden doorgestuurd naar Telegram Bot, Viber Bot, Viber Business Messages, RCS en SMS.

Basis-URL

https://restapi.smsbat.com

Authenticatie

Cascade API maakt gebruik van op headers gebaseerde authenticatie met drie mogelijke authenticatieheaders:

Methode 1: SMSBAT API-sleutel

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-sleutel

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

Beschikbare eindpunten

Werkwijze Eindpunt Beschrijving
POST /api/CascadeMessage/send_message/async Algemeen cascadebericht verzenden
POST /api/CascadeMessage/send_message/tg-viber/async Cascade met telegramprioriteit

Hoe het werkt

Met één enkel API-verzoek bezorgt Cascade uw boodschap automatisch via meerdere kanalen:

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

Het bericht wordt afgeleverd via het eerste beschikbare kanaal, met automatische terugval naar het volgende kanaal als de bezorging mislukt.

Belangrijkste kenmerken

Levering via meerdere kanalen

Stuur één bericht en bereik gebruikers op elk platform:

  • Telegrambot
  • Viberbot
  • Viber zakelijke berichten
  • RCS (rijke communicatiediensten)
  • Sms'en

Variabele vervanging

Gebruik dynamische inhoud met variabele tijdelijke aanduidingen:

  • %name=id% - Tekstvariabelen
  • %url=id% - URL-variabelen
  • %short_url=id% - Verkorte URL-variabelen

Berichtplanning

Plan berichten voor toekomstige bezorging:

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

Tijd tot live (TTL)

Vervaltijd voor berichten instellen:

{
  "ttl": 3600
}

Berichttypen

Cascade-API ondersteunt:

  • Transactioneel - Orderbevestigingen, meldingen
  • Promo - Marketing- en promotieberichten
  • Viber-enquêtes - Interactieve enquêtes
  • Flash-oproepen - Telefoonverificatie

Antwoordformaat

Succesvolle reacties retourneren:

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]
  • messageId - GUID voor berichtidentificatie
  • trackinId - Tekenreeks voor het volgen van de leveringsstatus

Snelle start

  1. Berichten verzenden - Begin met het verzenden van trapsgewijze berichten
  2. Berichtvariabelen - Gebruik dynamische inhoud
  3. Berichttypen - Ontdek berichttypen

Vraagvoorbeeld

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

Foutafhandeling

HTTP-statuscodes:

  • 200 OK - Verzoek succesvol
  • 400 Bad Request - Ongeldig verzoekformaat
  • 401 Niet geautoriseerd - Authenticatie mislukt
  • 429 Te veel verzoeken - Tarieflimiet overschreden
  • 500 Interne serverfout - Serverfout

Voordelen

Enkele integratie

Eén API-integratie voor alle berichtenkanalen - het is niet nodig om met elk platform afzonderlijk te integreren.

Automatische routering

Slimme routering zorgt ervoor dat berichten worden afgeleverd via het best beschikbare kanaal voor elke ontvanger.

Kostenoptimalisatie

Cascade probeert eerst goedkopere kanalen en valt alleen automatisch terug op duurdere opties als dat nodig is.

Hogere bezorgtarieven

Meerdere fallback-kanalen zorgen ervoor dat uw bericht de ontvanger bereikt, zelfs als het primaire kanaal faalt.

Volgende stappen