Help Center Kompatibilita TurboSMS API

Kompatibilita TurboSMS API

SMSBAT plne podporuje vrstvu kompatibility s TurboSMS API. To vám umožňuje migrovať vaše existujúce integrácie, ktoré boli navrhnuté pre TurboSMS, priamo do SMSBAT bez toho, aby ste museli prepisovať štruktúry správ alebo užitočné zaťaženia koncových bodov.

Podporujeme odosielanie správ SMS a správ Viber (vrátane pokročilých funkcií, ako sú kolotoče a prieskumy), načítanie stavov a načítanie podrobností správ pomocou presne rovnakých štruktúr tela žiadostí, ktoré už poznáte.

Autentifikácia

Jediný rozdiel od natívneho API TurboSMS je mechanizmus autentifikácie. Zatiaľ čo TurboSMS používa vlastný parameter dopytu „token“ alebo špecifickú hlavičku overenia, SMSBAT vyžaduje štandardný nosičský token.

Musíte zahrnúť svoj SMSBAT API Token do hlavičky „Autorizácia“ pre všetky požiadavky:

Authorization: Bearer YOUR_SMSBAT_TOKEN

Základná adresa URL

Všetky koncové body by mali smerovať na základnú URL SMSBAT API:

https://restapi.smsbat.com

Odoslať jednu správu

Koncový bod: POST /api/tsms/message/send

Umožňuje odosielanie SMS a Viber správ s podporou hybridného doručovania (Viber s záložným SMS). Spracuje jednu požiadavku na odoslanie a vráti výsledky doručenia pre každého príjemcu.

Kľúčové schopnosti

  • Flexibilné parametre: Globálne parametre môžu byť prepísané špecifickými parametrami SMS/Viber.
  • Obsah: Podporuje karusely Viber, prieskumy, prílohy súborov a interaktívne tlačidlá.
  • Ošetrenie chýb: Vráti HTTP 200 aj pre chyby (štruktúrované chybové odpovede). response_code: 999 so stavom FATAL_ERROR pre systémové chyby.
  • Chyby príjemcov: Špecifické chyby príjemcov sú vrátené v poli response_result. Príjemcovia, ktorí zlyhali, majú atribút id_správy: null a špecifické chybové kódy.

Príklad žiadosti (hybridná správa)

{
  "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"
      }
    ]
  }
}

Príklad žiadosti (prieskum 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"
    ]
  }
}

Odoslať viacero správ (dávka)

Koncový bod: POST /api/tsms/message/sendmulti

Táto metóda vám umožňuje odoslať viacero požiadaviek „odoslať“ v jednej požiadavke HTTP, čím sa šetrí réžia pripojenia. Volanie sendmulti s údajmi pre 100 požiadaviek bude rýchlejšie ako vykonanie 100 jednotlivých požiadaviek send.

Príklad žiadosti

{
  "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
    }
  }
}

Príklad odpovede

{
    "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": { ... }
    }
}

Získajte stav správy

Koncový bod: POST /api/tsms/message/status

Získajte stavy doručenia odoslaných správ zadaním ich ‘id_správy`.

Príklad žiadosti

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

Získajte podrobnosti o správe

Koncový bod: POST /api/tsms/message/details

Umožňuje vám získať podrobné informácie o vytvorených správach vrátane podrobností o úplnom zaťažení kanálov SMS a Viber, cenách a presných časových pečiatkach.

Príklad žiadosti

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

Príklad odpovede

{
    "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"
        }
    ]
}