Api-dokumentation – smsgateway24

Dokumentation

API- und Integrationsdokumentation

Nutzen Sie SmsGateway24 mit SMS, WhatsApp, Chats, API-Anfragen und Webhooks.
Diese Dokumentation behandelt Token-Authentifizierung, Nachrichtenversand, Massenoperationen, Geräte-APIs, Zustellstatus und die Webhook-Integration.
v.1.1
API
Für Entwickler und Teams gemacht
Verbinden Sie Ihr Backend, CRM oder Helpdesk mit Ihrem Android-Messaging-Gerät.

1. Token abrufen:

Beschreibung: Bei erfolgreicher Ausführung dieser Anfrage erhalten Sie ein Token. Mit diesem Token können Sie anschließend auf den Server zugreifen und weitere Anfragen stellen.
Endpunkt: https://smsgateway24.com/getdata/gettoken
Methode:: GET
Parameter der Anfrage:
Variable Typ Beschreibung
email string [erforderlich] Your login in the system. Usually email
pass string [erforderlich] Your password in the system

Antwort im JSON-Format::
Variable Typ Beschreibung
token string Ihr Token erhalten Sie über die Methode zum Abrufen des Tokens:
error int 0 | 1 – gibt an, ob bei der Verarbeitung der Anfrage ein Fehler aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Codebeispiel mit Curl
Link zum Codebeispiel mit Guzzle
Beispiel für die Antwort:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f41119fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}

2. Einzelne Nachricht mit TOKEN senden:

Beschreibung: Erstellt eine ausgehende Nachricht auf dem Server. Die Nachricht kann über den gewählten Kanal Ihres verbundenen Android-Geräts gesendet werden.
Endpunkt: https://smsgateway24.com/getdata/addsms
Methode: GET, POST (Verwenden Sie in der GET-Anfrage %2B anstelle des Pluszeichens „+“)
Parameter der Anfrage:
Variable Typ Beschreibung
token string [erforderlich] Ihr Token erhalten Sie über die Methode zum Abrufen des Tokens.
sendto string [erforderlich] Adresse oder Telefonnummer des Empfängers. Mehrere Werte können durch Kommas getrennt werden.
body string [erforderlich] Nachrichtentext. Beim Senden eines Bildes nicht erforderlich (siehe Parameter „file“ unten) – in diesem Fall wird body durch die URL des hochgeladenen Bildes ersetzt.
device_id int [erforderlich] Geräte-ID
sim int [erforderlich] SIM-Slot: 0 und 1 für SMS. 2 – WhatsApp Business, 3 – WhatsApp privat. 4 und 5 – RCS.
timetosend string
YYYY-MM-DD
oder
YYYY-MM-DD HH:MM:SS
[optional] Zeitpunkt für den Nachrichtenversand. Zum Beispiel: 2026-09-22 12:13:52
customerid int [optional] Die Kundennummer Ihres Kunden. Optionales Feld
urgent int [optional] Markiert die Nachricht als dringend. Nützlich für OTP und Traffic mit hoher Priorität.
file file (multipart/form-data) [optional] Zu sendende Bilddatei (jpeg, png, webp, gif). Wird sie angegeben, muss die Anfrage als multipart/form-data per POST gesendet werden. Die Datei wird in unseren S3-Speicher geladen, und ihre öffentliche URL ersetzt das Feld „body“, sodass das Bild an den Empfänger zugestellt wird (derzeit auf WhatsApp-/WhatsApp-Business-Slots unterstützt) und zudem im entsprechenden Chat angezeigt wird. Dieser Parameter ist vollständig optional – bestehende Integrationen, die nur Textnachrichten senden, funktionieren unverändert weiter.
Abwärtskompatibilität: Der Parameter „file“ ist optional. Senden Sie keine Datei, verhält sich der Endpunkt genau wie bisher – Ihre bestehenden reinen Text-Integrationen benötigen keine Änderungen.

Antwort im JSON-Format:
Variable Typ Beschreibung
error int 0 oder 1 – gibt an, ob bei der Verarbeitung der Anfrage ein Fehler aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
sms_id int Kennung der erstellten Nachricht in unserem System.
Link zum Codebeispiel mit Curl
Link zum Codebeispiel mit Guzzle
Beispiel für die Antwort:
{ "error": 0, "sms_id": 62807347, "message": "Sms has been saved successfully" }

2.1 Veraltete Methode: einzelne SMS mit Login und Passwort senden

