Aller au contenu
Wbiztool

API des rappels

API de liste des rappels

Obtenez les rappels de votre espace de travail, 50 à la fois, des plus récents aux plus anciens. Utilisez-la pour retrouver les ID de vos rappels, auditer vos automatisations ou les sauvegarder.

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

Corps: JSON ou champs de formulaire

Cet endpoint n'accepte que POST. Une requête GET, même avec une chaîne de requête, renvoie le code HTTP 400 avec Invalid JSON format: Expecting value….

La liste inclut les rappels actifs et en pause de tout l'espace de travail, qu'ils aient été créés via l'API ou sur la page Rappels. Les rappels annulés ne sont pas inclus.

Exemple rapide#

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

Remplacez 12345 et YOUR_API_KEY par vos propres valeurs. Consultez Authentification pour savoir où les trouver.

Paramètres de la requête#

client_idintegerobligatoire

Votre ID client API, dans Paramètres → Clés API.

api_keystringobligatoire

Votre clé API, sur cette même page.

pageintegerfacultatif

Numéro de page, à partir de 1 (valeur par défaut). Chaque page contient 50 rappels, et cette taille ne peut pas être modifiée. Une valeur qui n'est pas un nombre entier supérieur ou égal à 1 est traitée comme 1.

Réponse#

Une requête réussie renvoie le code 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
}
ChampTypeDescription
statusinteger1 en cas de succès, 0 si la requête a échoué.
messagestringSuccess, sinon l'erreur.
remindersarrayLes rappels de cette page, des plus récents aux plus anciens. Vide si la page se situe au-delà de la fin.
totalintegerNombre de rappels dans l'espace de travail, toutes pages confondues.
pageintegerLa page renvoyée.
page_sizeintegerToujours 50.

Champs d'un rappel#

ChampTypeDescription
idintegerL'ID du rappel. Utilisez-le avec Annuler un rappel.
namestringLe nom du rappel, ou Unnamed Reminder s'il n'en a pas.
to_numberstringNuméro de téléphone ou nom du groupe auquel le rappel est envoyé.
message_templatestringLe message, avec les variables de modèle non encore remplies.
msg_typeinteger0 texte, 1 image, 2 fichier.
msg_type_displaystringText, Image ou File.
img_urlstring or nullURL de l'image pour les rappels avec image, ou URL du fichier pour les rappels avec fichier créés via l'API. Peut être vide ou null sinon.
file_namestring or nullPour les rappels avec fichier : l'URL du fichier (rappels créés dans le tableau de bord) ou le nom du fichier (rappels créés via l'API, dont l'URL se trouve dans img_url). Peut être vide ou null sinon.
cron_expressionstringLa planification. Consultez Expressions cron.
next_runstringProchaine date à laquelle la planification correspond, au format YYYY-MM-DD HH:MM:SS UTC, ou Invalid cron si l'expression ne peut pas être lue. Consultez l'avertissement ci-dessous.
is_activebooleantrue si le rappel est actif, false s'il est en pause.
whatsapp_client_idinteger or nullLe numéro WhatsApp depuis lequel il est envoyé, ou null s'il utilise le premier numéro connecté.
created_atstringDate de création du rappel, en UTC, au format YYYY-MM-DD HH:MM:SS.

Erreurs#

Les erreurs renvoient le code HTTP 400 avec status à 0, sauf indication contraire :

{ "status": 0, "message": "Upgrade your plan to use reminders feature" }
MessageComment corriger
Invalid JSON format: …Le corps JSON n'est pas valide. Vous obtenez aussi ce message pour une requête GET ou une requête de formulaire sans client_id.
Auth Error - Please send correct API key and Client idEnvoyez à la fois client_id et api_key.
Invalid client idEnvoyez client_id sous forme de nombre.
Auth Error: invalid api keyLa clé appartient à un autre client_id.
Auth Error: please check client idLa clé n'est liée à aucun espace de travail. Créez une nouvelle clé dans l'espace de travail que vous souhaitez utiliser.
Demo Account cannot access APIsUtilisez un compte standard.
Upgrade your plan to use reminders featureVotre forfait n'inclut pas les rappels. Passez à un forfait supérieur. Après un passage à un forfait inférieur, les rappels existants continuent de s'exécuter et de consommer des crédits, et ne peuvent être ni listés, ni annulés, ni suspendus tant que vous ne repassez pas à un forfait supérieur.
Error fetching reminders: … (HTTP 500)Un problème est survenu de notre côté. Réessayez.

Si l'api_key n'existe pas ou a été supprimée, la réponse est une page d'erreur HTML avec le code HTTP 500 au lieu de JSON. Testez votre clé avec Vérifier les identifiants.

Lire toutes les pages#

Demandez la page suivante jusqu'à obtenir une page contenant moins de 50 rappels.

Récupérer tous les rappels
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")

Conseils#

  • Conservez votre propre copie du timezone de chaque rappel lors de sa création, car cet endpoint ne le renvoie pas.
  • Retrouvez les rappels en pause en filtrant sur is_active à false. Réactivez-les sur la page Rappels.
  • Faites le ménage dans vos anciennes automatisations : collectez d'abord, sur toutes les pages, les ID que vous souhaitez annuler, puis appelez Annuler un rappel pour chacun. Annuler pendant la pagination décale les rappels suivants vers des pages précédentes, si bien que certains sont ignorés.