TurboSMS API saderība

SMSBAT pilnībā atbalsta saderības slāni ar TurboSMS API. Tas ļauj migrēt esošās integrācijas, kas bija paredzētas TurboSMS, tieši uz SMSBAT, nepārrakstot ziņojumu struktūras vai galapunkta lietderīgās slodzes.

Mēs atbalstām īsziņu un Viber ziņojumu sūtīšanu (tostarp uzlabotas funkcijas, piemēram, karuseļus un aptaujas), statusu iegūšanu un ziņojumu informācijas iegūšanu, izmantojot tieši tādas pašas pieprasījuma pamatteksta struktūras, kuras jūs jau zināt.

Autentifikācija

Vienīgā atšķirība no vietējās TurboSMS API ir autentifikācijas mehānisms. Kamēr TurboSMS izmanto pielāgotu marķiera vaicājuma parametru vai noteiktu autentifikācijas galveni, SMSBAT ir nepieciešams standarta Nesēja pilnvaras.

Jums ir jāiekļauj SMSBAT API pilnvaras galvenē “Autorizācija” visiem pieprasījumiem:

Authorization: Bearer YOUR_SMSBAT_TOKEN

Pamata URL

Visi galapunkti jānovirza uz SMSBAT API bāzes URL:

https://restapi.smsbat.com

---

Nosūtiet vienu ziņojumu

Beigu punkts: POST /api/tsms/message/send

Ļauj sūtīt SMS un Viber ziņas ar hibrīdpiegādes atbalstu (Viber ar SMS rezerves). Tas apstrādā vienu nosūtīšanas pieprasījumu un atgriež piegādes rezultātus katram adresātam.

Galvenās iespējas

• Elastīgie parametri: Globālos parametrus var ignorēt ar īpašiem SMS/Viber parametriem.
• Saturs: atbalsta Viber karuseļus, aptaujas, failu pielikumus un interaktīvās pogas. - ** Kļūdu apstrāde:** atgriež HTTP 200 pat kļūdu gadījumā (strukturētas kļūdu atbildes). “Response_code: 999” ar statusu “FATAL_ERROR” sistēmas kļūdām.
• Adresātu kļūdas: konkrētas adresātu kļūdas tiek atgrieztas masīvā “response_result”. Neveiksmīgiem adresātiem ir “message_id: null” un noteikti kļūdu kodi.

Pieprasījuma piemērs (hibrīda ziņojums)

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

Pieprasījuma piemērs (Viber karuselis)

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

Pieprasījuma piemērs (Viber aptauja)

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

---

Vairāku ziņojumu sūtīšana (grupa)

Beigu punkts: `POST /api/tsms/message/sendmulti

Šī metode ļauj nosūtīt vairākus “sūtīšanas” pieprasījumus vienā HTTP pieprasījumā, ietaupot savienojuma izmaksas. Sendmulti izsaukšana ar datiem 100 pieprasījumiem būs ātrāka nekā 100 atsevišķu sūtīšanas pieprasījumu izpilde.

Pieprasījuma piemērs

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

Atbildes piemērs

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

---

Saņemt ziņojuma statusu

Beigu punkts: POST /api/tsms/message/status

Izgūstiet nosūtīto ziņojumu piegādes statusus, norādot to “message_id”.

Pieprasījuma piemērs

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

---

Saņemiet ziņas informāciju

Beigu punkts: POST /api/tsms/message/details

Ļauj izgūt detalizētu informāciju par izveidotajām ziņām, tostarp pilnu informāciju par SMS un Viber kanāliem, cenām un precīzus laika zīmogus.

Pieprasījuma piemērs

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

Atbildes piemērs

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