Veraltet. Verwenden Sie für neue Integrationen die tokenbasierte Authentifizierung. Diese Methode bleibt nur aus Gründen der Abwärtskompatibilität erhalten.
Endpunkt: https://smsgateway24.com/getdata/smstosend
Methode: GET, POST
Parameter der Anfrage:
Variable Typ Beschreibung
emailstring[erforderlich] Ihre E-Mail-Adresse
passstring[erforderlich] Ihr Passwort
sendtostring[erforderlich] Adresse oder Telefonnummer des Empfängers.
bodystring[erforderlich] Nachrichtentext
device_idint[erforderlich] Geräte-ID
simint[erforderlich] SIM-Slot: 0 und 1 für SMS. 2 – WhatsApp Business, 3 – WhatsApp privat. 4 und 5 – RCS
timetosendstring[optional] Geplante Sendezeit.
customeridint[optional] Ihre Kundenkennung.
urgentint[optional] Markiert die Nachricht als dringend.

3. SMS im Stapel per JSON senden

Beschreibung: Erstellt SMS auf dem Server zum Versand. Anschließend ruft das Telefon mit der Smsgateway24-App den Server auf, übernimmt die SMS und sendet sie über Ihre SIM-Karte. Laden Sie die Anwendung über diesen Link herunter
Endpunkt: https://smsgateway24.com/getdata/addalotofsms
Methode:: GET, POST
Parameter der Anfrage:
Variable Typ Beschreibung
datajson string [erforderlich] {"token":"df427bfcf113c9a21c67718035076b5b","smsdata":[{"sendto":"015752982212","body":"Test message","sim":1,"timetosend":"2019-07-01 23:50:00","device_id":260},{"sendto":"+4915752982212","body":"Test message 2","sim":1,"timetosend":"2019-07-01 23:50:00","device_id":260,"urgent":1}]}

Antwort im JSON-Format::
Variable Typ Beschreibung
error int 0 | 1 – gibt an, ob bei der Verarbeitung der Anfrage ein Fehler aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Codebeispiel mit Curl
Link zum Codebeispiel mit Guzzle
Request example:
{ "token":"df427bfcf113c9a21c6771803501", "smsdata":[ { "sendto":"015752982212", "body":"Your password is 12345", "sim":1, "timetosend":"2019-07-01 23:50:00", "device_id":260, "customerid":122, "urgent":1 }, { "sendto":"015752982212", "body":"Regular SMS. Not urgnet", "sim":1, "timetosend":"2019-07-01 23:50:00", "device_id":260, "customerid":122, "urgent":0 } ] }

4. Alle SMS abrufen (einschließlich eingehender SMS):

Beschreibung: Mit dieser Anfrage rufen Sie alle Nachrichten Ihres Kontos ab, einschließlich eingehender SMS von Kunden. Alle Eingabevariablen sind bei dieser Methode Pflicht, und die SMS können unterschiedliche Status haben.
Endpunkt: https://smsgateway24.com/getdata/getallsms
Methode: GET, POST (Verwenden Sie in der GET-Anfrage %2B anstelle des Pluszeichens „+“)
Parameter der Anfrage:
Variable Typ Beschreibung
token string [erforderlich] Ihr Token erhalten Sie über die Methode zum Abrufen des Tokens.
device_id string [optional] Geräte-ID
status int [optional]
  • 1 - Ausstehende SMS
  • 2 - Vom Telefon übernommene SMS
  • 3 - In der Warteschlange zum Senden. Certainly, it would have been more logical to place the status "queued for sending" before "SMS taken by phone," but for backward compatibility, the statuses are in the following order: 1, 3, 2."
  • 5 - Eingehende SMS
  • 6 - Vom Telefon gesendete SMS
  • 7 - SMS wurde zugestellt
  • 8 - SMS wurde NICHT zugestellt
  • 9 - SMS wurde überhaupt nicht gesendet – Generic Failure. (Lesen Sie, was bei diesem Fehler zu tun ist hier)
  • Weitere, seltenere Fehler:
  • 10 - SMS nicht gesendet - No Service
  • 11 - SMS nicht gesendet - Null PDU
  • 12 - SMS nicht gesendet - Radio Off
  • 100, 101 - SMS nicht gesendet - NOT ALLOWED. (Der Anwendung wurden keine Berechtigungen zum Senden von SMS erteilt)
begindate string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[optional] Begin Date Time
enddate string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[optional] End Date Time
sim int [optional] SIM-Slot: 0 und 1 für SMS. 2 – WhatsApp Business, 3 – WhatsApp privat. 4 und 5 – RCS # 0 or 1
customerid int [optional] Die Kundennummer Ihres Kunden. Optionales Feld
onlycount int [optional] 0 | 1 nur zählen
phone string [optional] 0 | 1 Filter nach Telefonnummer
orderbydesc int [optional] 0 | 1 Order by any field
timezone int [optional] Geben Sie Ihre lokale Zeitzone an, zum Beispiel Australia/Sydney.

