Към съдържанието

Cascade API

Cascade API позволява изпращане на съобщения през множество платформи с една единствена заявка, автоматизирайки маршрутизирането към Telegram Bot, Viber Bot, Viber Business Messages, RCS и SMS.

Базов URL адрес

https://restapi.smsbat.com

Автентикация

Cascade API използва удостоверяване, базирано на заглавка (header), с три възможни хедъра за удостоверяване:

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

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: Токен на Viber Bot

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: Ключ на Telegram Bot

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

Налични крайни точки (Endpoints)

Метод Endpoint Описание
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 Bot
  • Viber Bot
  • Viber Business Messages
  • RCS (Rich Communication Services)
  • SMS

Заместване на променливи

Използвайте динамично съдържание с плейсхолдъри (знак) за променливи:

  • %name=id% - Текстови променливи
  • %url=id% - URL променливи
  • %short_url=id% - Променливи за съкратени URL адреси

Планиране на съобщения

Планирайте съобщенията за бъдеща доставка:

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

Време за живот (TTL)

Задайте време на изтичане за съобщенията:

{
  "ttl": 3600
}

Видове съобщения

Cascade API поддържа:

  • Транзакционни (Transactional) - Потвърждения на поръчки, известия
  • Промо (Promo) - Маркетингови и промоционални съобщения
  • Viber Survey - Интерактивни анкети
  • Flash Calls - Верификация по телефон

Формат на отговора

Успешните отговори връщат (return):

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]
  • messageId - GUID за идентификация на съобщението в системата
  • trackinId - Низ (string) за проследяване на статуса на доставка, който вие сте подали

Бърз старт

  1. Изпращане на съобщения - Започнете да изпращате каскадни съобщения
  2. Променливи в съобщенията - Използвайте динамично съдържание
  3. Видове съобщения - Разгледайте видовете съобщения

Примерна заявка

{
  "messages": [
    {
      "recipient": "+380XXXXXXXXX",
      "text": "Здравейте %name=1%, вашата поръчка #%url=2% е готова!",
      "variables": [
        {
          "id": 1,
          "value": "Иван"
        },
        {
          "id": 2,
          "value": "12345"
        }
      ]
    }
  ]
}

Обработка на грешки

HTTP кодове за състояние:

  • 200 OK - Заявката е успешна
  • 400 Bad Request - Невалиден формат на заявката
  • 401 Unauthorized - Неуспешно удостоверяване (грешен ключ)
  • 429 Too Many Requests - Надхвърлено ограничение на скоростта на заявките (Rate limit)
  • 500 Internal Server Error - Грешка в сървъра

Предимства

Единична интеграция

Една API интеграция за всички канали за съобщения - няма нужда да се интегрирате с всяка платформа поотделно.

Автоматично маршрутизиране

Интелигентното маршрутизиране гарантира доставката на съобщението чрез най-добрия наличен канал за всеки получател.

Оптимизация на разходите

Cascade първо опитва по-евтини канали, автоматично прибягвайки към по-скъпи опции само когато е необходимо.

По-висок процент на доставка

Множеството резервни канали гарантират, че вашето съобщение ще достигне до получателя, дори ако основният канал се провали.

Следващи стъпки