Cascade API

Cascade API дозволяє надсилати повідомлення через різні платформи за допомогою лише одного запиту. Він автоматично маршрутизує повідомлення між Telegram Bot, Viber Bot, Viber Business Messages, RCS та SMS.

Базовий URL

https://restapi.smsbat.com

Авторизація

Cascade API використовує авторизацію через заголовки. Є три можливі варіанти; потрібно передати хоча б один з них:

Метод 1: SMSBAT API Ключ

curl -X POST https://restapi.smsbat.com/api/CascadeMessage/send_message/async \
  -H "X-Authorization-Key: ваш-smsbat-api-ключ" \
  -H "Content-Type: application/json" \
  -d @request.json

Метод 2: Viber Bot Токен

curl -X POST https://restapi.smsbat.com/api/CascadeMessage/send_message/async \
  -H "X-Viber-Auth-Token: ваш-viber-bot-токен" \
  -H "Content-Type: application/json" \
  -d @request.json

Метод 3: Telegram Bot Ключ

curl -X POST https://restapi.smsbat.com/api/CascadeMessage/send_message/async \
  -H "X-Tg-Bot-Key: ваш-telegram-bot-ключ" \
  -H "Content-Type: application/json" \
  -d @request.json

Доступні Ендпоінти

Метод	Ендпоінт	Опис
POST	`/api/CascadeMessage/send_message/async`	Стандартна каскадна розсилка повідомлень
POST	`/api/CascadeMessage/send_message/tg-viber/async`	Каскад із пріоритетом Telegram та Viber

Як це працює

Завдяки одному запиту до API, Cascade автоматично намагається доставити повідомлення по ланцюжку каналів:

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

Повідомлення доставляється через перший доступний канал з автоматичним переходом на наступний канал (fallback), якщо доставка не вдалася.

Основні можливості

Багатоканальна доставка

Створіть одне повідомлення та доставляйте його в:

Telegram Боти
Viber Боти
Viber Бізнес-повідомлення
RCS (Rich Communication Services)
SMS

Підстановка Змінних (Variables)

Використовуйте динамічний контент зі спеціальними плейсхолдерами:

%name=id% - Текстові змінні (імена, суми тощо)
%url=id% - Змінні для URL-адрес
%short_url=id% - Скорочені URL

Планування розсилок

Плануйте запити на відправку у майбутньому:

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

Час життя повідомлення (TTL)

Додавайте термін придатності повідомлення:

{
  "ttl": 3600
}

Типи повідомлень

Cascade API підтримує такі формати:

Транзакційні (Transactional) - сповіщення, замовлення, реєстрації
Промо (Promo) - маркетингові повідомлення
Viber Опитування - інтерактивні опитування в чаті
Flash Calls (Флеш кол) - верифікація за допомогою дзвінка

Формат відповіді

Успішні відповіді повертають:

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]

messageId - GUID повідомлення в системі для подальшої ідентифікації
trackinId - Ваш користувацький рядок для отримання звітів

Приклад запиту

{
  "messages": [
    {
      "recipient": "+380XXXXXXXXX",
      "text": "Вітаємо, %name=1%, ваше замовлення #%url=2% готове!",
      "variables": [
        {
          "id": 1,
          "value": "Іване"
        },
        {
          "id": 2,
          "value": "12345"
        }
      ]
    }
  ]
}

Обробка помилок (HTTP статуси)

Коди стану HTTP:

200 OK - Запит успішний
400 Bad Request - Некоректний формат запиту
401 Unauthorized - Помилка авторизації (Некоректний ключ)
429 Too Many Requests - Перевищено ліміт запитів (Rate Limit)
500 Internal Server Error - Помилка на стороні сервера

Переваги

Єдина інтеграція

Одна інтеграція для всіх каналів розсилки – більше не потрібно інтегруватися з кожною платформою окремо.

Автоматична маршрутизація

Розумний роутинг доставляє повідомлення в найактуальніший чи найвигідніший канал для кожного користувача.

Оптимізація витрат

Cascade спочатку намагається надіслати повідомлення через дешевші канали, автоматично перемикаючись на резервні (дорожчі) лише у разі потреби.

Вища конверсія та доставляння

Кілька резервних каналів гарантують, що клієнт отримає повідомлення, навіть якщо його основний месенджер недоступний.