Kaskádové API

Kaskádové API umožňuje posílat zprávy přes více platforem s jediným požadavkem, automaticky směrovat na Telegram Bot, Viber Bot, Viber Business Messages, RCS a SMS.

Základní URL

https://restapi.smsbat.com

Autentizace

Cascade API používá autentizaci založenou na hlavičkách se třemi možnými autentizačními hlavičkami:

Metoda 1: SMSBAT API Key

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

Metoda 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

Metoda 3: Klíč telegramového robota

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

Dostupné koncové body

Metoda	Koncový bod	Popis
PŘÍSPĚVEK	`/api/CascadeMessage/send_message/async`	Obecné kaskádové zasílání zpráv
PŘÍSPĚVEK	`/api/CascadeMessage/send_message/tg-viber/async`	Kaskáda s prioritou telegramu

Jak to funguje

S jediným požadavkem API Cascade automaticky doručí vaši zprávu přes několik kanálů:

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

Zpráva je doručena prostřednictvím prvního dostupného kanálu s automatickým přechodem na další kanál, pokud se doručení nezdaří.

Klíčové vlastnosti

Vícekanálové doručení

Pošlete jednu zprávu a oslovte uživatele na jakékoli platformě:

Telegram Bot
Bot Viber
Viber Business Messages
RCS (Rich Communication Services)
SMS

Variabilní substituce

Použijte dynamický obsah s proměnnými zástupnými symboly:

%name=id% - Textové proměnné
%url=id% - Proměnné adresy URL
%short_url=id% - Zkrácené URL proměnné

Plánování zpráv

Naplánovat zprávy pro budoucí doručení:

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

Time-to-Live (TTL)

Nastavit dobu vypršení platnosti zpráv:

{
  "ttl": 3600
}

Typy zpráv

Cascade API podporuje:

Transakční - Potvrzení objednávky, upozornění
Promo - Marketingová a propagační sdělení
Viber Surveys - Interaktivní průzkumy
Flash Calls - Telefonické ověření

Formát odpovědi

Úspěšné odpovědi se vrátí:

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]

messageId - GUID pro identifikaci zprávy
trackinId - Řetězec pro sledování stavu doručení

Rychlý start

Odeslat zprávy – Začněte odesílat kaskádové zprávy
Proměnné zprávy – Používejte dynamický obsah
Typy zpráv – Prozkoumejte typy zpráv

Příklad požadavku

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

Zpracování chyb

Stavové kódy HTTP:

200 OK - Žádost byla úspěšná
400 Bad Request - Neplatný formát požadavku
401 Unauthorized - Autentizace se nezdařila
429 Příliš mnoho požadavků - Překročen limit sazby
500 Internal Server Error - Chyba serveru

Výhody

Jednoduchá integrace

Jedna integrace API pro všechny kanály zasílání zpráv – není třeba se integrovat s každou platformou zvlášť.

Automatické směrování

Inteligentní směrování zajišťuje doručení zpráv nejlepším dostupným kanálem pro každého příjemce.

Optimalizace nákladů

Kaskáda nejprve zkouší levnější kanály a automaticky se vrátí k dražším možnostem pouze v případě potřeby.

Vyšší sazby za doručení

Více záložních kanálů zajišťuje, že se vaše zpráva dostane k příjemci, i když primární kanál selže.

Další kroky

– Send Cascade Messages – Přečtěte si, jak odesílat zprávy - Proměnné zprávy - Práce s dynamickým obsahem – Typy zpráv – Prozkoumejte dostupné typy zpráv