Help Center Združljivost API-ja TurboSMS

Združljivost API-ja TurboSMS

SMSBAT v celoti podpira plast združljivosti z TurboSMS API. To vam omogoča, da svoje obstoječe integracije, ki so bile zasnovane za TurboSMS, preselite neposredno v SMSBAT, ne da bi morali prepisati strukture sporočil ali obremenitve končne točke.

Podpiramo pošiljanje sporočil SMS in Viber (vključno z naprednimi funkcijami, kot so vrtiljaki in ankete), pridobivanje statusov in pridobivanje podrobnosti sporočila z uporabo natanko enakih struktur telesa zahteve, ki jih že poznate.

Preverjanje pristnosti

Edina razlika od domačega API-ja TurboSMS je mehanizem za preverjanje pristnosti. Medtem ko TurboSMS uporablja parameter poizvedbe token po meri ali posebno glavo za preverjanje avtorizacije, SMSBAT zahteva standardni Bearer Token.

Svoj žeton API SMSBAT morate vključiti v glavo Authorization za vse zahteve:

Authorization: Bearer YOUR_SMSBAT_TOKEN

Osnovni URL

Vse končne točke morajo biti usmerjene na osnovni URL SMSBAT API:

https://restapi.smsbat.com

Pošlji eno sporočilo

Končna točka: POST /api/tsms/message/send

Omogoča pošiljanje SMS in Viber sporočil s podporo za hibridno dostavo (Viber z nadomestnim SMS-om). Obdela eno samo zahtevo za pošiljanje in vrne rezultate dostave za vsakega prejemnika.

Ključne zmogljivosti

  • Prilagodljivi parametri: Globalne parametre je mogoče preglasiti s posebnimi parametri SMS/Viber.
  • Vsebina: podpira Viber vrtiljake, ankete, datotečne priloge in interaktivne gumbe.
  • Obravnava napak: vrne HTTP 200 tudi za napake (strukturirani odgovori na napake). response_code: 999 s statusom FATAL_ERROR za sistemske napake.
  • Napake prejemnika: Določene napake prejemnika so vrnjene v matriki response_result. Neuspeli prejemniki imajo message_id: null in specifične kode napak.

Primer zahteve (hibridno sporočilo)

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

Primer zahteve (Viber anketa)

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

Pošlji več sporočil (paketno)

Končna točka: POST /api/tsms/message/sendmulti

Ta metoda vam omogoča pošiljanje več zahtev pošlji v eni sami zahtevi HTTP, s čimer prihranite stroške povezave. Klicanje sendmulti s podatki za 100 zahtev bo hitrejše kot izvedba 100 posameznih zahtev send.

Primer zahteve

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

Primer odgovora

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

Pridobite status sporočila

Končna točka: POST /api/tsms/message/status

Pridobite statuse dostave poslanih sporočil tako, da podate njihov message_id.

Primer zahteve

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

Pridobite podrobnosti sporočila

Končna točka: POST /api/tsms/message/details

Omogoča pridobitev podrobnih informacij o ustvarjenih sporočilih, vključno s podrobnostmi o celotnem tovoru za kanale SMS in Viber, cenami in točnimi časovnimi žigi.

Primer zahteve

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

Primer odgovora

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