Antwort im JSON-Format::
Variable Typ Beschreibung
token string Ihr Token erhalten Sie über die Methode zum Abrufen des Tokens:
error int 0 | 1 – gibt an, ob bei der Verarbeitung der Anfrage ein Fehler aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist
count int SMS amount
smss int JSON object
Link zum Codebeispiel mit Curl
Link zum Codebeispiel mit Guzzle
Beispiel für die Antwort ... :
{ "smss": { "62050971": { "id": 62050971, "sendto": "+4912312312332", "body": "Hello! Thank you for Order! ", "customerid": null, "status": 2, "statustitle": "sending", "deviceid": 11231, "urgent": null, "created": { "date": "2023-11-02 22:44:43.000000", "timezone_type": 3, "timezone": "Europe/Paris" }, "senttime": null, "timetosend": null, "paketid": null, "pakettitle": null, "paketbody": null }, "62051117": { "id": 62051117, "sendto": "+4912312312332", "body": "Hello! Thank you for Order! ", "customerid": null, "status": 7, "statustitle": "delivered", "deviceid": 11231, "urgent": null, "created": { "date": "2023-11-02 22:46:09.000000", "timezone_type": 3, "timezone": "Europe/Paris" }, "senttime": null, "timetosend": null, "paketid": null, "pakettitle": null, "paketbody": null } } }

5. Neue Kontaktliste hinzufügen

Beschreibung: Der Tag wird benötigt, um einen Newsletter an eine Gruppe von Nummern zu erstellen. Verwenden Sie zum Beispiel den Tag „Mitarbeitende“
Endpunkt: https://smsgateway24.com/getdata/savetag
Methode:: GET, POST
Parameter der Anfrage:
Variable Typ Beschreibung
token string [erforderlich] Ihr Token erhalten Sie über die Methode zum Abrufen des Tokens.
title string [erforderlich] Name des Tags

Antwort im JSON-Format::
Variable Typ Beschreibung
tag_id int Tag ID
error int 0 | 1 – gibt an, ob bei der Verarbeitung der Anfrage ein Fehler aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Codebeispiel mit Curl
Link zum Codebeispiel mit Guzzle
Beispiel für die Antwort:
{ "error": 0, "tag_id": 8303, "message": "OK" }

6. Kontakte zur Kontaktliste hinzufügen:

Beschreibung: Fügen Sie Kontakte zu einem beliebigen Tag hinzu. Zum Tag * Mitarbeitende * passen zum Beispiel Ihre Kolleginnen und Kollegen perfekt.
Endpunkt: https://smsgateway24.com/getdata/savecontact
Methode:: GET, POST
Parameter der Anfrage:
Variable Typ Beschreibung
token string [erforderlich] Ihr Token erhalten Sie über die Methode zum Abrufen des Tokens.
phone string [erforderlich] phone number
ctag_id int [erforderlich] Tag ID
fullname string [erforderlich] Der Name Ihres Kunden

Antwort im JSON-Format::
Variable Typ Beschreibung
contact_id int Contact Id
error int 0 | 1 – gibt an, ob bei der Verarbeitung der Anfrage ein Fehler aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Codebeispiel mit Curl
Link zum Codebeispiel mit Guzzle
Beispiel für die Antwort ... :
{"error":0,"contact_id":15954765,"message":"ok"}

7. Newsletter erstellen

Beschreibung:Sobald Sie den Tag erstellt haben, können Sie die Aussendung an die Telefonnummern des Tags durchführen.
Endpunkt: https://smsgateway24.com/getdata/savepaket
Methode:: GET, POST
Parameter der Anfrage:
Variable Typ Beschreibung
token string [erforderlich] Ihr Token erhalten Sie über die Methode zum Abrufen des Tokens.
title string [erforderlich] Titel des Newsletters
device_id string [erforderlich] Geräte-ID
body string [erforderlich] Text der Zielnachricht
tags string [erforderlich] Tag-ID. Es können mehrere sein, durch Kommas getrennt. Zum Beispiel: 12,13,14
sim int [erforderlich]SIM-Slot: 0 und 1 für SMS. 2 – WhatsApp Business, 3 – WhatsApp privat. 4 und 5 – RCS 0 or 1
time_to_send int, default = 0 [erforderlich]Date time when Newsletter should be sent. Do not forget tap start on device. DD.MM.YYYY H:i:s

Antwort im JSON-Format::
Variable Typ Beschreibung
contact_id int Kontakt-ID
error int 0 | 1 – gibt an, ob bei der Verarbeitung der Anfrage ein Fehler aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
paket_id int Package ID
Link zum Codebeispiel mit Curl
Link zum Codebeispiel mit Guzzle
Beispiel für die Antwort ... :
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f4f49fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}

8. Geräteliste abrufen

