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

SMSBAT API

SMSBAT е RESTful API платформа за изпращане на различни видове съобщения, включително Viber карусел (carousel), Viber диалог (opinion dialog), Viber промо съобщения (снимки, видео), Viber бизнес чат, OTP известия (Viber OTP, Flash Call) и техни резервни (fallback) варианти.

Основен URL (Base URL)

Заявките към SMSBAT API се предават към крайна точка (endpoint) с локализация. Поискайте предварително адреса от вашия мениджър.

Пример: 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 Key Header

Използвайте заглавката (header) X-Authorization-Key:

curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -H "X-Authorization-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d @request.json

Метод 3: API Key като Парола

Използвайте @ като потребителско име и вашия API ключ като парола:

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

Достъпни крайни точки (Endpoints)

Метод Крайна точка (Endpoint) Описание
POST /bat/messagelist Изпращане на съобщения
GET /bat/message/{messageId} Проверка на статуса на съобщението

Типове съобщения

SMSBAT API поддържа следните типове съобщения:

  • SMS - Стандартни текстови съобщения
  • Viber Promo - Промоционални съобщения с богато мултимедийно съдържание
  • Viber Transactional - Транзакционни известия
  • Viber Carousel - Интерактивни съобщения тип карусел (carousel)
  • Viber Survey - Съобщения за диалог и мнения (Opinion dialog)
  • Viber OTP - Известия за еднократна парола (OTP)
  • RCS - Rich Communication Services съобщения
  • Flash Call - Потвърждение чрез тихо обаждане (Silent call)

Основни характеристики

Резервни съобщения (Fallback)

Когато първичната доставка се провали, SMSBAT автоматично пренасочва (fallback) към алтернативни канали:

Viber → SMS → Email

Поддръжка на богато съдържание (Rich Media)

Изпращайте съобщения с:

  • Изображения (JPG, PNG)
  • Видеоклипове (MP4)
  • PDF файлове
  • Бутони и връзки за действие

Проследяване на статуса на съобщенията

Проследявайте статуса на доставка в реално време:

  • Изпратено (Sent)
  • Доставено (Delivered)
  • Прочетено (Read)
  • Неуспешно (Failed)
  • Изтекло (Expired)

Callbacks (Обратни извиквания)

Получавайте обратни извиквания за входящи Viber съобщения за двустранна комуникация.

Бърз старт

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

Формат на заявката (Request Format)

Всички заявки използват JSON формат със следната структура:

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

Формат на отговора (Response Format)

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

{
  "messages": [
    {
      "messageId": "unique-message-id",
      "recipient": "+380XXXXXXXXX",
      "status": "sent"
    }
  ]
}

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

HTTP кодове за статус:

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

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