API التذكيرات
API إلغاء تذكير
أوقف تذكيرًا متكررًا حتى لا يُشغَّل مرة أخرى أبدًا. استخدمه عندما يدفع العميل، أو ينتهي اشتراك، أو لم تعد هناك حاجة إلى عملية أتمتة.
https://wbiztool.com/api/v1/reminder/cancel/النص (Body): JSON أو حقول نموذج
تحتاج إلى قيمة reminder_id التي يُرجعها إنشاء تذكير. إذا لم تكن لديك، فاعثر عليها باستخدام عرض التذكيرات.
مثال سريع#
curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
-H "Content-Type: application/json" \
-d '{
"client_id": 12345,
"api_key": "YOUR_API_KEY",
"reminder_id": "3187"
}'import requests
reminder_id = 3187
response = requests.post(
"https://wbiztool.com/api/v1/reminder/cancel/",
json={
"client_id": 12345,
"api_key": "YOUR_API_KEY",
"reminder_id": str(reminder_id), # must be a string in JSON
},
timeout=60,
)
try:
result = response.json() # read the body even when the HTTP code is 400 or 404
except ValueError:
raise SystemExit(f"HTTP {response.status_code}: not JSON. Check that your api_key exists.")
if result["status"] == 1:
print("Reminder cancelled")
else:
print("Failed:", result["message"])// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const reminderId = 3187;
const response = await fetch("https://wbiztool.com/api/v1/reminder/cancel/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
client_id: 12345,
api_key: "YOUR_API_KEY",
reminder_id: String(reminderId), // must be a string in JSON
}),
});
// Read the body even when the HTTP code is 400 or 404. A non-JSON reply means the request crashed.
const text = await response.text();
let result;
try {
result = JSON.parse(text);
} catch {
throw new Error(`HTTP ${response.status}: not JSON. Check your api_key and send reminder_id as a string.`);
}
if (result.status === 1) {
console.log("Reminder cancelled");
} else {
console.error("Failed:", result.message);
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
'reminder_id' => (string) 3187, // must be a string in JSON
];
$ch = curl_init('https://wbiztool.com/api/v1/reminder/cancel/');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
]);
$result = json_decode(curl_exec($ch), true);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($result === null) {
echo "HTTP $httpCode: not JSON. Check your api_key and send reminder_id as a string.";
} elseif ($result['status'] === 1) {
echo 'Reminder cancelled';
} else {
echo 'Failed: ' . $result['message'];
}استبدل 12345 وYOUR_API_KEY بقيمك الخاصة. راجع المصادقة لمعرفة مكان العثور عليها.
معاملات الطلب#
client_idintegerمطلوبمعرّف العميل في API (API Client ID) من Settings → API keys (الإعدادات ← مفاتيح API).
api_keystringمطلوبمفتاح API الخاص بك من الصفحة نفسها.
reminder_idstringمطلوبمعرّف التذكير المراد إلغاؤه، كما يُرجعه إنشاء تذكير أو عرض التذكيرات. يجب أن ينتمي إلى مساحة العمل نفسها التي ينتمي إليها مفتاح API.
إرسال حقول النموذج يتجنب هذه المشكلة، لأن كل قيمة في النموذج نص:
curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
-d client_id=12345 \
-d api_key=YOUR_API_KEY \
-d reminder_id=3187
الاستجابة#
يُرجع الطلب الناجح HTTP 200:
{
"message": "Reminder cancelled successfully",
"status": 1
}
| الحقل | النوع | الوصف |
|---|---|---|
status | integer | 1 إذا أُلغي التذكير، و0 إذا فشل الطلب. |
message | string | Reminder cancelled successfully، وإلا نص الخطأ. |
الأخطاء#
تُرجع الأخطاء HTTP 400 مع status بقيمة 0، ما لم يُذكر خلاف ذلك:
{ "status": 0, "message": "Reminder not found" }
| الرسالة | طريقة الإصلاح |
|---|---|
Invalid JSON format: … | جسم JSON غير صالح. تحصل على هذا الخطأ أيضًا مع طلب نموذج بدون client_id، أو مع أي طلب GET. |
Reminder ID cannot be null | أضف reminder_id. |
Auth Error - Please send correct API key and Client id | أرسل client_id وapi_key كليهما. |
Invalid client id | أرسل client_id كرقم. |
Invalid reminder id | يجب أن تكون قيمة reminder_id عددًا صحيحًا، مثل 3187. |
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 | باقتك لا تتضمن التذكيرات. تستمر التذكيرات التي أُنشئت سابقًا في العمل واستهلاك الرصيد، ولا يمكن إلغاؤها أو إيقافها مؤقتًا، لا عبر API ولا من لوحة التحكم، حتى تقوم بالترقية. |
Reminder not found (HTTP 404) | المعرّف غير موجود، أو موجود في مساحة عمل أخرى، أو أن التذكير أُلغي بالفعل. |
Error cancelling reminder: … (HTTP 500) | حدث خطأ من جانبنا. حاول مرة أخرى. |
إذا كان api_key غير موجود أو حُذف، فستكون الاستجابة صفحة خطأ بصيغة HTML مع HTTP 500 بدلًا من JSON. اختبر مفتاحك باستخدام التحقق من بيانات الاعتماد.
ماذا يفعل الإلغاء#
- يتوقف التذكير فورًا ولن يُشغَّل مرة أخرى. ويمكن إلغاء التذكيرات الموقوفة مؤقتًا أيضًا.
- يختفي من عرض التذكيرات ومن صفحة التذكيرات.
- لا يمكن استعادة التذكير الملغى. للبدء من جديد، أنشئ تذكيرًا جديدًا.
- الرسالة التي وضعها التذكير في قائمة الانتظار قبل إلغائه لا تُحذف، وقد تُرسَل رغم ذلك.
نصائح#
- الإلغاء مرتين يُرجع
Reminder not found. إذا كنت تعيد محاولة الطلبات، فاعتبر هذه الرسالة بمعنى «أُلغي بالفعل». - الإيقاف المؤقت غير متاح عبر API. لإيقاف تذكير مؤقتًا، أوقفه من صفحة التذكيرات بدلًا من ذلك.
- تغيير الجدول الزمني: لا يوجد API للتحديث. ألغِ التذكير وأنشئ تذكيرًا جديدًا بقيمة
cron_expressionالجديدة.