Beschreibung: Sie können alles über Ihre Geräte erfahren.
Endpunkt: https://smsgateway24.com/getdata/getalldevices
Methode:: GET, POST
Parameter der Anfrage:
Variable Typ Beschreibung
token string [erforderlich] Ihr Token erhalten Sie über die Methode zum Abrufen des Tokens.

Antwort im JSON-Format::
Variable Typ Beschreibung
count int Anzahl der Geräte:
device json
  • id - Geräte-ID
  • title - Gerätename
  • created - Erstellungsdatum des Geräts
  • createdhumanformat - Erstellungsdatum des Geräts im normalen Format
  • lastseen - Datum, an dem das Gerät zuletzt gesehen wurde
  • lastseenhumanformat - Datum, an dem das Gerät zuletzt gesehen wurde
  • serialnumber - Seriennummer des Geräts
  • siminfo - Informationen zu den SIM-Karten im JSON-Format
  • appversion - Die auf dem Gerät installierte Version der Anwendung
  • subscription - Ist auf dem Gerät ein Abonnement vorhanden
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Codebeispiel mit Curl
Link zum Codebeispiel mit Guzzle
Beispiel für die Antwort:
    {
    "count": 2,
    "device": {
        "1576": {
            "id": 1576,
            "title": "AOSP_on_IA_Emulator",
            "number": null,
            "imei": "358240051111110",
            "created": {
                "date": "2020-03-28 20:10:29.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "createdhumanformat": "28.03.2020 20:10:29",
            "lastseen": {
                "date": "2020-04-23 17:02:21.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "lastseenhumanformat": "23.04.2020 17:02:21",
            "serialnumber": "EMULATOR30X0X5X0",
            "siminfo": [
                {
                    "Slot": "0",
                    "IccId": "89014103211118510720",
                    "Number": " 15555215554",
                    "Roaming": "0",
                    "CountryIso": "us",
                    "CarrierName": "Android (T-Mobile)"
                }
            ],
            "appversion": "12.1.21",
            "isappversionactual": false,
            "delaybetweeneachsms": null,
            "delaybetweenrequest": 1,
            "subscription": true
        },
        "1297": {
            "id": 1297,
            "title": "Android_SDK_built_for_x86",
            "number": null,
            "imei": "null",
            "created": {
                "date": "2020-01-20 14:01:05.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "createdhumanformat": "20.01.2020 14:01:05",
            "lastseen": {
                "date": "2020-04-20 20:51:34.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "lastseenhumanformat": "20.04.2020 20:51:34",
            "serialnumber": "unknown",
            "siminfo": [
                {
                    "Slot": "0",
                    "IccId": "8949226172233934327",
                    "Number": "+4915752982212",
                    "Roaming": "1",
                    "CountryIso": "de",
                    "CarrierName": "Drillisch (o2)"
                }
            ],
            "appversion": "12.1.21",
            "isappversionactual": false,
            "delaybetweeneachsms": 5,
            "delaybetweenrequest": 10,
            "subscription": false
        }
    }
}

9. Zustellstatus einer einzelnen SMS abrufen

Beschreibung: Mit dieser Methode können Sie den Zustellstatus jeder SMS abfragen
Endpunkt: https://smsgateway24.com/getdata/getsmsstatus
Methode:: GET, POST
Parameter der Anfrage:
Variable Typ Beschreibung
token string [erforderlich] Ihr Token erhalten Sie über die Methode zum Abrufen des Tokens.
sms_id int [erforderlich] Sms Id

Antwort im JSON-Format::
Variable Typ Beschreibung
sms_id int SMS ID
status int SMS Status
  • 1 - Ausstehende SMS
  • 2 - Vom Telefon übernommene SMS
  • 3 - In der Warteschlange zum Senden. Certainly, it would have been more logical to place the status "queued for sending" before "SMS taken by phone," but for backward compatibility, the statuses are in the following order: 1, 3, 2."
  • 5 - Eingehende SMS
  • 6 - Vom Telefon gesendete SMS
  • 7 - SMS wurde zugestellt
  • 8 - SMS wurde NICHT zugestellt
  • 9 - SMS wurde überhaupt nicht gesendet – Generic Failure. (Lesen Sie, was bei diesem Fehler zu tun ist hier)
  • Weitere, seltenere Fehler:
  • 10 - SMS nicht gesendet - No Service
  • 11 - SMS nicht gesendet - Null PDU
  • 12 - SMS nicht gesendet - Radio Off
  • 100, 101 - SMS nicht gesendet - NOT ALLOWED. (Der Anwendung wurden keine Berechtigungen zum Senden von SMS erteilt)
status_description string Statusbezeichnung
error int 0 | 1 - liegt bei der Verarbeitung der Anfrage ein Fehler vor
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Codebeispiel mit Curl
Link zum Codebeispiel mit Guzzle
Beispiel für die Antwort:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f4f49fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}