Help Center TurboSMS API-compatibiliteit

TurboSMS API-compatibiliteit

SMSBAT ondersteunt volledig een compatibiliteitslaag met de TurboSMS API. Hierdoor kunt u uw bestaande integraties die zijn ontworpen voor TurboSMS rechtstreeks naar SMSBAT migreren zonder dat u de berichtstructuren of eindpuntpayloads hoeft te herschrijven.

We ondersteunen het verzenden van SMS- en Viber-berichten (inclusief geavanceerde functies zoals carrousels en enquêtes), het ophalen van statussen en het ophalen van berichtdetails met behulp van exact dezelfde verzoektekststructuren waarmee u al bekend bent.

Authenticatie

Het enige verschil met de native TurboSMS API is het authenticatiemechanisme. Terwijl TurboSMS een aangepaste token-queryparameter of een specifieke auth-header gebruikt, vereist SMSBAT een standaard Bearer Token.

U moet uw SMSBAT API-token opnemen in de Authorization-header voor alle verzoeken:

Authorization: Bearer YOUR_SMSBAT_TOKEN

Basis-URL

Alle eindpunten moeten worden doorgestuurd naar de SMSBAT API-basis-URL:

https://restapi.smsbat.com

Eén bericht verzenden

Eindpunt: POST /api/tsms/message/send

Maakt het verzenden van SMS- en Viber-berichten mogelijk met ondersteuning voor hybride bezorging (Viber met SMS-fallback). Het verwerkt één enkel verzendverzoek en retourneert de bezorgresultaten voor elke ontvanger.

Belangrijkste mogelijkheden

  • Flexibele parameters: Globale parameters kunnen worden overschreven door specifieke SMS/Viber-parameters.
  • Inhoud: Ondersteunt Viber-carrousels, enquêtes, bestandsbijlagen en interactieve knoppen.
  • Foutafhandeling: Retourneert HTTP 200, zelfs voor fouten (gestructureerde foutreacties). response_code: 999 met status FATAL_ERROR voor systeemfouten.
  • Ontvangerfouten: Specifieke ontvangerfouten worden geretourneerd in de response_result array. Mislukte ontvangers hebben message_id: null en specifieke foutcodes.

Verzoekvoorbeeld (hybride bericht)

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

Verzoekvoorbeeld (Viber-carrousel)

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

Verzoekvoorbeeld (Viber-enquête)

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

Meerdere berichten verzenden (batch)

Eindpunt: POST /api/tsms/message/sendmulti

Met deze methode kunt u meerdere verzendverzoeken in één enkel HTTP-verzoek verzenden, waardoor verbindingsoverhead wordt bespaard. Het aanroepen van sendmulti met gegevens voor 100 verzoeken zal sneller zijn dan het uitvoeren van 100 individuele send-verzoeken.

Voorbeeld van aanvraag

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

Reactievoorbeeld

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

Berichtstatus ophalen

Eindpunt: POST /api/tsms/message/status

Haal de bezorgingsstatussen van verzonden berichten op door hun ‘message_id’ op te geven.

Voorbeeld van aanvraag

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

Ontvang berichtdetails

Eindpunt: POST /api/tsms/message/details

Hiermee kunt u gedetailleerde informatie over gemaakte berichten ophalen, inclusief volledige payloadgegevens voor SMS- en Viber-kanalen, prijzen en exacte tijdstempels.

Voorbeeld van aanvraag

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

Reactievoorbeeld

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