Help Center TurboSMS API kompatibilitás

TurboSMS API kompatibilitás

Az SMSBAT teljes mértékben támogatja a TurboSMS API kompatibilitási rétegét. Ez lehetővé teszi, hogy a meglévő, TurboSMS-hez tervezett integrációit közvetlenül SMSBAT-ba helyezze át anélkül, hogy át kellene írnia az üzenetstruktúrákat vagy a végpontok hasznos adatait.

Támogatjuk az SMS- és Viber-üzenetek küldését (beleértve a speciális funkciókat, például a körhintákat és a felméréseket), az állapotok lekérését és az üzenetek részleteinek lekérését pontosan ugyanazokkal a kéréstörzs-struktúrákkal, amelyeket Ön már ismer.

Hitelesítés

Az egyetlen különbség a natív TurboSMS API-tól a hitelesítési mechanizmus. Míg a TurboSMS egyéni „token” lekérdezési paramétert vagy meghatározott hitelesítési fejlécet használ, az SMSBAT szabványos vivőjogkivonatot igényel.

Minden kérés esetén fel kell tüntetnie SMSBAT API-tokenjét az “Authorization” fejlécben:

Authorization: Bearer YOUR_SMSBAT_TOKEN

Alap URL

Minden végpontot az SMSBAT API alap URL-jére kell irányítani:

https://restapi.smsbat.com

Egyetlen üzenet küldése

Végpont: POST /api/tsms/message/send

Lehetővé teszi SMS és Viber üzenetek küldését a hibrid kézbesítés támogatásával (Viber SMS tartalékkal). Egyetlen küldési kérelmet dolgoz fel, és minden címzettnél visszaküldi a kézbesítési eredményeket.

Főbb képességek

  • Rugalmas paraméterek: A globális paraméterek felülbírálhatók meghatározott SMS/Viber paraméterekkel.
  • Tartalom: Támogatja a Viber-körhintákat, felméréseket, fájlmellékleteket és interaktív gombokat.
  • Hibakezelés: Hiba esetén is HTTP 200-at ad vissza (strukturált hibaválaszok). response_code: 999 FATAL_ERROR állapottal rendszerhibák esetén.
  • Címzett hibák: Az adott címzett hibákat a response_result tömb adja vissza. A sikertelen címzetteknél “message_id: null” és meghatározott hibakódok vannak.

Példa kérésre (hibrid üzenet)

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

Példa kérésre (Viber felmérés)

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

Több üzenet küldése (kötegelt)

Végpont: `POST /api/tsms/message/sendmulti

Ez a módszer lehetővé teszi több “küldési” kérés küldését egyetlen HTTP-kérésben, megtakarítva ezzel a csatlakozási többletköltséget. A “sendmulti” hívása 100 kérés adataival gyorsabb lesz, mint 100 egyéni “send” kérés végrehajtása.

Példa kérésre

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

Válasz példa

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

Üzenetállapot lekérése

Végpont: POST /api/tsms/message/status

Lekérheti az elküldött üzenetek kézbesítési állapotát az “üzenetazonosító” megadásával.

Példa kérésre

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

Üzenet részleteinek lekérése

Végpont: POST /api/tsms/message/details

Lehetővé teszi, hogy részletes információkat kérjen le a létrehozott üzenetekről, beleértve az SMS- és Viber-csatornák teljes hasznos adatait, az árakat és a pontos időbélyegeket.

Példa kérésre

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

Válasz példa

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