Skoči na vsebino

Cascade API

Cascade API omogoča pošiljanje sporočil na več platformah z eno samo zahtevo, samodejno usmerjanje v Telegram Bot, Viber Bot, Viber Business Messages, RCS in SMS.

Osnovni URL

https://restapi.smsbat.com

Preverjanje pristnosti

Cascade API uporablja preverjanje pristnosti na podlagi glave s tremi možnimi glavami za preverjanje pristnosti:

1. način: ključ API SMSBAT

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

2. način: 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

3. način: Telegram Bot Key

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

Razpoložljive končne točke

Metoda Končna točka Opis
OBJAVI /api/CascadeMessage/send_message/async Splošno kaskadno pošiljanje sporočil
OBJAVI /api/CascadeMessage/send_message/tg-viber/async Kaskada s prednostjo Telegrama

Kako deluje

Z eno samo zahtevo API-ja Cascade samodejno dostavi vaše sporočilo prek več kanalov:

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

Sporočilo je dostavljeno prek prvega razpoložljivega kanala s samodejnim povratkom na naslednji kanal, če dostava ne uspe.

Ključne lastnosti

Večkanalna dostava

Pošljite eno sporočilo, dosežete uporabnike na kateri koli platformi:

  • Telegram Bot
  • Viber Bot
  • Poslovna sporočila Viber
  • RCS (bogate komunikacijske storitve)
  • SMS

Zamenjava spremenljivke

Uporabite dinamično vsebino s spremenljivimi ogradami:

  • %name=id% - Besedilne spremenljivke
  • %url=id% - spremenljivke URL
  • %short_url=id% - Skrajšane spremenljivke URL

Načrtovanje sporočil

Razpored sporočil za prihodnjo dostavo:

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

Življenjska doba (TTL)

Nastavite čas poteka za sporočila:

{
  "ttl": 3600
}

Vrste sporočil

Cascade API podpira:

  • Transakcijsko - potrditve naročil, obvestila
  • Promocija - Tržna in promocijska sporočila
  • Viber Ankete - Interaktivne ankete
  • Flash Calls - Telefonsko preverjanje

Oblika odgovora

Uspešni odgovori vrnejo:

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]
  • messageId - GUID za identifikacijo sporočila
  • trackinId - Niz za sledenje statusu dostave

Hitri začetek

  1. Pošlji sporočila - Začni pošiljati kaskadna sporočila
  2. Spremenljivke sporočil - Uporabite dinamično vsebino
  3. Vrste sporočil - Raziščite vrste sporočil

Primer zahteve

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

Obravnava napak

Statusne kode HTTP:

  • 200 OK - Zahteva uspešna
  • 400 Bad Request - Neveljavna oblika zahteve
  • 401 Nepooblaščeno - Preverjanje pristnosti ni uspelo
  • 429 Too Many Requests - Omejitev stopnje je presežena
  • 500 Internal Server Error - Napaka strežnika

Prednosti

Enotna integracija

Ena integracija API-ja za vse kanale za sporočanje – ni potrebe po integraciji z vsako platformo posebej.

Samodejno usmerjanje

Pametno usmerjanje zagotavlja dostavo sporočil prek najboljšega razpoložljivega kanala za vsakega prejemnika.

Optimizacija stroškov

Cascade najprej poskusi s cenejšimi kanali in se samodejno vrne na dražje možnosti le, ko je to potrebno.

Višje cene dostave

Več nadomestnih kanalov zagotavlja, da vaše sporočilo doseže prejemnika, tudi če primarni kanal odpove.

Naslednji koraki