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

Додаткові приклади запитів та відповідей

1. Надсилання повідомлення

{
  "messages": [
    {
      "from": "ALPHANAME",
      "to": "380936670003",
      "type": "viber_promo",
      "text": "Тестове повідомлення",
      "ttl": "300",
      "messageData": {
        "img": "https://cdn-web.smsbat.com/help/carusel.png",
        "buttonText": "Дізнатись більше",
        "buttonAction": "https://help.smsbat.com"
      }
    }
  ]
}

2. Перевірка статусу

curl -X GET https://api.smsbat.com.ua/bat/message/12345 --user user:password

{
  "messagelistId": 11229,
  "messageId": 1366203,
  "deliverystatus": "delivered",
  "partscount": 1,
  "cost": 0.32
}

3. Параметри відповіді

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

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

4. Коди статусу HTTP

Код Опис
200 Запит успішний
400 Некоректний формат запиту
401 Помилка авторизації
429 Перевищено ліміт запитів
500 Помилка на стороні сервера

5. Типи повідомлень та їх приклади

Viber Promo

{
  "messages": [
    {
      "from": "ALPHANAME",
      "to": "380936670003",
      "type": "viber_promo",
      "text": "Привіт!",
      "messageData": {
        "img": "https://cdn-web.smsbat.com/help/carusel.png",
        "buttonText": "Переглянути",
        "buttonAction": "https://help.smsbat.com"
      }
    }
  ]
}

Viber Transactional

{
  "messages": [
    {
      "from": "ALPHANAME",
      "to": "380936670003",
      "type": "viber_trans",
      "text": "Замовлення №111 вже чекає на тебе в магазині",
      "ttl": "300"
    }
  ]
}

{
  "messages": [
    {
      "from": "ALPHANAME",
      "to": "380936670003",
      "type": "viber_promo",
      "text": "Текст для Viber",
      "ttl": 300,
      "messageData": {
        "carousel": {
          "items": [
            {
              "title": "50% Off on All Shoes!",
              "imageUrl": "https://cdn-web.smsbat.com/help/carusel.png",
              "primaryButton": {
                "label": "Shop Now",
                "actionUrl": "https://help.noetikos.org"
              },
              "secondaryButton": {
                "label": "View Details",
                "actionUrl": "https://omni.noetikos.org"
              }
            }
          ]
        }
      }
    }
  ]
}

Viber Survey

{
  "messages": [
    {
      "from": "ALPHANAME",
      "to": "380936670003",
      "type": "viber_survey",
      "text": "Тестове повідомлення",
      "ttl": 30,
      "messageData": {
        "survey": {
          "options": [
            "option1 text",
            "option2 text",
            "option3 text",
            "option4 text",
            "option5 text"
          ]
        }
      }
    }
  ]
}

Viber OTP

{
  "messages": [
    {
      "from": "ALPHANAME",
      "to": "380936670003",
      "type": "viber_otp",
      "text": "",
      "ttl": "90",
      "messageData": {
        "templateId": "6c929cef-29b4-4349-bc9d-2a07bdbb6e43",
        "templateLang": "uk",
        "templateParams": {
          "pin": 321,
          "business_platform_name": "SMSBAT",
          "code_validity_time": 7
        }
      }
    }
  ]
}

Flash Call

{
  "messages": [
    {
      "from": "FLASHCALL",
      "to": "380500000000",
      "text": "340",
      "type": "flashcall"
    }
  ]
}

6. Fallback

При надсиланні повідомлення з fallback ви можете вказати масив fallback‑запитів, який буде виконаний у разі неуспіху основного каналу.

{
  "messages": [
    {
      "from": "ALPHANAME",
      "to": "380936670003",
      "type": "viber_promo",
      "text": "Text for Viber",
      "ttl": "300",
      "messageData": {
        "img": "https://cdn-web.smsbat.com/help/carusel.png",
        "buttonText": "Button text",
        "buttonAction": "https://help.smsbat.com"
      },
      "fallbacks": [
        {
          "from": "ALPHANAME",
          "to": "380936670003",
          "type": "sms",
          "text": "Замовлення №111 вже чекає на тебе в магазині",
          "ttl": "5600"
        }
      ]
    }
  ]
}