Zum Inhalt springen
Wbiztool

Erinnerungs-API

Erinnerungen auflisten (API)

Rufen Sie die Erinnerungen in Ihrem Arbeitsbereich ab, jeweils 50 auf einmal, die neuesten zuerst. Nutzen Sie die API, um Erinnerungs-IDs zu finden, Ihre Automatisierungen zu überprüfen oder zu sichern.

POSThttps://wbiztool.com/api/v1/reminder/list/

Body: JSON oder Formularfelder

Dieser Endpoint akzeptiert nur POST. Ein GET-Request liefert, auch mit Query-String, HTTP 400 mit Invalid JSON format: Expecting value….

Die Liste enthält aktive und pausierte Erinnerungen aus dem gesamten Arbeitsbereich, egal ob sie über die API oder auf der Seite Erinnerungen erstellt wurden. Stornierte Erinnerungen sind nicht enthalten.

Kurzes Beispiel#

curl -X POST https://wbiztool.com/api/v1/reminder/list/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "page": 1
  }'

Ersetzen Sie 12345 und YOUR_API_KEY durch Ihre eigenen Werte. Wo Sie diese finden, steht unter Authentifizierung.

Request-Parameter#

client_idintegererforderlich

Ihre API-Client-ID aus Einstellungen → API-Schlüssel.

api_keystringerforderlich

Ihr API-Schlüssel von derselben Seite.

pageintegeroptional

Seitennummer, beginnend bei 1 (Standard). Jede Seite enthält 50 Erinnerungen, und die Seitengröße kann nicht geändert werden. Ein Wert, der keine ganze Zahl von 1 oder mehr ist, wird als 1 behandelt.

Antwort#

Ein erfolgreicher Request gibt HTTP 200 zurück:

{
  "reminders": [
    {
      "id": 3187,
      "name": "Monthly rent reminder",
      "to_number": "919876543210",
      "message_template": "Hi Aman, a reminder that your rent is due on {current_date_formatted}.",
      "msg_type": 0,
      "msg_type_display": "Text",
      "img_url": "",
      "file_name": "",
      "cron_expression": "0 10 1 * *",
      "next_run": "2026-10-01 10:00:00 UTC",
      "is_active": true,
      "whatsapp_client_id": 678,
      "created_at": "2026-09-16 04:45:12"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 50,
  "message": "Success",
  "status": 1
}
FeldTypBeschreibung
statusinteger1 bei Erfolg, 0, wenn der Request fehlgeschlagen ist.
messagestringSuccess, andernfalls der Fehler.
remindersarrayDie Erinnerungen auf dieser Seite, die neuesten zuerst. Leer, wenn die Seite hinter dem Ende liegt.
totalintegerErinnerungen im Arbeitsbereich, über alle Seiten.
pageintegerDie zurückgegebene Seite.
page_sizeintegerImmer 50.

Felder einer Erinnerung#

FeldTypBeschreibung
idintegerDie ID der Erinnerung. Verwenden Sie sie mit Erinnerung stornieren.
namestringDer Name der Erinnerung oder Unnamed Reminder, wenn sie keinen hat.
to_numberstringTelefonnummer oder Gruppenname, an die die Erinnerung gesendet wird.
message_templatestringDie Nachricht, mit noch nicht ausgefüllten Vorlagenvariablen.
msg_typeinteger0 Text, 1 Bild, 2 Datei.
msg_type_displaystringText, Image oder File.
img_urlstring or nullBild-URL bei Erinnerungen mit Bild oder die Datei-URL bei über die API erstellten Datei-Erinnerungen. Kann andernfalls leer oder null sein.
file_namestring or nullBei Datei-Erinnerungen: die Datei-URL (im Dashboard erstellte Erinnerungen) oder der Dateiname (über die API erstellte Erinnerungen, deren URL in img_url steht). Kann andernfalls leer oder null sein.
cron_expressionstringDer Zeitplan. Siehe Cron-Ausdrücke.
next_runstringNächster Zeitpunkt, an dem der Zeitplan zutrifft, als YYYY-MM-DD HH:MM:SS UTC, oder Invalid cron, wenn der Ausdruck nicht gelesen werden kann. Siehe den Warnhinweis unten.
is_activebooleantrue, wenn die Erinnerung läuft, false, wenn sie pausiert ist.
whatsapp_client_idinteger or nullDie WhatsApp-Nummer, von der gesendet wird, oder null, wenn die erste verbundene Nummer verwendet wird.
created_atstringWann die Erinnerung erstellt wurde, in UTC, als YYYY-MM-DD HH:MM:SS.

Fehler#

Fehler geben HTTP 400 mit status gleich 0 zurück, sofern nicht anders angegeben:

{ "status": 0, "message": "Upgrade your plan to use reminders feature" }
MeldungLösung
Invalid JSON format: …Der JSON-Body ist ungültig. Diese Meldung erhalten Sie auch bei einem GET-Request oder einem Formular-Request ohne client_id.
Auth Error - Please send correct API key and Client idSenden Sie client_id und api_key.
Invalid client idSenden Sie client_id als Zahl.
Auth Error: invalid api keyDer Schlüssel gehört zu einer anderen client_id.
Auth Error: please check client idDer Schlüssel ist mit keinem Arbeitsbereich verknüpft. Erstellen Sie einen neuen Schlüssel in dem Arbeitsbereich, den Sie verwenden möchten.
Demo Account cannot access APIsVerwenden Sie ein reguläres Konto.
Upgrade your plan to use reminders featureIhr Plan enthält keine Erinnerungen. Führen Sie ein Upgrade Ihres Plans durch. Bestehende Erinnerungen laufen nach einem Downgrade weiter und verbrauchen Credits, können aber bis zu einem Upgrade weder aufgelistet noch abgebrochen oder pausiert werden.
Error fetching reminders: … (HTTP 500)Auf unserer Seite ist etwas schiefgelaufen. Versuchen Sie es erneut.

Wenn der api_key nicht existiert oder gelöscht wurde, ist die Antwort eine HTML-Fehlerseite mit HTTP 500 statt JSON. Testen Sie Ihren Schlüssel mit Zugangsdaten prüfen.

Alle Seiten abrufen#

Fordern Sie so lange die nächste Seite an, bis eine Seite weniger als 50 Erinnerungen enthält.

Alle Erinnerungen abrufen
import requests

reminders, page = [], 1

while True:
    response = requests.post(
        "https://wbiztool.com/api/v1/reminder/list/",
        json={"client_id": 12345, "api_key": "YOUR_API_KEY", "page": page},
        timeout=60,
    )
    try:
        result = response.json()
    except ValueError:
        raise SystemExit(f"HTTP {response.status_code}: not JSON. Check that your api_key exists.")
    if result["status"] != 1:
        raise RuntimeError(result["message"])

    reminders += result["reminders"]
    if len(result["reminders"]) < result["page_size"]:
        break
    page += 1

print(len(reminders), "reminders")

Tipps#

  • Speichern Sie eine eigene Kopie der timezone jeder Erinnerung beim Erstellen, da dieser Endpoint sie nicht zurückgibt.
  • Pausierte Erinnerungen finden: Filtern Sie nach is_active mit dem Wert false. Setzen Sie sie auf der Seite Erinnerungen fort.
  • Alte Automatisierungen aufräumen: Sammeln Sie zuerst über alle Seiten hinweg die IDs, die Sie stornieren möchten, und rufen Sie dann für jede Erinnerung stornieren auf. Wenn Sie während des Blätterns stornieren, rücken spätere Erinnerungen auf frühere Seiten vor, und einige werden übersprungen.