TurboSMS API -yhteensopivuus

SMSBAT tukee täysin yhteensopivuuskerrosta TurboSMS API

kanssa. Tämän avulla voit siirtää olemassa olevat TurboSMS varten suunnitellut integraatiot suoraan SMSBAT ilman, että sinun tarvitsee kirjoittaa uudelleen viestirakenteita tai päätepisteiden hyötykuormia.

Tuemme tekstiviesti- ja Viber-viestien lähettämistä (mukaan lukien lisäominaisuudet, kuten karusellit ja kyselyt), tilojen ja viestien tietojen hakemista käyttämällä täsmälleen samoja pyyntörunkorakenteita, jotka jo tunnet.

Todennus

Ainoa ero alkuperäisestä TurboSMS API

on todennusmekanismi. Vaikka TurboSMS käyttää mukautettua token-kyselyparametria tai tiettyä todennusotsikkoa, SMSBAT vaatii tavallisen Kantajatunnisteen.

Sinun on sisällytettävä SMSBAT-sovellusliittymätunnuksesi “Authorization”-otsikkoon kaikissa pyynnöissä:

Authorization: Bearer YOUR_SMSBAT_TOKEN

Perus-URL-osoite

Kaikki päätepisteet tulee ohjata SMSBAT API -perus-URL-osoitteeseen:

https://restapi.smsbat.com

---

Lähetä yksittäinen viesti

Päätepiste: POST /api/tsms/message/send

Mahdollistaa SMS- ja Viber-viestien lähettämisen hybriditoimituksen tuella (Viber tekstiviestillä). Se käsittelee yhden lähetyspyynnön ja palauttaa toimitustulokset jokaiselle vastaanottajalle.

Tärkeimmät ominaisuudet

• Joustavat parametrit: Yleiset parametrit voidaan ohittaa tietyillä SMS/Viber-parametreilla.
• Sisältö: Tukee Viber-karuselleja, kyselyjä, tiedostoliitteitä ja interaktiivisia painikkeita.
• Virheenkäsittely: Palauttaa HTTP 200
  myös virheille (strukturoidut virhevastaukset). “Response_code: 999” tilalla “FATAL_ERROR” järjestelmävirheitä varten.
• Vastaanottajavirheet: Tietyt vastaanottajan virheet palautetaan “response_result” -taulukossa. Epäonnistuneilla vastaanottajilla on “message_id: null” ja tietyt virhekoodit.

Pyyntöesimerkki (hybridiviesti)

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

Pyyntöesimerkki (Viber-karuselli)

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

Pyyntöesimerkki (Viber Survey)

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

---

Lähetä useita viestejä (joukko)

Päätepiste: POST /api/tsms/message/sendmulti

Tämän menetelmän avulla voit lähettää useita “lähetys”-pyyntöjä yhdessä HTTP-pyynnössä, mikä säästää yhteyden ylimääräisiä kustannuksia. Sendmultin kutsuminen 100 pyynnön tiedoilla on nopeampaa kuin 100 yksittäisen lähetyspyynnön suorittaminen.

Pyyntöesimerkki

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

Vastausesimerkki

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

---

Hae viestin tila

Päätepiste: “POST /api/tsms/message/status”.

Hae lähetettyjen viestien toimitustilat antamalla niiden “message_id”.

Pyyntöesimerkki

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

---

Hanki viestin tiedot

Päätepiste: POST /api/tsms/message/details

Voit hakea yksityiskohtaisia tietoja luoduista viesteistä, mukaan lukien tekstiviesti- ja Viber-kanavien täydet hyötykuormatiedot, hinnat ja tarkat aikaleimat.

Pyyntöesimerkki

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

Vastausesimerkki

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