Help Center Kompatibilita TurboSMS API

Kompatibilita TurboSMS API

SMSBAT plně podporuje vrstvu kompatibility s TurboSMS API. To vám umožní migrovat vaše stávající integrace, které byly navrženy pro TurboSMS, přímo do SMSBAT, aniž byste museli přepisovat struktury zpráv nebo užitečné zatížení koncových bodů.

Podporujeme odesílání zpráv SMS a Viber (včetně pokročilých funkcí, jako jsou karusely a průzkumy), načítání stavů a ​​načítání podrobností zpráv pomocí přesně stejných struktur těla požadavku, které již znáte.

Autentizace

Jediný rozdíl od nativního TurboSMS API je mechanismus ověřování. Zatímco TurboSMS používá vlastní parametr dotazu „token“ nebo specifickou auth hlavičku, SMSBAT vyžaduje standardní nosičský token.

U všech požadavků musíte do záhlaví „Authorization“ zahrnout váš SMSBAT API Token:

Authorization: Bearer YOUR_SMSBAT_TOKEN

Základní URL

Všechny koncové body by měly být směrovány na základní URL SMSBAT API:

https://restapi.smsbat.com

Odeslat jednu zprávu

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

Umožňuje odesílání SMS a Viber zpráv s podporou hybridního doručování (Viber se záložním SMS). Zpracuje jeden požadavek na odeslání a vrátí výsledky doručení pro každého příjemce.

Klíčové schopnosti

  • Flexibilní parametry: Globální parametry mohou být přepsány specifickými parametry SMS/Viber.
  • Obsah: Podporuje karusely Viber, průzkumy, přílohy souborů a interaktivní tlačítka.
  • Zpracování chyb: Vrací HTTP 200 i pro chyby (strukturované chybové odpovědi). response_code: 999 se stavem FATAL_ERROR pro systémové chyby.
  • Chyby příjemců: Konkrétní chyby příjemců jsou vráceny v poli response_result. Neúspěšní příjemci mají id_zprávy: null a specifické chybové kódy.

Příklad požadavku (hybridní zprá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"
      }
    ]
  }
}

Příklad požadavku (průzkum 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"
    ]
  }
}

Odeslat více zpráv (dávka)

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

Tato metoda vám umožňuje odeslat více požadavků „odeslat“ v jediném požadavku HTTP, což šetří režii připojení. Volání sendmulti s daty pro 100 požadavků bude rychlejší než provádění 100 jednotlivých požadavků send.

Příklad požadavku

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

Příklad odpovědi

{
    "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ískat stav zprávy

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

Načtěte stavy doručení odeslaných zpráv zadáním jejich ‘id_zprávy`.

Příklad požadavku

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

Získejte podrobnosti o zprávě

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

Umožňuje získat podrobné informace o vytvořených zprávách, včetně úplných podrobností o užitečné zátěži pro kanály SMS a Viber, cenách a přesných časových razítkách.

Příklad požadavku

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

Příklad odpovědi

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