Api-dokumentation

Dokumentation | SmsGateway24.com

v.1.0

1. Ein Token erhalten:

Beschreibung: Nach erfolgreicher Ausführung dieser Abfrage erhalten Sie ein Token. Anschließend können Sie dieses Token verwenden, um auf den Server zuzugreifen und zusätzliche Anfragen zu stellen.
Endpunkt: https://smsgateway24.com/getdata/gettoken
Methode:: GET
Parameter der Anfrage:
Variable Typ Beschreibung
email string [benötigt] Your login in the system. Usually email
pass string [benötigt] Your password in the system

JSON-formatierte Antwort::
Variable Typ Beschreibung
token string Ihr Token wird durch die Token-Abruf Methode übernommen:
error int 0 | 1 - zeigt an, ob ein Fehler bei der Bearbeitung der Anfrage aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Beispiel Curl
Link zum Beispiel-Guzzle
Beispiel der Antwort:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f41119fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}

2. Sende einzelne SMS mit TOKEN:

Beschreibung: Erzeugt SMS-Nachrichten auf dem Server, die gemeinsam in einem Stapel gesendet werden sollen. Aktiviert die gleichzeitige Erstellung mehrerer SMS-Nachrichten durch eine einzelne Anfrage.
Endpunkt: https://smsgateway24.com/getdata/addsms
Methode:: GET, POST ( %2B anstelle des Plus-Zeichens '+' in der GET-Anfrage verwenden )
Parameter der Anfrage:
Variable Typ Beschreibung
token string [benötigt] Ihr Token wird über die Token-Abfragemethode erworben.
sendto string [benötigt]Telefonnummer des Abonnenten. Alle Zeichen sind zulässig. Zum Beispiel: +4915752982212, +4917642111111, +1 17642031984. Alternativ können mehrere Zahlen durch Kommas getrennt werden
body string [benötigt] Nachrichtentext
device_id string [benötigt] Geräte-ID
timetosend string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[optional] Zeit zum Senden einer Nachricht. Zum Beispiel 2024-04-15 03:26:24
sim int, default = 0 [optional] SIM slot # 0 or 1
customerid int [optional] ID-Nummer Ihres Kunden. Optionales Feld.
urgent int [optional] Als dringend markierte SMS. Dieses Feld ist optional. Die SMS wird mit Priorität verschickt, und es kann vorteilhaft sein, einmalige Passwörter (OTPs) zu senden.

JSON-formatierte Antwort::
Variable Typ Beschreibung
token string Ihr Token wird durch die Token-Abruf Methode übernommen:
error int 0 | 1 - zeigt an, ob ein Fehler bei der Bearbeitung der Anfrage aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Beispiel Curl
Link zum Beispiel-Guzzle
Beispiel der Antwort:
{ "error": 0, "sms_id": 62807347, "message": "Sms has been saved successfully"}

2.1 Sende einzelne SMS mit Login und Passwort:

Beschreibung: Erzeugt SMS-Nachrichten auf dem Server, die gemeinsam in einem Stapel gesendet werden sollen. Aktiviert die gleichzeitige Erstellung mehrerer SMS-Nachrichten durch eine einzelne Anfrage.
Endpunkt: https://smsgateway24.com/getdata/smstosend
Methode:: GET, POST ( %2B anstelle des Plus-Zeichens '+' in der GET-Anfrage verwenden )
Parameter der Anfrage:
Variable Typ Beschreibung
email string [benötigt] Ihre E-Mail
pass string [benötigt] Ihr Passwort
sendto string [benötigt]Telefonnummer des Abonnenten. Alle Zeichen sind zulässig. Zum Beispiel: +4915752982212, +4917642111111, +1 17642031984. Alternativ können mehrere Zahlen durch Kommas getrennt werden
body string [benötigt] Nachrichtentext
device_id string [benötigt] Geräte-ID
timetosend string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[optional] Zeit zum Senden einer Nachricht. Zum Beispiel 2024-04-15 03:26:24
sim int, default = 0 [optional] SIM slot # 0 or 1
customerid int [optional] ID-Nummer Ihres Kunden. Optionales Feld.
urgent int [optional] Als dringend markierte SMS. Dieses Feld ist optional. Die SMS wird mit Priorität verschickt, und es kann vorteilhaft sein, einmalige Passwörter (OTPs) zu senden.

