Помощен център Съвместимост на TurboSMS API

Съвместимост на TurboSMS API

SMSBAT поддържа напълно слой за съвместимост с TurboSMS API. Това ви позволява да мигрирате вашите съществуващи интеграции, които са проектирани за TurboSMS директно към SMSBAT, без да се налага да пренаписвате структурите на съобщенията или полезните натоварвания на крайната точка.

Ние поддържаме изпращане на SMS и Viber съобщения (включително разширени функции като въртележки и анкети), извличане на статуси и извличане на подробности за съобщения, като се използват абсолютно същите структури на тялото на заявката, с които вече сте запознати.

Удостоверяване

Единствената разлика от родния TurboSMS API е механизмът за удостоверяване. Докато TurboSMS използва персонализиран параметър на заявка token или специфична заглавка за удостоверяване, SMSBAT изисква стандартен Bearer Token.

Трябва да включите вашия SMSBAT API Token в заглавката Authorization за всички заявки:

Authorization: Bearer YOUR_SMSBAT_TOKEN

Основен URL адрес

Всички крайни точки трябва да бъдат насочени към основния URL адрес на SMSBAT API:

https://restapi.smsbat.com

Изпратете едно съобщение

Крайна точка: POST /api/tsms/message/send

Позволява изпращане на SMS и Viber съобщения с поддръжка за хибридна доставка (Viber с резервен SMS). Той обработва една заявка за изпращане и връща резултатите от доставката за всеки получател.

Ключови възможности

  • Гъвкави параметри: Глобалните параметри могат да бъдат заменени от специфични SMS/Viber параметри.
  • Съдържание: Поддържа Viber въртележки, анкети, прикачени файлове и интерактивни бутони.
  • Обработка на грешки: Връща HTTP 200 дори за грешки (структурирани отговори за грешки). response_code: 999 със статус FATAL_ERROR за системни грешки.
  • Грешки на получателя: Конкретни грешки на получателя се връщат в масива response_result. Неуспешните получатели имат message_id: null и специфични кодове за грешка.

Пример за заявка (хибридно съобщение)

{
  "sender": "GlobalSender",
  "text": "Test message",
  "recipients": ["380951111111", "380952222222"],
  "start_time": "2025-09-29T10:00:00Z",
  "sequence_id": "seq_12345",
  "sms": {
    "sender": "SMSSender",
    "text": "SMS version of message",
    "is_flash": false
  },
  "viber": {
    "sender": "ViberSender",
    "text": "Viber version of message",
    "ttl": 3600,
    "image_url": "https://example.com/image.png",
    "caption": "Button text",
    "action": "https://google.com",
    "count_clicks": true,
    "is_transactional": false
  }
}

{
  "sender": "GlobalSender",
  "text": "Check out our products",
  "recipients": ["380951111111"],
  "viber": {
    "sender": "ViberSender",
    "text": "Check out our products",
    "is_transactional": false,
    "carousel": [
      {
        "title": "Product 1",
        "image_url": "https://example.com/product1.jpg",
        "button_caption": "Buy Now",
        "button_url": "https://example.com/buy/product1",
        "link_caption": "Learn More",
        "link_url": "https://example.com/product1"
      },
      {
        "title": "Product 2",
        "image_url": "https://example.com/product2.jpg",
        "button_caption": "Buy Now",
        "button_url": "https://example.com/buy/product2",
        "link_caption": "Learn More",
        "link_url": "https://example.com/product2"
      }
    ]
  }
}

Пример за заявка (Проучване във Viber)

{
  "sender": "GlobalSender",
  "text": "Please rate our service",
  "recipients": ["380951111111"],
  "viber": {
    "sender": "ViberSender",
    "text": "Please rate our service",
    "is_transactional": true,
    "survey": [
      "Excellent",
      "Good",
      "Average",
      "Poor"
    ]
  }
}

Изпращане на множество съобщения (група)

Крайна точка: POST /api/tsms/message/sendmulti

Този метод ви позволява да изпращате множество send заявки в една HTTP заявка, спестявайки излишни разходи за връзка. Извикването на sendmulti с данни за 100 заявки ще бъде по-бързо от изпълнението на 100 отделни send заявки.

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

{
  "batch_1": {
    "sender": "GlobalSender",
    "text": "Test message",
    "recipients": ["380982462128", "380501111111"],    
    "sms": {
        "sender": "SMSSender",
        "text": "SMS version of message"
    }
  },
  "batch_2": {
    "sender": "GlobalSender",
    "text": "Second message",
    "recipients": ["380501111111"],
    "viber": {
      "sender": "ViberSender",
      "text": "Viber message",
      "is_transactional": true
    }
  }
}

Пример за отговор

{
    "response_code": 0,
    "response_status": "OK",
    "response_result": {
        "batch_1": {
            "response_code": 800,
            "response_status": "SUCCESS_MESSAGE_ACCEPTED",
            "response_result": [
                {
                    "phone": "380982462128",
                    "response_code": 0,
                    "message_id": "f1640579-ea75-4bc1-b708-1c3858bf222d",
                    "response_status": "OK"
                }
            ]
        },
        "batch_2": { ... }
    }
}

Получете статус на съобщението

Крайна точка: POST /api/tsms/message/status

Изтеглете статусите на доставка на изпратените съобщения, като предоставите техните message_id.

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

{
  "messages": [
      "573dcb46-7851-4e16-bb1f-721c13ef5f38", 
      "6b7f9ff5-28c8-4f38-913b-31af6021fbea"
  ]
}

Вземете подробности за съобщението

Крайна точка: POST /api/tsms/message/details

Позволява ви да извличате подробна информация за създадените съобщения, включително пълни подробности за полезния товар за SMS и Viber канали, ценообразуване и точни времеви отпечатъци.

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

{
  "messages": [
      "573dcb46-7851-4e16-bb1f-721c13ef5f38", 
      "f1640579-ea75-4bc1-b708-1c3858bf222d"
  ]
}

Пример за отговор

{
    "response_code": 0,
    "response_status": "OK",
    "response_result": [
        {
            "message_id": "573dcb46-7851-4e16-bb1f-721c13ef5f38",
            "sms": null,
            "viber": {
                "added": "2025-09-29T14:17:02.577Z",
                "start": "2025-09-29T10:00:00Z",
                "sent": "2025-09-29T14:17:02.577Z",
                "updated": "2025-09-29T14:17:02.577Z",
                "sender": "ViberSender",
                "text": "Viber version of message",
                "recipient": "380982462128",
                "message_type": "promotional",
                "status": "Queued",
                "price": 0,
                "ttl": 3600,
                "caption": "Button text",
                "action": "https://google.com"
            },
            "response_code": 0,
            "response_status": "OK"
        }
    ]
}