Pāriet uz saturu

Kaskādes API

Cascade API ļauj nosūtīt ziņojumus vairākās platformās ar vienu pieprasījumu, automātiski maršrutējot uz Telegram Bot, Viber Bot, Viber Business Messages, RCS un SMS.

Pamata URL

https://restapi.smsbat.com

Autentifikācija

Kaskādes API izmanto uz galvenēm balstītu autentifikāciju ar trim iespējamām autentifikācijas galvenēm:

1. metode: SMSBAT API atslēga

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. metode: 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. metode: Telegram Bot atslēga

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

Pieejamie galapunkti

Metode Galapunkts Apraksts
POST /api/CascadeMessage/send_message/async Vispārējā kaskādes ziņojumu sūtīšana
POST /api/CascadeMessage/send_message/tg-viber/async Telegrammas prioritātes kaskāde

Kā tas darbojas

Ar vienu API pieprasījumu Cascade automātiski piegādā jūsu ziņojumu vairākos kanālos:

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

Ziņojums tiek piegādāts, izmantojot pirmo pieejamo kanālu, ar automātisku atkāpšanos uz nākamo kanālu, ja piegāde neizdodas.

Galvenās funkcijas

Daudzkanālu piegāde

Nosūtiet vienu ziņojumu, sasniedziet lietotājus jebkurā platformā:

  • Telegrammas robots
  • Viber Bot
  • Viber biznesa ziņojumi
  • RCS (bagātīgi sakaru pakalpojumi)
  • SMS

Mainīgā aizstāšana

Izmantojiet dinamisku saturu ar mainīgiem vietturiem:

  • %name=id% - teksta mainīgie
  • %url=id% - URL mainīgie
  • %short_url=id% - saīsināti URL mainīgie

Ziņojumu plānošana

Ieplānojiet ziņojumus turpmākai piegādei:

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

Dzīves laiks (TTL)

Iestatiet ziņojumu derīguma termiņu:

{
  "ttl": 3600
}

Ziņojumu veidi

Kaskādes API atbalsta:

  • Darījumu - Pasūtījumu apstiprinājumi, paziņojumi
  • Reklāma - mārketinga un reklāmas ziņojumi
  • Viber Surveys - Interaktīvas aptaujas
  • Flash Call - tālruņa pārbaude

Atbildes formāts

Atgriežas veiksmīgās atbildes:

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]
  • messageId — GUID ziņojuma identifikācijai — TrackinId — piegādes statusa izsekošanas virkne

Īsā sākšana

  1. Sūtīt ziņojumus — sāciet sūtīt kaskādes ziņojumus
  2. Ziņojumu mainīgie — izmantojiet dinamisku saturu
  3. Ziņojumu veidi — izpētiet ziņojumu veidus

Pieprasījuma piemērs

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

Kļūdu apstrāde

HTTP statusa kodi:

  • 200 OK - Pieprasījums ir veiksmīgs - 400 slikts pieprasījums — nederīgs pieprasījuma formāts
  • 401 Neautorizēts - Autentifikācija neizdevās
  • "429 pārāk daudz pieprasījumu" - pārsniegts likmes ierobežojums
  • "500 Iekšējā servera kļūda" - servera kļūda

Ieguvumi

Viena integrācija

Viena API integrācija visiem ziņojumapmaiņas kanāliem — nav jāintegrē ar katru platformu atsevišķi.

Automātiskā maršrutēšana

Viedā maršrutēšana nodrošina ziņojumu piegādi, izmantojot labāko pieejamo kanālu katram adresātam.

Izmaksu optimizācija

Cascade vispirms izmēģina lētākus kanālus, automātiski atgriežoties pie dārgākām opcijām tikai tad, kad tas ir nepieciešams.

Augstākas piegādes cenas

Vairāki rezerves kanāli nodrošina, ka jūsu ziņojums sasniedz adresātu pat tad, ja primārais kanāls neizdodas.

Nākamie soļi