JSON-formatierte Antwort::
Variable Typ Beschreibung
token string Ihr Token wird durch die Token-Abruf Methode übernommen:
error int 0 | 1 - zeigt an, ob ein Fehler bei der Bearbeitung der Anfrage aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Beispiel Curl
Link zum Beispiel-Guzzle
Beispiel der Antwort:
{ "error": 0, "sms_id": 62807347, "message": "Sms has been saved successfully"}

3. Senden von SMS in Massenversand mit JSON

Beschreibung: Erstellt SMS auf dem zu sendenden Server. Danach das Telefon mit der Smsgateway24-Anwendung ruft den Server an und nimmt die SMS und sendet es von Ihrer SIM-Karte herunter. Laden Sie die Anwendung unter dem Link herunter
Endpunkt: https://smsgateway24.com/getdata/addalotofsms
Methode:: GET, POST
Parameter der Anfrage:
Variable Typ Beschreibung
datajson string [benötigt] {"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}]}

JSON-formatierte Antwort::
Variable Typ Beschreibung
error int 0 | 1 - zeigt an, ob ein Fehler bei der Bearbeitung der Anfrage aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Beispiel Curl
Link zum Beispiel-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 (inkl. eingehender SMS) abrufen:

Beschreibung: Mit dieser Anfrage können Sie alle Nachrichten abrufen, die mit Ihrem Konto verbunden sind, einschließlich eingehender SMS von Kunden. Alle Eingabevariablen sind in dieser Methode zwingend vorgeschrieben, und SMS-Nachrichten können im Status variieren.
Endpoint: https://smsgateway24.com/getdata/getallsms
Methode: GET, POST (Verwenden Sie %2B anstelle des Pluszeichens "+" in der GET-Anfrage)
Parameter der Anfrage:
Variable Typ Beschreibung
token string [benötigt] Ihr Token wird über die Token-Abfragemethode erworben.
device_id string [optional] Geräte-ID
status int [optional]
  • 1 - Ausstehende SMS
  • 2 - SMS per Telefon angenommen
  • 3 - 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 - SMS per Telefon gesendet
  • 7 - SMS wurde gesendet
  • 8 - SMS wurde NICHT geliefert
  • 9 - SMS überhaupt nicht gesendet. Generischer Fehler. (Lies was mit diesem Fehler zu tun ist hier)
  • Andere, weniger häufige 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. (Berechtigungen für das Senden von SMS in der Anwendung wurden nicht gewährt)
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 or 1
customerid int [optional] ID-Nummer Ihres Kunden. Optionales Feld
onlycount int [optional] 0 | 1 nur zählen
phone string [optional] 0 | 1 Telefonnummer-Filter
orderbydesc int [optional] 0 | 1 Order by any field
timezone int [optional] Geben Sie Ihre lokale Zeitzone an, wie zum Beispiel die Einstellung auf Australien/Sydney.

JSON-formatierte Antwort::
Variable Typ Beschreibung
token string Ihr Token wird durch die Token-Abruf Methode übernommen:
error int 0 | 1 - zeigt an, ob ein Fehler bei der Bearbeitung der Anfrage aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist
count int SMS amount
smss int JSON object
Link zum Beispiel Curl
Link zum Beispiel-Guzzle
Beispiel der 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 zu generieren, der eine Gruppe von Nummern anvisiert. Verwenden Sie zum Beispiel den Tag Mitarbeiter
Endpunkt: https://smsgateway24.com/getdata/savetag
Methode:: GET, POST
Parameter der Anfrage:
Variable Typ Beschreibung
token string [benötigt] Ihr Token wird über die Token-Abfragemethode erworben.
title string [benötigt] Tag-Name

JSON-formatierte Antwort::
Variable Typ Beschreibung
tag_id int Tag ID
error int 0 | 1 - zeigt an, ob ein Fehler bei der Bearbeitung der Anfrage aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Beispiel Curl
Link zum Beispiel-Guzzle
Beispiel der Antwort:
{ "error": 0, "tag_id": 8303, "message": "OK" }

6. Kontakte zur Kontaktliste hinzufügen:

Beschreibung: Fügen Sie Kontakte für jeden Tag hinzu. Zum Beispiel für den Tag * Mitarbeiter * Ihre Kollegen werden perfekt passen.
Endpunkt: https://smsgateway24.com/getdata/savecontact
Methode:: GET, POST
Parameter der Anfrage:
Variable Typ Beschreibung
token string [benötigt] Ihr Token wird über die Token-Abfragemethode erworben.
phone string [benötigt] phone number
ctag_id int [benötigt] Tag ID
fullname string [benötigt] Name Ihres Kunden

JSON-formatierte Antwort::
Variable Typ Beschreibung
contact_id int Contact Id
error int 0 | 1 - zeigt an, ob ein Fehler bei der Bearbeitung der Anfrage aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Beispiel Curl
Link zum Beispiel-Guzzle
Beispiel der Antwort ... :
{"error":0,"contact_id":15954765,"message":"ok"}

7. Newsletter erstellen

Beschreibung:Sobald Sie das Tag erstellt haben, können Sie das Mailing auf dem Tag Telefone durchführen.
Endpunkt: https://smsgateway24.com/getdata/savepaket
Methode:: GET, POST
Parameter der Anfrage:
Variable Typ Beschreibung
token string [benötigt] Ihr Token wird über die Token-Abfragemethode erworben.
title string [benötigt] Newsletter-Titel
device_id string [benötigt] Geräte-ID
body string [benötigt] Inhalt der Zielnachricht
tags string [benötigt] Tag-Id. Kann mehrere, durch Kommata getrennt werden. Zum Beispiel: 12,13,14
sim int, default = 0 [benötigt]SIM-Slot Nummer im Telefon: 0 or 1
time_to_send int, default = 0 [benötigt]Date time when Newsletter should be sent. Do not forget tap start on device. DD.MM.YYYY H:i:s

JSON-formatierte Antwort::
Variable Typ Beschreibung
contact_id int Kontaktnummer
error int 0 | 1 - zeigt an, ob ein Fehler bei der Bearbeitung der Anfrage aufgetreten ist
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
paket_id int Package ID
Link zum Beispiel Curl
Link zum Beispiel-Guzzle
Beispiel der Antwort ... :
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f4f49fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}

