İçeriğe geç
WbizTool

API v2 (beta)

Abonelikten çıkanlar

Abonelikten çıkan kişi, çalışma alanınızın mesajlarını istemeyen biridir. Abonelikten çıkmış bir numaraya asla hiçbir şey gönderilmez: ona gönderilen yeni bir mesaj reddedilir ve daha önce kuyruğa alınmış mesajlar gönderilmek yerine Opted out hatasıyla başarısız olur. Bu, her gönderim yolunda geçerlidir: API (v1 ve v2), panel, kampanyalar, şablon mesajlar, hatırlatıcılar, Google Sheets ve Shopify.

Liste, paneldeki Kişiler sayfasının Abonelikten çıkanlar sekmesiyle aynıdır.

İşlemEndpointKapsam
Bir numarayı abonelikten çıkarınPOST /api/v2/opt-outscontacts
Abonelikten çıkanları listeleyinGET /api/v2/opt-outscontacts
Bir kaydı alınGET /api/v2/opt-outs/{phone}contacts
Bir numarayı yeniden abone edinDELETE /api/v2/opt-outs/{phone}contacts

STOP yanıtları sizin için eklenir#

Biri gelen kutusu numaralarınızdan birine yalnızca bir abonelikten çıkma kelimesinden oluşan bir mesajla yanıt verdiğinde kendiliğinden abonelikten çıkar; source değeri reply olur ve mesajı keyword olarak kaydedilir. Yalnızca START (veya Subscribe) olan bir mesaj onu yeniden abone eder.

  • Kelimeler, büyük veya küçük harfle, noktalama işaretli ya da işaretsiz: STOP, Stop all, Unsubscribe, Opt out, Baja, Parar, Sair, Stopp, Abmelden, Arrêt, Désabonner, Basta, Disiscrivi, Стоп, Отписаться, Berhenti, Dur, توقف, إلغاء الاشتراك, עצור, הסר.
  • Yalnızca sadece kelimeden oluşan bir mesaj sayılır: "lütfen bana fiyat listesini göndermeyi durdurun" kimseyi abonelikten çıkarmaz.
  • Yanıt verdikleri numarada gelen kutusu açık olmalıdır, çünkü gelen mesajları yalnızca gelen kutusu numaraları okur. Bir gelen kutusu numarası eklendiğinde okunanlar gibi 7 günden eski yanıtlar sayılmaz.
  • Onlara hiçbir şey geri gönderilmez ve hiçbir otomatik yanıt STOP mesajını yanıtlamaz.

Bir numarayı abonelikten çıkarın#

POSThttps://wbiztool.com/api/v2/opt-outs

Gövde: JSON (application/json)

Gövde

phonestringzorunlu

+ ile uluslararası biçimde numara (+919876543210). Boşluklar, tireler ve parantezler yok sayılır. Bir Telegram @username da çalışır.

notestringisteğe bağlı

Ekibiniz için neden, en fazla 200 karakter. Abonelikten çıkanlar sekmesinde gösterilir.

curl -X POST https://wbiztool.com/api/v2/opt-outs \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone": "+919876543210", "note": "Asked by email"}'

Yanıt: abonelikten çıkma kaydı ile birlikte 201. Zaten abonelikten çıkmış bir numara, mevcut kaydıyla ve hiçbir şey değiştirmeden 200 ile yanıt verir.

{
  "recipient": "+919876543210",
  "source": "api",
  "keyword": null,
  "note": "Asked by email",
  "created_at": "2026-10-26T09:12:03.120Z"
}

Hatalar#

HTTPKodNe zaman
400validation_failednote metin değil veya 200 karakterden uzun
422invalid_phonephone eksik veya bir telefon numarası değil

Abonelikten çıkanları listeleyin#

GEThttps://wbiztool.com/api/v2/opt-outs

Abonelikten çıkan herkes, en yeniden başlayarak sayfalar halinde (limit 1 ile 100 arası, varsayılan 25, ve cursor). Tek bir numarayı aramak için phone ekleyin.

curl "https://wbiztool.com/api/v2/opt-outs?limit=100" \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
  "data": [
    { "recipient": "+919876543210", "source": "reply", "keyword": "STOP", "note": null, "created_at": "2026-10-26T09:12:03.120Z" }
  ],
  "next_cursor": null
}

Bir kaydı alın#

GEThttps://wbiztool.com/api/v2/opt-outs/{phone}

Adresteki numara, + olmadan uluslararası biçimdedir (919876543210). Numara abonelikten çıkmamışsa 404 opt_out_not_found ile yanıt verir; bu yüzden göndermeden önce hızlı bir kontroldür.

curl https://wbiztool.com/api/v2/opt-outs/919876543210 \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"

Bir numarayı yeniden abone edin#

DELETEhttps://wbiztool.com/api/v2/opt-outs/{phone}

Numaraya gönderilen mesajlar bundan sonra yeniden gider. Opted out olarak zaten başarısız olmuş mesajlar başarısız kalır. Bunu yalnızca kişi mesajlarınızı yeniden istediğinde yapın.

curl -X DELETE https://wbiztool.com/api/v2/opt-outs/919876543210 \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{ "recipient": "+919876543210", "deleted": true }

Abonelikten çıkmamış bir numara 404 opt_out_not_found ile yanıt verir.

Abonelikten çıkmış bir numaraya gönderim#

  • POST /messages 422 recipient_opted_out ile yanıt verir ve hiçbir şey kuyruğa alınmaz. Toplu gönderimde toplu gönderimin tamamı reddedilir ve hatanın field alanı ilgili öğeyi belirtir.
  • Kişi abonelikten çıkmadan önce kuyruğa alınmış bir mesaj, sırası geldiğinde error değeri Opted out ile başarısız olur ve bir webhook message.failed alır.
  • API v1 mesajı kuyruğa alır ve mesaj, mesaj durumunda göreceğiniz gibi Opted out ile başarısız olur.
  • Kampanyalardaki Başarısızları tekrar dene bu mesajları atlar.

Opt-out nesnesi#

AlanTürAçıklama
recipientstring+ ve numara ya da bir Telegram @username
sourcestringreply: bir gelen kutusu numarasına STOP yanıtı verdi. dashboard: Kişiler sayfasında eklendi. import: Kişiler sayfasında bir CSV'den. api: bu API
keywordstring veya nullOnu abonelikten çıkaran yanıt, yazdığı şekliyle
notestring veya nullEkibinizin notu
created_atstringAbonelikten çıktığı zaman (ISO 8601, UTC)

İlgili sayfalar#