TurboSMS API suderinamumas

SMSBAT visiškai palaiko suderinamumo sluoksnį su TurboSMS API. Tai leidžia perkelti esamas integracijas, kurios buvo skirtos TurboSMS, tiesiai į SMSBAT, neperrašant pranešimų struktūrų ar galinių taškų naudingųjų apkrovų.

Palaikome SMS ir Viber pranešimų siuntimą (įskaitant išplėstines funkcijas, pvz., karuseles ir apklausas), būsenų gavimą ir išsamios pranešimo informacijos gavimą naudojant lygiai tokias pačias užklausos struktūras, su kuriomis jau žinote.

Autentifikavimas

Vienintelis skirtumas nuo vietinės TurboSMS API yra autentifikavimo mechanizmas. Nors TurboSMS naudoja tinkintą „žetono“ užklausos parametrą arba konkrečią autentifikavimo antraštę, SMSBAT reikalingas standartinis Nešiklio prieigos raktas.

Turite įtraukti savo SMSBAT API prieigos raktą į visų užklausų antraštę „Authorization“:

Authorization: Bearer YOUR_SMSBAT_TOKEN

Bazinis URL

Visi galutiniai taškai turėtų būti nukreipti į SMSBAT API bazinį URL:

https://restapi.smsbat.com

---

Siųsti vieną žinutę

Pabaigos taškas: „POST /api/tsms/message/send“.

Leidžia siųsti SMS ir Viber žinutes su hibridinio pristatymo palaikymu (Viber su SMS atsarginiu). Jis apdoroja vieną siuntimo užklausą ir grąžina kiekvieno gavėjo pristatymo rezultatus.

Pagrindinės galimybės

• Lankstūs parametrai: Visuotiniai parametrai gali būti nepaisyti tam tikrais SMS / Viber parametrais. – Turinys: palaiko „Viber“ karuseles, apklausas, failų priedus ir interaktyvius mygtukus. – Klaidų tvarkymas: net ir klaidų atveju (struktūrinių klaidų atsakymai) pateikia HTTP 200. „Response_code: 999“ su būsena „FATAL_ERROR“ sistemos klaidoms. – Gavėjo klaidos: konkrečios gavėjo klaidos pateikiamos masyve „response_result“. Nepavykę gauti gavėjai turi „message_id: null“ ir konkrečius klaidų kodus.

Užklausos pavyzdys (hibridinis pranešimas)

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

Užklausos pavyzdys („Viber Carousel“)

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

Užklausos pavyzdys („Viber“ apklausa)

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

---

Siųsti kelis pranešimus (paketas)

Pabaigos taškas: „POST /api/tsms/message/sendmulti“

Šis metodas leidžia siųsti kelias siuntimo užklausas vienoje HTTP užklausoje, taupant ryšio išlaidas. „Sendmulti“ iškvietimas su 100 užklausų duomenimis bus greitesnis nei 100 individualių „siųsti“ užklausų vykdymas.

Užklausos pavyzdys

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

Atsakymo pavyzdys

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

---

Gaukite pranešimo būseną

Pabaigos taškas: „POST /api/tsms/message/status“.

Nuskaitykite išsiųstų pranešimų pristatymo būsenas, nurodydami jų „message_id“.

Užklausos pavyzdys

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

---

Gaukite išsamią pranešimo informaciją

Pabaigos taškas: „POST /api/tsms/message/details“.

Leidžia gauti išsamią informaciją apie sukurtus pranešimus, įskaitant visą informaciją apie SMS ir Viber kanalus, kainas ir tikslias laiko žymas.

Užklausos pavyzdys

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

Atsakymo pavyzdys

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