İçeriğe geç
Wbiztool

Hatırlatıcılar API'si

Hatırlatıcıları listeleme API'si

Çalışma alanınızdaki hatırlatıcıları, en yeniden başlayarak 50'şer adet alın. Hatırlatıcı ID'lerini bulmak, otomasyonlarınızı denetlemek veya yedeklemek için kullanın.

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

Gövde: JSON veya form alanları

Bu endpoint yalnızca POST kabul eder. Bir GET isteği, sorgu dizesiyle bile, Invalid JSON format: Expecting value… ile HTTP 400 döndürür.

Liste, API üzerinden veya Hatırlatıcılar sayfasından oluşturulmuş olmalarına bakılmaksızın tüm çalışma alanındaki etkin ve duraklatılmış hatırlatıcıları içerir. İptal edilen hatırlatıcılar dahil değildir.

Hızlı örnek#

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 ve YOUR_API_KEY değerlerini kendi değerlerinizle değiştirin. Bunları nerede bulacağınız için Kimlik doğrulama bölümüne bakın.

İstek parametreleri#

client_idintegerzorunlu

Ayarlar → API anahtarları sayfasındaki API Client ID'niz.

api_keystringzorunlu

Aynı sayfadaki API anahtarınız.

pageintegeristeğe bağlı

Sayfa numarası, 1 (varsayılan) ile başlar. Her sayfa 50 hatırlatıcı içerir ve sayfa boyutu değiştirilemez. 1 veya daha büyük bir tam sayı olmayan değer 1 olarak değerlendirilir.

Yanıt#

Başarılı bir istek HTTP 200 döndürür:

{
  "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
}
AlanTürAçıklama
statusintegerBaşarıda 1, istek başarısız olduysa 0.
messagestringSuccess, aksi halde hata mesajı.
remindersdiziBu sayfadaki hatırlatıcılar, en yeniden başlayarak. Sayfa sonun ötesindeyse boştur.
totalintegerTüm sayfalarda, çalışma alanındaki hatırlatıcılar.
pageintegerDöndürülen sayfa.
page_sizeintegerHer zaman 50.

Hatırlatıcı alanları#

AlanTürAçıklama
idintegerHatırlatıcı ID'si. Hatırlatıcı iptal etme ile kullanın.
namestringHatırlatıcının adı; adı yoksa Unnamed Reminder.
to_numberstringHatırlatıcının gönderildiği telefon numarası veya grup adı.
message_templatestringŞablon değişkenleri henüz doldurulmamış mesaj.
msg_typeinteger0 metin, 1 görsel, 2 dosya.
msg_type_displaystringText, Image veya File.
img_urlstring veya nullGörsel hatırlatıcılarda görsel URL'si veya API üzerinden oluşturulan dosya hatırlatıcılarında dosya URL'si. Diğer durumlarda boş veya null olabilir.
file_namestring veya nullDosya hatırlatıcılarında: dosya URL'si (panelde oluşturulan hatırlatıcılar) veya dosya adı (URL'si img_url içinde olan, API üzerinden oluşturulan hatırlatıcılar). Diğer durumlarda boş veya null olabilir.
cron_expressionstringZamanlama. Bkz. Cron ifadeleri.
next_runstringZamanlamanın bir sonraki eşleşme zamanı, YYYY-MM-DD HH:MM:SS UTC biçiminde; ifade okunamıyorsa Invalid cron. Aşağıdaki uyarıya bakın.
is_activebooleanHatırlatıcı çalışıyorsa true, duraklatılmışsa false.
whatsapp_client_idinteger veya nullGönderimin yapıldığı WhatsApp numarası; ilk bağlı numarayı kullanıyorsa null.
created_atstringHatırlatıcının oluşturulduğu zaman, UTC'de, YYYY-MM-DD HH:MM:SS biçiminde.

Hatalar#

Aksi belirtilmedikçe hatalar, status değeri 0 olarak HTTP 400 döndürür:

{ "status": 0, "message": "Upgrade your plan to use reminders feature" }
MesajNasıl düzeltilir
Invalid JSON format: …JSON gövdesi geçerli değil. Bunu bir GET isteğinde veya client_id olmayan bir form isteğinde de alırsınız.
Auth Error - Please send correct API key and Client idclient_id ve api_key değerlerinin ikisini de gönderin.
Invalid client idclient_id değerini sayı olarak gönderin.
Auth Error: invalid api keyAnahtar farklı bir client_id değerine ait.
Auth Error: please check client idAnahtar bir çalışma alanına bağlı değil. Kullanmak istediğiniz çalışma alanında yeni bir anahtar oluşturun.
Demo Account cannot access APIsNormal bir hesap kullanın.
Upgrade your plan to use reminders featurePlanınız hatırlatıcıları içermiyor. Planınızı yükseltin. Mevcut hatırlatıcılar plan düşürüldükten sonra çalışmaya ve kredi harcamaya devam eder; planınızı yükseltene kadar listelenemez, iptal edilemez veya duraklatılamazlar.
Error fetching reminders: … (HTTP 500)Bizim tarafımızda bir sorun oluştu. Tekrar deneyin.

api_key mevcut değilse veya silinmişse, yanıt JSON yerine HTTP 500 ile bir HTML hata sayfasıdır. Anahtarınızı Kimlik bilgilerini kontrol etme ile test edin.

Her sayfayı okuma#

Bir sayfa 50'den az hatırlatıcı içerene kadar sonraki sayfayı istemeye devam edin.

Tüm hatırlatıcıları getirme
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")

İpuçları#

  • Kendi kopyanızı saklayın: bu endpoint döndürmediği için, her hatırlatıcıyı oluştururken timezone değerini kendiniz kaydedin.
  • Duraklatılmış hatırlatıcıları bulun: is_active değeri false olanları filtreleyin. Onları Hatırlatıcılar sayfasında devam ettirin.
  • Eski otomasyonları temizleyin: önce iptal etmek istediğiniz ID'leri tüm sayfalardan toplayın, ardından her biri için Hatırlatıcı iptal etme endpoint'ini çağırın. Sayfalarken iptal etmek, sonraki hatırlatıcıları önceki sayfalara kaydırır ve bazıları atlanır.