Skip to main content
Engel kaydı, bir hastanın belirli bir kanaldan (örneğin bir WhatsApp numarası) size mesaj göndermesini durdurur. Kayıt bir hasta ile bir kanal çiftine aittir: aynı çift için tek kayıt bulunur. Engelli hastanın bu kanaldan gelen mesajları işlenmez. Panelde aynı liste Engellenen Kullanıcılar sayfasında görünür; ekranı için Engellenen kullanıcılar sayfasına bakın. Bu sayfa /v1/channel-blacklists endpoint’lerini anlatır. Kanal ve hasta kimlikleri için Kanallar ve Hastalar sayfalarına bakın.

Endpoint özeti

Tüm isteklerde Authorization ve X-Tenant başlıkları gerekir. Başlıklar için İstek başlıkları sayfasına bakın. İzin etiketleri rol editöründe Engellenen Numaralar grubunun altında görünür. Hangi kayıtları göreceğiniz izinlere bağlıdır; ayrıntı için İzinler ve görünürlük sayfasına bakın.
ViewAllChannelBlacklists:ChannelBlacklist (Tümünü Görüntüle) iznine sahip olmayan kullanıcı yalnızca kendisine atanmış lead’in hastasına ait kayıtları görür, günceller ve kaldırır. Diğer kayıtlar için 403 değil 404 döner.

Kayıt nesnesi

Sebep değerleri: Sistem, kısa sürede çok fazla mesaj gönderen numaraları rate_limit sebebiyle kendisi de engelleyebilir. Bu kayıtlar listede sizin açtığınız kayıtlarla birlikte görünür.

Listeleme

GET /v1/channel-blacklists sayfalı döner ve kayıtlarda channel ile customer bilgisi bulunur. Sayfalama için Sayfalama, sıralama kuralları için Filtreleme ve sıralama sayfasına bakın.

Engelleme

POST /v1/channel-blacklists bir hastayı bir kanalda engeller. Başarılı istek 201 ile kayıt nesnesini döner.
integer
gerekli
Klinik kanalının kimliği.
integer
gerekli
Hastanın kimliği.
string
gerekli
rate_limit, llm_spam, manual, security_threat veya abusive_language.
integer
Engelin süresi, saniye cinsinden (en az 1). Göndermezseniz veya null gönderirseniz engel süresiz olur.
string
En fazla 1000 karakter.
object
İsteğe bağlı ek veri.
curl
Yanıttan kısaltılmış bir örnek:
Yeni bir engel açıldığında, engellenen hastaya Engel Bilgilendirme (Genel) şablonuyla bir bilgilendirme mesajı gönderilir. Mesaj, seçtiğiniz sebebin açıklamasını içerir. Hastaya haber vermek istemiyorsanız engeli açmadan önce bunu göz önünde bulundurun.
Engelleme bir upsert gibi çalışır: aynı kanal ve hasta çifti için tekrar POST gönderirseniz yeni kayıt oluşmaz, mevcut kaydın id değeri döner. Silinmiş veya kaldırılmış kayıt yeniden etkinleşir. Mevcut süresiz bir kayda ttl_seconds ile tekrar istek gönderirseniz kayıt süreli olur. Mevcut süreli bir kayda yeni süre gönderirseniz, daha geç olan bitiş zamanı korunur. Yeni, yeniden etkinleşen veya daha önce kaldırılmış bir kayıt için ayrıca şunlar olur:
  • Hastanın bekleyen AI asistan işleri silinir.
  • CustomerBlacklisted olayı yayınlanır (bkz. Kanallar ve olaylar).

Süreli engel

Süreli engel için POST isteğinde ttl_seconds gönderin. Süre dolunca kayıt otomatik olarak is_active=false olur; sistem bunu düzenli aralıklarla temizler. Panelin süre seçenekleri ile karşılıkları: Mevcut bir kaydın süresini PUT ile de değiştirebilirsiniz:
curl
PUT istekleri hastaya bilgilendirme mesajı göndermez.

Engeli kaldırma

Engeli kaldırmanın iki yolu vardır:
1

DELETE ile

DELETE /v1/channel-blacklists/{id} çağrısı kaydı silmez, is_active değerini false yapar ve CustomerUnblacklisted olayını yayınlar. Yanıt: {"message": "Kanal kara liste kaydı başarıyla devre dışı bırakıldı"}.
2

PUT ile

PUT isteğinde is_active: false gönderin. Sonuç aynıdır: gerçek bir engel kaldırma çalışır ve CustomerUnblacklisted yayınlanır.
Her iki yol da Engeli Kaldır (Unblock:ChannelBlacklist) iznini ister. PUT ile kaldırmak için ayrıca Update:ChannelBlacklist gerekir. Yalnızca Sil iznine sahip olmak yetmez.
curl
Kaldırılmış kayıt listede is_active=false olarak kalır. Aynı hastayı aynı kanalda yeniden engellemek için POST göndermeniz yeterlidir; kayıt yeniden etkinleşir.

İzin listesi

Engelin tersi olan bir izin listesi (whitelist) için API’de endpoint yoktur. Bu listeyi API ile okuyamaz, ekleyemez veya silemezsiniz; ilgili izinler de rollere atanamaz. Canlı kullanımda uygulanan bir izin listesi özelliği bulunmaz. Bir numaranın mesajlarını yeniden almak istiyorsanız engel kaydını kaldırın.

Hatalar

Genel hata biçimi için Hata kodları sayfasına bakın.