Vai al contenuto
Wbiztool

API promemoria

API Elenca promemoria

Ottieni i promemoria del tuo spazio di lavoro, 50 alla volta, dal più recente. Usala per trovare gli ID dei promemoria, controllare le tue automazioni o farne un backup.

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

Corpo: JSON o campi di un modulo

Questo endpoint accetta solo POST. Una richiesta GET, anche con una query string, restituisce HTTP 400 con Invalid JSON format: Expecting value….

L'elenco include i promemoria attivi e in pausa dell'intero spazio di lavoro, che siano stati creati tramite l'API o dalla pagina Promemoria. I promemoria annullati non sono inclusi.

Esempio rapido#

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
  }'

Sostituisci 12345 e YOUR_API_KEY con i tuoi valori. Consulta Autenticazione per sapere dove trovarli.

Parametri della richiesta#

client_idintegerobbligatorio

Il tuo ID Client API, da Impostazioni → Chiavi API.

api_keystringobbligatorio

La tua chiave API, dalla stessa pagina.

pageintegerfacoltativo

Numero di pagina, a partire da 1 (predefinito). Ogni pagina contiene 50 promemoria e la dimensione della pagina non può essere modificata. Un valore che non è un numero intero pari o superiore a 1 viene trattato come 1.

Risposta#

Una richiesta riuscita restituisce HTTP 200:

{
  "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
}
CampoTipoDescrizione
statusinteger1 in caso di successo, 0 se la richiesta non è riuscita.
messagestringSuccess, altrimenti l'errore.
remindersarrayI promemoria di questa pagina, dal più recente. Vuoto se la pagina è oltre la fine.
totalintegerPromemoria nello spazio di lavoro, su tutte le pagine.
pageintegerLa pagina restituita.
page_sizeintegerSempre 50.

Campi del promemoria#

CampoTipoDescrizione
idintegerL'ID del promemoria. Usalo con Annulla promemoria.
namestringIl nome del promemoria, oppure Unnamed Reminder se non ne ha uno.
to_numberstringNumero di telefono o nome del gruppo a cui viene inviato il promemoria.
message_templatestringIl messaggio, con le variabili di modello non ancora compilate.
msg_typeinteger0 testo, 1 immagine, 2 file.
msg_type_displaystringText, Image o File.
img_urlstring or nullURL dell'immagine per i promemoria con immagine, oppure URL del file per i promemoria con file creati tramite l'API. Negli altri casi può essere vuoto o null.
file_namestring or nullPer i promemoria con file: l'URL del file (promemoria creati dalla dashboard) oppure il nome del file (promemoria creati tramite l'API, il cui URL si trova in img_url). Negli altri casi può essere vuoto o null.
cron_expressionstringLa pianificazione. Vedi Espressioni cron.
next_runstringLa prossima volta in cui la pianificazione corrisponde, nel formato YYYY-MM-DD HH:MM:SS UTC, oppure Invalid cron se l'espressione non può essere letta. Vedi l'avviso sotto.
is_activebooleantrue se il promemoria è in esecuzione, false se è in pausa.
whatsapp_client_idinteger or nullIl numero WhatsApp da cui invia, oppure null se usa il primo numero collegato.
created_atstringQuando è stato creato il promemoria, in UTC, nel formato YYYY-MM-DD HH:MM:SS.

Errori#

Gli errori restituiscono HTTP 400 con status impostato su 0, salvo dove indicato:

{ "status": 0, "message": "Upgrade your plan to use reminders feature" }
MessaggioCome risolvere
Invalid JSON format: …Il corpo JSON non è valido. Ricevi questo errore anche per una richiesta GET o per una richiesta con campi di un modulo senza client_id.
Auth Error - Please send correct API key and Client idInvia sia client_id sia api_key.
Invalid client idInvia client_id come numero.
Auth Error: invalid api keyLa chiave appartiene a un altro client_id.
Auth Error: please check client idLa chiave non è associata a uno spazio di lavoro. Crea una nuova chiave nello spazio di lavoro che vuoi usare.
Demo Account cannot access APIsUsa un account normale.
Upgrade your plan to use reminders featureIl tuo piano non include i promemoria. Passa a un piano superiore. I promemoria esistenti continuano a essere eseguiti e a consumare crediti dopo un downgrade, e non possono essere elencati, annullati o sospesi finché non passi a un piano superiore.
Error fetching reminders: … (HTTP 500)Si è verificato un problema da parte nostra. Riprova.

Se l'api_key non esiste o è stata eliminata, la risposta è una pagina di errore HTML con HTTP 500 invece di JSON. Prova la tua chiave con Verifica credenziali.

Leggere tutte le pagine#

Continua a richiedere la pagina successiva finché una pagina non contiene meno di 50 promemoria.

Recupera tutti i promemoria
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")

Suggerimenti#

  • Conserva una tua copia del timezone di ogni promemoria quando lo crei, perché questo endpoint non lo restituisce.
  • Trova i promemoria in pausa filtrando quelli con is_active uguale a false. Riattivali dalla pagina Promemoria.
  • Fai pulizia delle vecchie automazioni: prima raccogli su tutte le pagine gli ID che vuoi annullare, poi chiama Annulla promemoria per ciascuno. Se annulli mentre scorri le pagine, i promemoria successivi si spostano sulle pagine precedenti e alcuni vengono saltati.