Перейти к содержимому
Wbiztool

API напоминаний

API списка напоминаний

Получайте напоминания вашего рабочего пространства по 50 штук, начиная с самых новых. Используйте этот API, чтобы находить ID напоминаний, проверять свои автоматизации или создавать их резервные копии.

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

Тело запроса: JSON или поля формы

Этот endpoint принимает только POST. Запрос GET, даже со строкой запроса, возвращает HTTP 400 с Invalid JSON format: Expecting value….

Список включает активные и приостановленные напоминания всего рабочего пространства — созданные как через API, так и на странице Напоминания. Отменённые напоминания не включаются.

Быстрый пример#

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

Замените 12345 и YOUR_API_KEY своими значениями. Где их найти, описано в разделе Аутентификация.

Параметры запроса#

client_idintegerобязательно

Ваш API Client ID из раздела Настройки → API ключи.

api_keystringобязательно

Ваш API-ключ с той же страницы.

pageintegerнеобязательно

Номер страницы, начиная с 1 (по умолчанию). На каждой странице 50 напоминаний, размер страницы изменить нельзя. Значение, не являющееся целым числом от 1 и больше, считается 1.

Ответ#

Успешный запрос возвращает 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
}
ПолеТипОписание
statusinteger1 при успехе, 0, если запрос не выполнен.
messagestringSuccess, иначе текст ошибки.
remindersarrayНапоминания на этой странице, начиная с самых новых. Пустой, если страница за пределами списка.
totalintegerЧисло напоминаний в рабочем пространстве на всех страницах.
pageintegerВозвращённая страница.
page_sizeintegerВсегда 50.

Поля напоминания#

ПолеТипОписание
idintegerID напоминания. Используйте его в API отмены напоминаний.
namestringНазвание напоминания или Unnamed Reminder, если названия нет.
to_numberstringНомер телефона или название группы, куда отправляется напоминание.
message_templatestringТекст сообщения с ещё не заполненными переменными шаблона.
msg_typeinteger0 — текст, 1 — изображение, 2 — файл.
msg_type_displaystringText, Image или File.
img_urlstring or nullURL изображения для напоминаний с изображением или URL файла для напоминаний с файлом, созданных через API. В остальных случаях может быть пустым или null.
file_namestring or nullДля напоминаний с файлом: URL файла (напоминания, созданные в панели управления) или имя файла (напоминания, созданные через API, URL которых находится в img_url). В остальных случаях может быть пустым или null.
cron_expressionstringРасписание. См. раздел Выражения cron.
next_runstringСледующее срабатывание расписания в формате YYYY-MM-DD HH:MM:SS UTC или Invalid cron, если выражение не удаётся разобрать. См. предупреждение ниже.
is_activebooleantrue, если напоминание работает, false, если оно приостановлено.
whatsapp_client_idinteger or nullНомер WhatsApp, с которого оно отправляется, или null, если используется первый подключённый номер.
created_atstringКогда напоминание было создано, в UTC, в формате YYYY-MM-DD HH:MM:SS.

Ошибки#

Ошибки возвращаются с HTTP 400 и status, равным 0, если не указано иное:

{ "status": 0, "message": "Upgrade your plan to use reminders feature" }
СообщениеКак исправить
Invalid JSON format: …Тело JSON некорректно. Эта ошибка возвращается и для запроса GET или запроса с полями формы без client_id.
Auth Error - Please send correct API key and Client idПередайте и client_id, и api_key.
Invalid client idПередайте client_id числом.
Auth Error: invalid api keyКлюч принадлежит другому client_id.
Auth Error: please check client idКлюч не привязан к рабочему пространству. Создайте новый ключ в нужном рабочем пространстве.
Demo Account cannot access APIsИспользуйте обычный аккаунт.
Upgrade your plan to use reminders featureВаш тариф не включает напоминания. Повысьте тариф. После понижения тарифа существующие напоминания продолжают работать и расходовать кредиты, но их нельзя получить списком, отменить или приостановить, пока вы не повысите тариф.
Error fetching reminders: … (HTTP 500)Что-то пошло не так на нашей стороне. Повторите попытку.

Если api_key не существует или удалён, ответом будет HTML-страница ошибки с HTTP 500 вместо JSON. Проверьте свой ключ через API проверки учётных данных.

Чтение всех страниц#

Запрашивайте следующую страницу, пока на странице не окажется меньше 50 напоминаний.

Получение всех напоминаний
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")

Советы#

  • Храните собственную копию timezone каждого напоминания при его создании, так как этот endpoint его не возвращает.
  • Приостановленные напоминания находите, фильтруя по is_active, равному false. Возобновить их можно на странице Напоминания.
  • Очистка старых автоматизаций: сначала соберите со всех страниц ID напоминаний, которые хотите отменить, а затем вызовите API отмены напоминаний для каждого из них. Если отменять напоминания во время перебора страниц, последующие напоминания сдвигаются на более ранние страницы, и часть из них будет пропущена.