API peringatan
API Batal Peringatan
Hentikan peringatan berulang supaya ia tidak dijalankan lagi. Gunakannya apabila pelanggan membuat bayaran, langganan tamat atau automasi tidak lagi diperlukan.
https://wbiztool.com/api/v1/reminder/cancel/Body: JSON atau medan borang
Anda memerlukan reminder_id yang dipulangkan oleh Cipta peringatan. Jika anda tidak memilikinya, cari dengan Senarai peringatan.
Contoh ringkas#
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'];
}Gantikan 12345 dan YOUR_API_KEY dengan nilai anda sendiri. Lihat Pengesahan identiti untuk mengetahui di mana nilai ini boleh didapati.
Parameter permintaan#
client_idintegerwajibAPI Client ID anda dari Settings → API keys (Tetapan → Kunci API).
api_keystringwajibKunci API anda dari halaman yang sama.
reminder_idstringwajibID peringatan yang hendak dibatalkan, seperti yang dipulangkan oleh Cipta peringatan atau Senarai peringatan. Ia mesti milik ruang kerja yang sama dengan kunci API.
Menghantar medan borang mengelakkan masalah ini, kerana setiap nilai borang ialah rentetan:
curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
-d client_id=12345 \
-d api_key=YOUR_API_KEY \
-d reminder_id=3187
Respons#
Permintaan yang berjaya memulangkan HTTP 200:
{
"message": "Reminder cancelled successfully",
"status": 1
}
| Medan | Jenis | Penerangan |
|---|---|---|
status | integer | 1 jika peringatan telah dibatalkan, 0 jika permintaan gagal. |
message | string | Reminder cancelled successfully, jika tidak, mesej ralat. |
Ralat#
Ralat memulangkan HTTP 400 dengan status ditetapkan kepada 0, kecuali dinyatakan sebaliknya:
{ "status": 0, "message": "Reminder not found" }
| Mesej | Cara membetulkannya |
|---|---|
Invalid JSON format: … | Badan JSON tidak sah. Anda juga menerima ralat ini untuk permintaan borang tanpa client_id, atau untuk sebarang permintaan GET. |
Reminder ID cannot be null | Tambah reminder_id. |
Auth Error - Please send correct API key and Client id | Hantar kedua-dua client_id dan api_key. |
Invalid client id | Hantar client_id sebagai nombor. |
Invalid reminder id | reminder_id mesti nombor bulat, seperti 3187. |
Auth Error: invalid api key | Kunci itu milik client_id yang lain. |
Auth Error: please check client id | Kunci tidak dipautkan ke mana-mana ruang kerja. Cipta kunci baharu dalam ruang kerja yang anda mahu gunakan. |
Demo Account cannot access APIs | Gunakan akaun biasa. |
Upgrade your plan to use reminders feature | Pelan anda tidak termasuk peringatan. Peringatan yang dicipta sebelum ini terus dijalankan dan menggunakan kredit, dan ia tidak boleh dibatalkan atau dijeda, sama ada melalui API atau papan pemuka, sehingga anda menaik taraf. |
Reminder not found (HTTP 404) | ID tidak wujud, berada dalam ruang kerja lain, atau peringatan telah pun dibatalkan. |
Error cancelling reminder: … (HTTP 500) | Berlaku masalah di pihak kami. Cuba lagi. |
Jika api_key tidak wujud atau telah dipadam, respons ialah halaman ralat HTML dengan HTTP 500 dan bukannya JSON. Uji kunci anda dengan Semak kelayakan.
Kesan pembatalan#
- Peringatan berhenti serta-merta dan tidak akan dijalankan lagi. Peringatan yang dijeda juga boleh dibatalkan.
- Ia hilang daripada Senarai peringatan dan halaman Reminders (Peringatan).
- Peringatan yang dibatalkan tidak boleh dipulihkan. Untuk bermula semula, cipta peringatan baharu.
- Mesej yang telah dimasukkan ke dalam baris gilir oleh peringatan sebelum anda membatalkannya tidak dibuang dan mungkin masih dihantar.
Petua#
- Membatalkan dua kali memulangkan
Reminder not found. Jika anda mencuba semula permintaan, anggap mesej itu sebagai „telah dibatalkan”. - Menjeda tidak tersedia melalui API. Untuk menghentikan peringatan buat sementara, jeda di halaman Reminders.
- Menukar jadual: tiada API kemas kini. Batalkan peringatan dan cipta yang baharu dengan
cron_expressionyang baharu.
