İçeriğe geç
WbizTool

Hatırlatıcılar API'si

Hatırlatıcı iptal etme API'si

Tekrarlanan bir hatırlatıcıyı bir daha hiç çalışmayacak şekilde durdurun. Bir müşteri ödeme yaptığında, bir abonelik sona erdiğinde veya bir otomasyona artık gerek kalmadığında kullanın.

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

Gövde: JSON veya form alanları

Hatırlatıcı oluşturma tarafından döndürülen reminder_id değerine ihtiyacınız vardır. Elinizde yoksa Hatırlatıcıları listeleme ile bulun.

Hızlı örnek#

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"
  }'

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#

AuthorizationheaderÖnerilir

Bearer YOUR_API_KEY: Ayarlar → API anahtarları sayfasındaki API anahtarınız. Bu başlıkla client_id ve api_key gövdeden çıkarılabilir; ikisi birden gönderilirse başlıktaki geçerli anahtar kullanılır. Bkz. Anahtarı başlıkta gönderin.

client_idintegerAuthorization başlığı olmadan

Ayarlar → API anahtarları sayfasındaki API Client ID'niz. Başlıkla isteğe bağlıdır; gönderirseniz anahtarın çalışma alanına ait olmalıdır.

api_keystringAuthorization başlığı olmadan

Aynı sayfadaki API anahtarınız; başlıkta göndermediğinizde.

reminder_idstringzorunlu

İptal edilecek hatırlatıcının ID'si; Hatırlatıcı oluşturma veya Hatırlatıcıları listeleme tarafından döndürüldüğü şekilde. API anahtarıyla aynı çalışma alanına ait olmalıdır.

JSON yerine form alanları da gönderebilirsiniz:

curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
  -d client_id=12345 \
  -d api_key=YOUR_API_KEY \
  -d reminder_id=3187

Yanıt#

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

{
  "message": "Reminder cancelled successfully",
  "status": 1
}
AlanTürAçıklama
statusintegerHatırlatıcı iptal edildiyse 1, istek başarısız olduysa 0.
messagestringReminder cancelled successfully, aksi halde hata mesajı.

Hatalar#

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

{ "status": 0, "message": "Reminder not found" }
MesajNasıl düzeltilir
Invalid JSON format: …JSON gövdesi geçerli değil. Bunu client_id olmayan bir form isteğinde veya herhangi bir GET isteğinde de alırsınız.
Reminder ID cannot be nullreminder_id ekleyin.
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.
Invalid reminder idreminder_id, 3187 gibi bir tam sayı olmalıdır.
Auth Error: invalid api keyAnahtar mevcut değil, silinmiş veya farklı bir client_id değerine ait. Anahtarınızı Kimlik bilgilerini kontrol etme ile test edin.
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. Daha önce oluşturulmuş hatırlatıcılar çalışmaya ve mesaj göndermeye devam eder; planınızı yükseltene kadar API veya panel üzerinden iptal edilemez ya da duraklatılamazlar.
Reminder not found (HTTP 404)ID mevcut değil, başka bir çalışma alanında veya hatırlatıcı zaten iptal edilmiş.
Error cancelling reminder: … (HTTP 500)Bizim tarafımızda bir sorun oluştu. Tekrar deneyin.

İptal etmek ne yapar#

  • Hatırlatıcı hemen durur ve bir daha çalışmaz. Duraklatılmış hatırlatıcılar da iptal edilebilir.
  • Hatırlatıcıları listeleme sonuçlarından ve Hatırlatıcılar sayfasından kaybolur.
  • İptal edilen bir hatırlatıcı geri yüklenemez. Yeniden başlamak için yeni bir hatırlatıcı oluşturun.
  • Hatırlatıcının siz iptal etmeden önce kuyruğa aldığı bir mesaj kaldırılmaz ve yine de gönderilebilir.

İpuçları#

  • İki kez iptal etmek Reminder not found döndürür. İstekleri yeniden deniyorsanız bu mesajı „zaten iptal edildi" olarak değerlendirin.
  • Duraklatma API üzerinden yapılamaz. Bir hatırlatıcıyı geçici olarak durdurmak için bunun yerine Hatırlatıcılar sayfasında duraklatın.
  • Zamanlamayı değiştirme: güncelleme API'si yoktur. Hatırlatıcıyı iptal edin ve yeni cron_expression ile yeni bir hatırlatıcı oluşturun.