Keri sisuni

Kaskaadi API

Cascade API võimaldab saata sõnumeid mitmel platvormil ühe päringuga, suunates need automaatselt Telegram Boti, Viber Boti, Viber Business Messages, RCS-i ja SMS-i.

Baas-URL

https://restapi.smsbat.com

Autentimine

Cascade API kasutab päisepõhist autentimist kolme võimaliku autentimispäisega:

1. meetod: SMSBAT API võti

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. meetod: Viber Boti märk

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. meetod: Telegrami roboti võti

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

Saadaolevad lõpp-punktid

Meetod Lõpp-punkt Kirjeldus
POSTITUS /api/CascadeMessage/send_message/async Üldine kaskaadsõnumite saatmine
POSTITUS `/api/CascadeMessage/send_message/tg-viber/async' Telegrammi prioriteediga kaskaad

Kuidas see töötab

Ühe API taotlusega edastab Cascade teie sõnumi automaatselt mitme kanali kaudu:

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

Sõnum edastatakse esimese saadaoleva kanali kaudu, edastades automaatse tagasipöördumisega järgmisele kanalile, kui edastamine ebaõnnestub.

Põhifunktsioonid

Mitme kanaliga kohaletoimetamine

Saatke üks sõnum, jõudke kasutajateni mis tahes platvormil:

  • Telegrami robot
  • Viber Bot
  • Viberi ärisõnumid
  • RCS (rikkad sideteenused)
  • SMS

Muutuja asendus

Kasutage muutuvate kohahoidjatega dünaamilist sisu:

  • %name=id% - tekstimuutujad
  • %url=id% - URL-i muutujad
  • %short_url=id% - lühendatud URL-i muutujad

Sõnumite ajastamine

Sõnumite ajastamine tulevaseks kohaletoimetamiseks:

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

Eluaeg (TTL)

Määrake sõnumite aegumisaeg:

{
  "ttl": 3600
}

Sõnumitüübid

Cascade API toetab:

  • Tehing - Tellimuste kinnitused, teatised
  • Promo - turundus- ja reklaamsõnumid
  • Viber Surveys - interaktiivsed uuringud
  • Kiirkõned - Telefoni kinnitus

Vastusevorming

Edukad vastused tagastatakse:

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]
  • "messageId" - GUID sõnumi tuvastamiseks
  • "trackinId" – string tarneoleku jälgimiseks

Kiire algus

  1. Saada sõnumeid – alustage kaskaadsõnumite saatmist
  2. Sõnumi muutujad – kasutage dünaamilist sisu
  3. Sõnumitüübid – uurige sõnumitüüpe

Taotluse näide

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

Vigade käsitlemine

HTTP olekukoodid:

  • "200 OK" - taotlus õnnestus – „400 vigane taotlus” – taotluse vorming on kehtetu
  • "401 Volitamata" - Autentimine ebaõnnestus
  • "429 liiga palju taotlust" - määra piirang ületatud
  • "500 sisemine serveri viga" - serveri viga

Kasu

Ühekordne integreerimine

Üks API-integratsioon kõigi sõnumikanalite jaoks – pole vaja integreerida iga platvormiga eraldi.

Automaatne marsruutimine

Nutikas marsruutimine tagab sõnumi edastamise iga adressaadi jaoks parima saadaoleva kanali kaudu.

Kulude optimeerimine

Cascade proovib esmalt odavamaid kanaleid, naases automaatselt kallimate valikute juurde vaid vajaduse korral.

Kõrgemad tarnehinnad

Mitu varukanalit tagavad, et teie sõnum jõuab adressaadini isegi siis, kui esmane kanal ebaõnnestub.

Järgmised sammud