Langkau ke kandungan
WbizTool

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.

POSThttps://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"
  }'

Gantikan 12345 dan YOUR_API_KEY dengan nilai anda sendiri. Lihat Pengesahan identiti untuk mengetahui di mana nilai ini boleh didapati.

Parameter permintaan#

AuthorizationheaderDisyorkan

Bearer YOUR_API_KEY: kunci API anda dari Tetapan → Kunci API. Dengan pengepala ini, client_id dan api_key boleh ditinggalkan daripada badan; jika kedua-duanya dihantar, kunci sah dalam pengepala yang digunakan. Lihat Hantar kunci dalam pengepala.

client_idintegerTanpa pengepala Authorization

API Client ID anda dari Tetapan → Kunci API. Pilihan dengan pengepala; jika anda menghantarnya, ia mestilah Client ID ruang kerja kunci itu.

api_keystringTanpa pengepala Authorization

Kunci API anda dari halaman yang sama, apabila anda tidak menghantarnya dalam pengepala.

reminder_idstringwajib

ID peringatan yang hendak dibatalkan, seperti yang dipulangkan oleh Cipta peringatan atau Senarai peringatan. Ia mesti milik ruang kerja yang sama dengan kunci API.

Anda juga boleh menghantar medan borang dan bukannya JSON:

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
}
MedanJenisPenerangan
statusinteger1 jika peringatan telah dibatalkan, 0 jika permintaan gagal.
messagestringReminder 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" }
MesejCara 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 nullTambah reminder_id.
Auth Error - Please send correct API key and Client idHantar kedua-dua client_id dan api_key.
Invalid client idHantar client_id sebagai nombor.
Invalid reminder idreminder_id mesti nombor bulat, seperti 3187.
Auth Error: invalid api keyKunci itu tidak wujud, telah dipadam atau milik client_id yang lain. Uji kunci anda dengan Semak kelayakan.
Auth Error: please check client idKunci tidak dipautkan ke mana-mana ruang kerja. Cipta kunci baharu dalam ruang kerja yang anda mahu gunakan.
Demo Account cannot access APIsGunakan akaun biasa.
Upgrade your plan to use reminders featurePelan anda tidak termasuk peringatan. Peringatan yang dicipta sebelum ini terus dijalankan dan menghantar mesej, 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.

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_expression yang baharu.