Help Center TurboSMS API-kompatibilitet

TurboSMS API-kompatibilitet

SMSBAT stöder fullt ut ett kompatibilitetslager med TurboSMS API. Detta gör att du kan migrera dina befintliga integrationer som designades för TurboSMS direkt till SMSBAT utan att behöva skriva om meddelandestrukturer eller slutpunktsnyttolaster.

Vi stöder att skicka SMS och Viber-meddelanden (inklusive avancerade funktioner som karuseller och undersökningar), hämtning av statusar och hämtning av meddelandedetaljer med exakt samma förfrågningskroppsstrukturer som du redan är bekant med.

Autentisering

Den enda skillnaden från det inbyggda TurboSMS API är autentiseringsmekanismen. Medan TurboSMS använder en anpassad “token”-frågeparameter eller en specifik autentiseringshuvud, kräver SMSBAT en standard Bearer Token.

Du måste inkludera din SMSBAT API-token i “Authorization”-huvudet för alla förfrågningar:

Authorization: Bearer YOUR_SMSBAT_TOKEN

Bas-URL

Alla slutpunkter ska dirigeras till SMSBAT API:s bas-URL:

https://restapi.smsbat.com

Skicka enstaka meddelande

Slutpunkt: POST /api/tsms/meddelande/send

Tillåter att skicka SMS och Viber-meddelanden med stöd för hybridleverans (Viber med SMS-fallback). Den behandlar en enda sändningsförfrågan och returnerar leveransresultaten för varje mottagare.

Nyckelfunktioner

  • Flexibla parametrar: Globala parametrar kan åsidosättas av specifika SMS/Viber-parametrar.
  • Innehåll: Stöder Viber-karuseller, undersökningar, filbilagor och interaktiva knappar.
  • Felhantering: Returnerar HTTP 200 även för fel (strukturerade felsvar). response_code: 999 med status FATAL_ERROR för systemfel.
  • Recipient Errors: Specifika mottagarfel returneras i arrayen response_result. Misslyckade mottagare har “meddelande-id: null” och specifika felkoder.

Exempel på begäran (hybridmeddelande)

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

Exempel på begäran (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"
    ]
  }
}

Skicka flera meddelanden (batch)

Slutpunkt: POST /api/tsms/message/sendmulti

Denna metod låter dig skicka flera “sänd”-förfrågningar i en enda HTTP-förfrågan, vilket sparar anslutningskostnader. Att anropa “sendmulti” med data för 100 förfrågningar kommer att gå snabbare än att utföra 100 individuella “sänd”-förfrågningar.

Exempel på begäran

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

Svarsexempel

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

Få meddelandestatus

Slutpunkt: POST /api/tsms/meddelande/status

Hämta leveransstatus för skickade meddelanden genom att ange deras “meddelande-id”.

Exempel på begäran

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

Få meddelandedetaljer

Slutpunkt: POST /api/tsms/meddelande/detaljer

Låter dig hämta detaljerad information om skapade meddelanden, inklusive fullständig information om nyttolast för SMS- och Viber-kanaler, prissättning och exakta tidsstämplar.

Exempel på begäran

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

Svarsexempel

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