8. Geräteliste abrufen

Beschreibung: Du kannst alles über deine Geräte erfahren.
Endpunkt: https://smsgateway24.com/getdata/getalldevices
Methode:: GET, POST
Parameter der Anfrage:
Variable Typ Beschreibung
token string [benötigt] Ihr Token wird über die Token-Abfragemethode erworben.

JSON-formatierte Antwort::
Variable Typ Beschreibung
count int Anzahl der Geräte:
device json
  • id - Geräte-ID
  • title - Gerätename
  • created - Geräteerstellungsdatum
  • createdhumanformat - Erstellungsdatum Gerät im regulären Format
  • lastseen - Das Datum des zuletzt gesehenen Geräts
  • lastseenhumanformat - Das Datum des zuletzt gesehenen Geräts
  • serialnumber - Seriennummer des Geräts
  • siminfo - Informationen über SIM-Karten in JSON
  • appversion - Die Version der Anwendung auf dem Gerät installiert
  • subscription - Gibt es ein Abonnement auf dem Gerät
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Beispiel Curl
Link zum Beispiel-Guzzle
Beispiel der 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. Erhalten Sie den Zustellstatus einer einzigen SMS

Beschreibung: Sie können den Zustellstatus jeder SMS mit dieser Methode erfahren
Endpunkt: https://smsgateway24.com/getdata/getsmsstatus
Methode:: GET, POST
Parameter der Anfrage:
Variable Typ Beschreibung
token string [benötigt] Ihr Token wird über die Token-Abfragemethode erworben.
sms_id int [benötigt] Sms Id

JSON-formatierte Antwort::
Variable Typ Beschreibung
sms_id int SMS ID
status int SMS Status
  • 1 - Ausstehende SMS
  • 2 - SMS per Telefon angenommen
  • 3 - 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 - SMS per Telefon gesendet
  • 7 - SMS wurde gesendet
  • 8 - SMS wurde NICHT geliefert
  • 9 - SMS überhaupt nicht gesendet. Generischer Fehler. (Lies was mit diesem Fehler zu tun ist hier)
  • Andere, weniger häufige 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. (Berechtigungen für das Senden von SMS in der Anwendung wurden nicht gewährt)
status_description string Statusname
error int 0 | 1 - ist ein Fehler bei der Bearbeitung der Anfrage
message string Fehlermeldung, leer, wenn alles in Ordnung ist.
Link zum Beispiel Curl
Link zum Beispiel-Guzzle
Beispiel der Antwort:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f4f49fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}