Help Center TurboSMS API-kompatibilitet

TurboSMS API-kompatibilitet

SMSBAT understøtter fuldt ud et kompatibilitetslag med TurboSMS API. Dette giver dig mulighed for at migrere dine eksisterende integrationer, der er designet til TurboSMS, direkte til SMSBAT uden at skulle omskrive meddelelsesstrukturerne eller slutpunktsnyttelasterne.

Vi understøtter afsendelse af SMS- og Viber-beskeder (inklusive avancerede funktioner som karruseller og undersøgelser), hentning af statusser og hentning af beskeddetaljer ved hjælp af nøjagtig samme anmodningsstruktur, som du allerede er bekendt med.

Godkendelse

Den eneste forskel fra den oprindelige TurboSMS API er godkendelsesmekanismen. Mens TurboSMS bruger en brugerdefineret “token”-forespørgselsparameter eller en specifik godkendelsesheader, kræver SMSBAT et standard Bearer Token.

Du skal inkludere dit SMSBAT API-token i “Autorisation”-headeren for alle anmodninger:

Authorization: Bearer YOUR_SMSBAT_TOKEN

Basis-URL

Alle endepunkter skal dirigeres til SMSBAT API-base-URL’en:

https://restapi.smsbat.com

Send enkelt besked

Slutpunkt: POST /api/tsms/message/send

Tillader afsendelse af SMS- og Viber-beskeder med understøttelse af hybridlevering (Viber med SMS-faldback). Den behandler en enkelt sendeanmodning og returnerer leveringsresultaterne for hver modtager.

Nøglefunktioner

  • Fleksible parametre: Globale parametre kan tilsidesættes af specifikke SMS/Viber-parametre.
  • Indhold: Understøtter Viber-karruseller, undersøgelser, vedhæftede filer og interaktive knapper.
  • Fejlhåndtering: Returnerer HTTP 200 selv for fejl (strukturerede fejlsvar). response_code: 999 med status FATAL_ERROR for systemfejl.
  • Recipient Errors: Specifikke modtagerfejl returneres i ‘response_result’-arrayet. Mislykkede modtagere har “message_id: null” og specifikke fejlkoder.

Eksempel på anmodning (hybrid meddelelse)

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

Eksempel på anmodning (Viber-karrusel)

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

Eksempel på anmodning (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"
    ]
  }
}

Send flere meddelelser (batch)

Slutpunkt: POST /api/tsms/message/sendmulti

Denne metode giver dig mulighed for at sende flere “send”-anmodninger i en enkelt HTTP-anmodning, hvilket sparer forbindelsesomkostninger. At kalde ‘sendmulti’ med data for 100 anmodninger vil være hurtigere end at udføre 100 individuelle ‘send’-anmodninger.

Eksempel på anmodning

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

Svareksempel

{
    "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å beskedstatus

Slutpunkt: POST /api/tsms/message/status

Hent leveringsstatusserne for sendte meddelelser ved at angive deres “meddelelses-id”.

Eksempel på anmodning

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

Få beskeddetaljer

Endpunkt: POST /api/tsms/message/details

Giver dig mulighed for at hente detaljerede oplysninger om oprettede beskeder, inklusive fulde nyttelastdetaljer for SMS- og Viber-kanaler, priser og nøjagtige tidsstempler.

Eksempel på anmodning

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

Svareksempel

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