TurboSMS API-Kompatibilität

SMSBAT unterstützt vollständig eine Kompatibilitätsebene mit der TurboSMS API. Dadurch können Sie Ihre vorhandenen Integrationen, die für TurboSMS entwickelt wurden, direkt zu SMSBAT migrieren, ohne die Nachrichtenstrukturen oder Endpunktnutzlasten neu schreiben zu müssen.

Wir unterstützen das Senden von SMS- und Viber-Nachrichten (einschließlich erweiterter Funktionen wie Karussells und Umfragen), das Abrufen von Status und das Abrufen von Nachrichtendetails mithilfe genau derselben Anforderungstextstrukturen, mit denen Sie bereits vertraut sind.

Authentifizierung

Der einzige Unterschied zur nativen TurboSMS-API ist der Authentifizierungsmechanismus. Während TurboSMS einen benutzerdefinierten „Token“-Abfrageparameter oder einen bestimmten Authentifizierungsheader verwendet, erfordert SMSBAT ein standardmäßiges Bearer-Token.

Sie müssen Ihr SMSBAT-API-Token in den „Authorization“-Header für alle Anfragen einfügen:

Authorization: Bearer YOUR_SMSBAT_TOKEN

Basis-URL

Alle Endpunkte sollten an die SMSBAT-API-Basis-URL weitergeleitet werden:

https://restapi.smsbat.com

---

Einzelne Nachricht senden

Endpunkt: POST /api/tsms/message/send

Ermöglicht das Senden von SMS- und Viber-Nachrichten mit Unterstützung für Hybridzustellung (Viber mit SMS-Fallback). Es verarbeitet eine einzelne Sendeanforderung und gibt die Zustellungsergebnisse für jeden Empfänger zurück.

Schlüsselfunktionen

• Flexible Parameter: Globale Parameter können durch bestimmte SMS/Viber-Parameter überschrieben werden.
• Inhalt: Unterstützt Viber-Karussells, Umfragen, Dateianhänge und interaktive Schaltflächen.
• Fehlerbehandlung: Gibt HTTP 200 auch bei Fehlern zurück (strukturierte Fehlerantworten). „response_code: 999“ mit Status „FATAL_ERROR“ für Systemfehler.
• Empfängerfehler: Spezifische Empfängerfehler werden im Array „response_result“ zurückgegeben. Fehlgeschlagene Empfänger haben „message_id: null“ und bestimmte Fehlercodes.

Anfragebeispiel (Hybridnachricht)

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

Beispiel für eine Anfrage (Viber-Karussell)

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

Beispiel einer Anfrage (Viber-Umfrage)

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

---

Mehrere Nachrichten senden (Batch)

Endpunkt: POST /api/tsms/message/sendmulti

Mit dieser Methode können Sie mehrere „Sende“-Anfragen in einer einzigen HTTP-Anfrage senden und so Verbindungsaufwand sparen. Der Aufruf von „sendmulti“ mit Daten für 100 Anfragen ist schneller als die Ausführung von 100 einzelnen „send“-Anfragen.

Beispiel für eine Anfrage

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

Antwortbeispiel

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

---

Nachrichtenstatus abrufen

Endpunkt: POST /api/tsms/message/status

Rufen Sie den Zustellungsstatus gesendeter Nachrichten ab, indem Sie deren „message_id“ angeben.

Beispiel für eine Anfrage

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

---

Nachrichtendetails abrufen

Endpunkt: POST /api/tsms/message/details

Ermöglicht Ihnen das Abrufen detaillierter Informationen zu erstellten Nachrichten, einschließlich vollständiger Payload-Details für SMS- und Viber-Kanäle, Preise und genaue Zeitstempel.

Beispiel für eine Anfrage

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

Antwortbeispiel

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