TurboSMS API ühilduvus

SMSBAT toetab täielikult ühilduvuskihti TurboSMS API-ga. See võimaldab teil migreerida olemasolevad TurboSMS-i jaoks loodud integratsioonid otse SMSBAT-i, ilma et peaksite sõnumistruktuure või lõpp-punkti kasulikke koormusi ümber kirjutama.

Toetame SMS- ja Viber-sõnumite saatmist (sh täiustatud funktsioonid, nagu karussellid ja küsitlused), olekute ja sõnumite üksikasjade toomist, kasutades täpselt samu päringu kehastruktuure, mida te juba tunnete.

Autentimine

Ainus erinevus natiivsest TurboSMS API-st on autentimismehhanism. Kui TurboSMS kasutab kohandatud päringu parameetrit “token” või konkreetset autentimispäist, siis SMSBAT nõuab standardset kandjaluba.

Peate lisama oma SMSBAT API märgi kõigi taotluste päisesse “Authorization”.

Authorization: Bearer YOUR_SMSBAT_TOKEN

Baas-URL

Kõik lõpp-punktid tuleks suunata SMSBAT API baas-URL-ile:

https://restapi.smsbat.com

---

Saada üks sõnum

Lõpp-punkt: POST /api/tsms/message/send

Võimaldab saata SMS- ja Viber-sõnumeid hübriidedastuse toega (Viber koos SMS-i varuga). See töötleb ühe saatmispäringu ja tagastab iga adressaadi kohaletoimetamistulemused.

Peamised võimalused

• Paindlikud parameetrid: globaalseid parameetreid saab alistada konkreetsete SMS-i/Viberi parameetritega.
• Sisu: toetab Viberi karusselle, küsitlusi, failimanuseid ja interaktiivseid nuppe.
• Error Handling: tagastab HTTP 200 isegi vigade korral (struktureeritud veavastused). “Response_code: 999” olekuga “FATAL_ERROR” süsteemivigade jaoks.
• Saaja vead: konkreetsed adressaatide vead tagastatakse massiivis „Response_result”. Ebaõnnestunud adressaatidel on „message_id: null” ja konkreetsed veakoodid.

Taotluse näide (hübriidsõnum)

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

Taotluse näide (Viberi karussell)

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

Taotluse näide (Viberi uuring)

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

---

Saada mitu sõnumit (paki)

Lõpp-punkt: “POST /api/tsms/message/sendmulti”

See meetod võimaldab teil saata mitu saatmispäringut ühe HTTP-päringuga, säästes ühenduse kulusid. Funktsiooni “sendmulti” kutsumine 100 päringu andmetega on kiirem kui 100 individuaalse “saada” päringu täitmine.

Taotluse näide

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

Vastuse näide

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

---

Hangi sõnumi olek

Lõpp-punkt: “POST /api/tsms/message/status”.

Saate hankida saadetud kirjade kohaletoimetamise olekud, sisestades nende sõnumi_id.

Taotluse näide

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

---

Hankige sõnumi üksikasjad

Lõpp-punkt: POST /api/tsms/message/details

Võimaldab hankida üksikasjalikku teavet loodud sõnumite kohta, sealhulgas SMS-i ja Viberi kanalite täielikud kasulikud andmed, hinnad ja täpsed ajatemplid.

Taotluse näide

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

Vastuse näide

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