انتقل إلى المحتوى
Wbiztool

API التذكيرات

API عرض التذكيرات

احصل على التذكيرات في مساحة العمل الخاصة بك، 50 تذكيرًا في كل مرة، من الأحدث إلى الأقدم. استخدمه للعثور على معرّفات التذكيرات، أو لمراجعة عمليات الأتمتة لديك، أو لنسخها احتياطيًا.

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

النص (Body): JSON أو حقول نموذج

لا تقبل نقطة النهاية هذه إلا POST. طلب GET، حتى مع سلسلة استعلام (query string)، يُرجع 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 ‏(API Client ID) من Settings → API keys (الإعدادات ← مفاتيح 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
}
الحقلالنوعالوصف
statusinteger‏1 عند النجاح، و0 إذا فشل الطلب.
messagestring‏Success، وإلا نص الخطأ.
remindersarrayالتذكيرات في هذه الصفحة، من الأحدث إلى الأقدم. تكون فارغة إذا كانت الصفحة بعد النهاية.
totalintegerعدد التذكيرات في مساحة العمل، عبر كل الصفحات.
pageintegerالصفحة المُرجَعة.
page_sizeintegerدائمًا 50.

حقول التذكير#

الحقلالنوعالوصف
idintegerمعرّف التذكير. استخدمه مع إلغاء تذكير.
namestringاسم التذكير، أو Unnamed Reminder إذا لم يكن له اسم.
to_numberstringرقم الهاتف أو اسم المجموعة الذي يُرسَل إليه التذكير.
message_templatestringالرسالة، مع متغيرات القالب قبل ملئها.
msg_typeinteger‏0 نص، و1 صورة، و2 ملف.
msg_type_displaystring‏Text أو Image أو File.
img_urlstring or nullعنوان URL للصورة في تذكيرات الصور، أو عنوان 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_activeboolean‏true إذا كان التذكير يعمل، و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. اختبر مفتاحك باستخدام التحقق من بيانات الاعتماد.

قراءة كل الصفحات#

واصل طلب الصفحة التالية حتى تحصل على صفحة تحتوي على أقل من 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 لكل تذكير عند إنشائه، لأن نقطة النهاية هذه لا تُرجعها.
  • اعثر على التذكيرات الموقوفة مؤقتًا بالتصفية على is_active بقيمة false. استأنفها من صفحة التذكيرات.
  • نظّف عمليات الأتمتة القديمة: اجمع أولًا المعرّفات التي تريد إلغاءها من كل الصفحات، ثم استدعِ إلغاء تذكير لكل منها. الإلغاء أثناء التنقل بين الصفحات ينقل التذكيرات اللاحقة إلى صفحات سابقة، فيُتخطّى بعضها.