Hyppää sisältöön

Cascade API

Cascade API mahdollistaa viestien lähettämisen useilla alustoilla yhdellä pyynnöllä, automaattisesti reitittäen Telegram Botiin, Viber Botiin, Viber Business Messagesiin, RCS:ään ja SMS:iin.

Perus-URL-osoite

https://restapi.smsbat.com

Todennus

Cascade API käyttää otsikkopohjaista todennusta kolmella mahdollisella todennusotsikolla:

Tapa 1: SMSBAT API-avain

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

Tapa 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

Tapa 3: Telegram-bottiavain

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

Saatavilla olevat päätepisteet

Menetelmä Päätepiste Kuvaus
POST /api/CascadeMessage/send_message/async Yleinen kaskadiviestien lähetys
POST `/api/CascadeMessage/send_message/tg-viber/async' Telegram-priorisoitu kaskadi

Kuinka se toimii

Yhdellä API-pyynnöllä Cascade toimittaa viestisi automaattisesti useille kanaville:

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

Viesti toimitetaan ensimmäisen saatavilla olevan kanavan kautta ja automaattinen palautus seuraavalle kanavalle, jos toimitus epäonnistuu.

Tärkeimmät ominaisuudet

Monikanavainen toimitus

Lähetä yksi viesti, tavoita käyttäjät millä tahansa alustalla:

  • Telegram Bot
  • Viber Bot
  • Viber-yritysviestit
  • RCS (Rich Communication Services)
  • SMS

Muuttujan korvaaminen

Käytä dynaamista sisältöä muuttuvien paikkamerkkien kanssa:

  • %name=id% - Tekstimuuttujat
  • %url=id% - URL-muuttujat
  • %short_url=id% - Lyhennetyt URL-muuttujat

Viestin ajoitus

Ajoita viestit tulevaa toimitusta varten:

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

Elävä aika (TTL)

Viestien vanhenemisajan asettaminen:

{
  "ttl": 3600
}

Viestityypit

Cascade API tukee:

  • Tapahtuma - Tilausvahvistukset, ilmoitukset
  • Promo - Markkinointi- ja mainosviestit
  • Viber Surveys - Interaktiiviset kyselyt
  • Flash-puhelut - Puhelimen vahvistus

Vastausmuoto

Onnistuneet vastaukset palautuvat:

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]
  • "messageId" - GUID viestin tunnistamiseen
  • "trackinId" - merkkijono toimitustilan seurantaa varten

Pika-aloitus

  1. Lähetä viestejä - Aloita sarjaviestien lähettäminen
  2. Viestimuuttujat - Käytä dynaamista sisältöä
  3. Viestityypit - Tutustu viestityyppeihin

Pyyntöesimerkki

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

Virheiden käsittely

HTTP-tilakoodit:

  • "200 OK" - Pyyntö onnistui
  • "400 virheellinen pyyntö" - Virheellinen pyyntömuoto
  • 401 Luvaton - Todennus epäonnistui
  • "429 liian monta pyyntöä" - Raja ylitetty
  • "500 Sisäinen palvelinvirhe" - Palvelinvirhe

Edut

Yksi integraatio

Yksi API-integraatio kaikille viestikanaville – ei tarvitse integroida jokaiseen alustaan erikseen.

Automaattinen reititys

Älykäs reititys varmistaa viestin toimituksen kullekin vastaanottajalle parhaan saatavilla olevan kanavan kautta.

Kustannusoptimointi

Cascade kokeilee ensin halvempia kanavia ja palaa automaattisesti kalliimpiin vaihtoehtoihin vain tarvittaessa.

Korkeammat toimitushinnat

Useat varakanavat varmistavat, että viestisi tavoittaa vastaanottajan, vaikka ensisijainen kanava epäonnistuisi.

Seuraavat vaiheet