Перейти до змісту

SMSBAT API

SMSBAT — це RESTful API платформа для надсилання різноманітних типів повідомлень, включно з Viber Carousel, Viber Survey (опитування), Viber Promo (зображення, відео), транзакційними Viber повідомленнями (Viber Business Messages), OTP-сповіщеннями (через Viber або Flash Call), а також каскадними розсилками з переходом на SMS чи інші канали (fallback).

Базовий URL

Усі запити до SMSBAT API надсилаються на адресу (ендпоінт) з локалізацією. Перед початком роботи обов'язково уточніть адресу у вашого Менеджера.

Приклад: https://restapi.smsbat.com (фактичний URL може відрізнятися залежно від вашого регіону).

Авторизація

SMSBAT API підтримує три методи авторизації:

Метод 1: HTTP Basic Auth

Використовуйте свій логін та пароль:

curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "username:password" \
  -H "Content-Type: application/json" \
  -d @request.json

Метод 2: Заголовок з API ключем (API Key Header)

Використовуйте заголовок X-Authorization-Key:

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

Метод 3: API ключ як пароль

Використовуйте символ @ як логін і ваш API-ключ як пароль:

curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "@:ваш-api-ключ" \
  -H "Content-Type: application/json" \
  -d @request.json

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

Метод Ендпоінт Опис
POST /bat/messagelist Надіслати повідомлення
GET /bat/message/{messageId} Перевірити статус повідомлення

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

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

  • SMS - Стандартні текстові повідомлення.
  • Viber Promo - Маркетингові повідомлення з медіа (зображення, відео).
  • Viber Transactional - Транзакційні повідомлення для важливих сповіщень.
  • Viber Carousel - Інтерактивна карусель товарів або карток.
  • Viber Survey - Опитування з варіантами відповідей.
  • Viber OTP - Повідомлення з одноразовим паролем або кодом авторизації.
  • RCS - Повідомлення Rich Communication Services (мультимедійні повідомлення у стандартних SMS-додатках).
  • Flash Call - Верифікація через автоматичний короткий телефонний дзвінок (флеш-кол).

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

Каскадні Розсилки (Fallback)

Якщо доставка через основний канал не вдається, SMSBAT може автоматично перенаправити повідомлення через альтернативний канал:

Viber → SMS → Email

Підтримка Медіаформатів (Rich Media)

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

  • Зображеннями (JPG, PNG)
  • Відео (MP4)
  • PDF документами
  • Кнопками та посиланнями-діями

Відстеження Статусу Повідомлень

Відстежуйте стан доставки в режимі реального часу:

  • Відправлено (Sent)
  • Доставлено (Delivered)
  • Прочитано (Read)
  • Помилка (Failed)
  • Протерміновано (Expired)

Вебхуки (Callbacks)

Отримуйте повідомлення від клієнтів у Viber (вхідні колбеки) для двостороннього спілкування.

Швидкий Старт

  1. Відправлення повідомлення - Дізнайтеся, як надіслати своє перше повідомлення.
  2. Перевірка статусу - Відстежуйте статус доставки повідомлень.
  3. Типи Viber повідомлень - Огляньте різні формати Viber-повідомлень.

Формат Запитів

Усі запити до API повинні використовувати формат JSON із наступною структурою:

{
  "messages": [
    {
      "recipient": "+380XXXXXXXXX",
      "type": "viber",
      "text": "Текст вашого повідомлення",
      // ... інші додаткові параметри
    }
  ]
}

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

Успішна відповідь завжди міститиме:

{
  "messages": [
    {
      "messageId": "унікальний-id-повідомлення",
      "recipient": "+380XXXXXXXXX",
      "status": "sent"
    }
  ]
}

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

Коди стану HTTP:

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

Наступні Кроки