Saltar al contenido
Wbiztool

API de recordatorios

API para listar recordatorios

Obtén los recordatorios de tu espacio de trabajo, de 50 en 50, del más reciente al más antiguo. Úsala para encontrar los IDs de los recordatorios, revisar tus automatizaciones o hacer una copia de seguridad.

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

Cuerpo: JSON o campos de formulario

Este endpoint solo acepta POST. Una solicitud GET, incluso con query string, devuelve HTTP 400 con Invalid JSON format: Expecting value….

La lista incluye los recordatorios activos y pausados de todo el espacio de trabajo, tanto si se crearon a través de la API como en la página de Recordatorios. Los recordatorios cancelados no se incluyen.

Ejemplo rápido#

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

Sustituye 12345 y YOUR_API_KEY por tus propios valores. Consulta Autenticación para saber dónde encontrarlos.

Parámetros de la solicitud#

client_idintegerobligatorio

Tu ID de cliente de la API, de Configuración → Claves API.

api_keystringobligatorio

Tu clave API, de esa misma página.

pageintegeropcional

Número de página, empezando en 1 (valor predeterminado). Cada página contiene 50 recordatorios y el tamaño de página no se puede cambiar. Un valor que no sea un número entero de 1 o más se trata como 1.

Respuesta#

Una solicitud correcta devuelve 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
}
CampoTipoDescripción
statusinteger1 si todo va bien, 0 si la solicitud falló.
messagestringSuccess; en caso contrario, el error.
remindersarrayLos recordatorios de esta página, del más reciente al más antiguo. Vacío si la página está más allá del final.
totalintegerRecordatorios del espacio de trabajo, en todas las páginas.
pageintegerLa página devuelta.
page_sizeintegerSiempre 50.

Campos de cada recordatorio#

CampoTipoDescripción
idintegerEl ID del recordatorio. Úsalo con Cancelar recordatorio.
namestringEl nombre del recordatorio, o Unnamed Reminder si no tiene.
to_numberstringNúmero de teléfono o nombre del grupo al que se envía el recordatorio.
message_templatestringEl mensaje, con las variables de plantilla aún sin rellenar.
msg_typeinteger0 texto, 1 imagen, 2 archivo.
msg_type_displaystringText, Image o File.
img_urlstring or nullURL de la imagen en los recordatorios con imagen, o la URL del archivo en los recordatorios con archivo creados a través de la API. En los demás casos puede estar vacío o ser null.
file_namestring or nullEn los recordatorios con archivo: la URL del archivo (recordatorios creados en el panel) o el nombre del archivo (recordatorios creados a través de la API, cuya URL está en img_url). En los demás casos puede estar vacío o ser null.
cron_expressionstringLa programación. Consulta Expresiones cron.
next_runstringLa próxima vez que se cumple la programación, como YYYY-MM-DD HH:MM:SS UTC, o Invalid cron si la expresión no se puede leer. Consulta el aviso de abajo.
is_activebooleantrue si el recordatorio está en marcha, false si está pausado.
whatsapp_client_idinteger or nullEl número de WhatsApp desde el que se envía, o null si usa el primer número conectado.
created_atstringCuándo se creó el recordatorio, en UTC, como YYYY-MM-DD HH:MM:SS.

Errores#

Los errores devuelven HTTP 400 con status con valor 0, salvo que se indique lo contrario:

{ "status": 0, "message": "Upgrade your plan to use reminders feature" }
MensajeCómo solucionarlo
Invalid JSON format: …El cuerpo JSON no es válido. También recibes este error en una solicitud GET o en una solicitud de formulario sin client_id.
Auth Error - Please send correct API key and Client idEnvía client_id y api_key.
Invalid client idEnvía client_id como número.
Auth Error: invalid api keyLa clave pertenece a otro client_id.
Auth Error: please check client idLa clave no está vinculada a ningún espacio de trabajo. Crea una clave nueva en el espacio de trabajo que quieras usar.
Demo Account cannot access APIsUsa una cuenta normal.
Upgrade your plan to use reminders featureTu plan no incluye recordatorios. Mejora tu plan. Los recordatorios existentes siguen ejecutándose y consumiendo créditos después de bajar de plan, y no se pueden listar, cancelar ni pausar hasta que mejores tu plan.
Error fetching reminders: … (HTTP 500)Algo falló por nuestra parte. Vuelve a intentarlo.

Si el api_key no existe o se ha eliminado, la respuesta es una página de error HTML con HTTP 500 en lugar de JSON. Prueba tu clave con Comprobar credenciales.

Leer todas las páginas#

Sigue pidiendo la página siguiente hasta que una página tenga menos de 50 recordatorios.

Obtener todos los recordatorios
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")

Consejos#

  • Guarda tu propia copia de la timezone de cada recordatorio al crearlo, ya que este endpoint no la devuelve.
  • Encuentra los recordatorios pausados filtrando por is_active igual a false. Reanúdalos en la página de Recordatorios.
  • Limpia las automatizaciones antiguas: primero reúne en todas las páginas los IDs que quieras cancelar y luego llama a Cancelar recordatorio para cada uno. Si cancelas mientras recorres las páginas, los recordatorios posteriores se desplazan a páginas anteriores y algunos se omiten.