Preskočiť na obsah

Cascade API

Kaskádové API umožňuje odosielanie správ cez viacero platforiem s jedinou požiadavkou, pričom automaticky smerujú na Telegram Bot, Viber Bot, Viber Business Messages, RCS a SMS.

Základná adresa URL

https://restapi.smsbat.com

Autentifikácia

Cascade API používa autentifikáciu založenú na hlavičke s tromi možnými hlavičkami:

Metóda 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

Metóda 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

Metóda 3: Kľúč 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

Metóda Koncový bod Popis
Zverejniť /api/CascadeMessage/send_message/async Všeobecné posielanie kaskádových správ
Zverejniť /api/CascadeMessage/send_message/tg-viber/async Kaskáda s prioritou telegramu

Ako to funguje

S jedinou požiadavkou API Cascade automaticky doručí vašu správu cez viacero kanálov:

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

Správa je doručená cez prvý dostupný kanál s automatickým prechodom na ďalší kanál, ak doručenie zlyhá.

Kľúčové vlastnosti

Viackanálové doručovanie

Pošlite jednu správu a oslovte používateľov na akejkoľvek platforme:

  • Telegram Bot
  • Viber Bot
  • Obchodné správy Viber
  • RCS (Rich Communication Services)
  • SMS

Variabilná substitúcia

Použite dynamický obsah s variabilnými zástupnými symbolmi:

  • %name=id% - Textové premenné
  • %url=id% - premenné adresy URL
  • %short_url=id% - Skrátené premenné adresy URL

Plánovanie správ

Naplánovať správy na budúce doručenie:

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

Time-to-Live (TTL)

Nastaviť čas vypršania platnosti správ:

{
  "ttl": 3600
}

Typy správ

Cascade API podporuje:

  • Transakčné - Potvrdenia objednávok, upozornenia
  • Promo - Marketingové a propagačné správy
  • Viber Surveys - Interaktívne prieskumy
  • Flash hovory - Telefonické overenie

Formát odpovede

Úspešné odpovede sa vrátia:

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]
  • messageId - GUID na identifikáciu správy
  • trackinId - Reťazec na sledovanie stavu doručenia

Rýchly štart

  1. Odoslať správy – Začnite odosielať kaskádové správy
  2. Premenné správy – Používajte dynamický obsah
  3. Typy správ – Preskúmajte typy správ

Príklad žiadosti

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

Spracovanie chýb

Stavové kódy HTTP:

  • 200 OK - Žiadosť bola úspešná
  • 400 Bad Request - Neplatný formát požiadavky
  • 401 Unauthorized - Autentifikácia zlyhala
  • 429 Too Many Requests - Prekročený limit sadzby
  • 500 Interná chyba servera - Chyba servera

Výhody

Jednotná integrácia

Jedna integrácia API pre všetky kanály správ – nie je potrebné integrovať sa s každou platformou samostatne.

Automatické smerovanie

Inteligentné smerovanie zaisťuje doručenie správ najlepším dostupným kanálom pre každého príjemcu.

Optimalizácia nákladov

Kaskáda najprv vyskúša lacnejšie kanály a automaticky sa vráti k drahším možnostiam iba v prípade potreby.

Vyššie ceny za doručenie

Viaceré záložné kanály zaisťujú, že sa vaša správa dostane k príjemcovi, aj keď primárny kanál zlyhá.

Ďalšie kroky