GET/api/public/widget/history
Örneğin sayfa yeniden yüklendikten sonra, bir widget konuşmasının önceki mesaj geçmişini yükler.
`widget_code`, `session_id` ve `visitor_id`'yi sorgu parametresi olarak iletin. Yanıt, `data` nesnesinde konuşma sırasına göre `role` (`user` veya `assistant`), `text` ve `created_at` ile `messages` listesini içerir. Çağrı salt okunurdur ve idempotenttir. Embed token ile `X-Widget-Token` başlığı ve `widget_code` gereklidir. Belirteç eksikse, sunucu 401 `WIDGET_TOKEN_MISSING` ile yanıt verir, geçersizse 401 `WIDGET_TOKEN_INVALID` ile; onaylanmamış alan adlarından gelen çağrılar 403 `WIDGET_ORIGIN_DENIED`, devre dışı bırakılmış bir widget 404 `WIDGET_DISABLED` alır. `session_id` veya `visitor_id` eksikse, sunucu 400 `PARAMS_REQUIRED` ile yanıt verir. Oturum artık bilinmiyorsa, yeni bir konuşma başlatın.
Genel Bakış
Çağrı: GET /api/public/widget/history. Bu uç nokta, Zentor App API'sinin “Sohbet Widget'ı” grubuna aittir. Geçerli bir widget embed token'ı gerektirir. Çağrı idempotenttir: Aynı bilgilerle tekrarlanan çağrılar aynı sonucu döndürür. Zorunlu parametreler: widget_code (Query), session_id (Query), visitor_id (Query). Belgelenmiş hata durumları: 400 PARAMS_REQUIRED. Aşağıdaki örnek yanıt, JSON formatındaki başarılı bir yanıtın yapısını gösterir.
Kimlik Doğrulama ve Güvenlik
Widget gömme jetonu (X-Widget-Token başlığı) + kaynak onay listesi
İdempotent: Evet
Parametreler
widget_code(query, string, zorunlu)— Yerleştirme (embed) kodunuzdan widget kodusession_id(query, string, zorunlu)— `message` yanıtından konuşmanın oturum kimliğivisitor_id(query, string, zorunlu)— Widget'ın oluşturduğu ve tarayıcıda sakladığı ziyaretçi kimliğiÖrnek Yanıt
{"ok":true,"data":{"messages":[{"role":"user","text":"Merhaba...","created_at":"..."},{"role":"assistant","text":"...","created_at":"..."}]}}Hata Kodları
400 PARAMS_REQUIRED — `session_id` veya `visitor_id` eksik.Doğrulanmış davranış
Mevcut bir oturum, mesaj geçmişiyle 200 döner; eksik parametreler 400 `PARAMS_REQUIRED` döner.
Sohbet Widget'ı
GET /api/public/widget/healthWidget hizmetinin basit bir erişilebilirlik kontrolü.GET /api/public/widget/config/:widget_codeTarayıcıda başlatma için bir widget'ın herkese açık yapılandırmasını (görünen ad, karşılama metni, tasarım, dil, sesli işlev) döndürür.POST /api/public/widget/messageZiyaretçinin bir mesajını sohbet botuna gönderir ve onun yanıtını döndürür – sohbet widget'ının merkezi uç noktası.POST /api/public/widget/pollBelirli bir zamandan sonra alınan mesajları alır – örneğin, konuşmayı devralan bir çalışanın yanıtı.POST /api/public/widget/ratingZiyaretçinin bir konuşma hakkındaki değerlendirmesini (yararlı veya yararlı değil) kaydeder.POST /api/public/widget/trackDashboard'daki analizler için widget'ın anonim bir kullanım olayını (örn. "widget açıldı") kaydeder.POST /api/public/widget/voice-transcribeWidget için sesli işlev etkinleştirilmişse, ziyaretçinin sesli kaydını metne dönüştürür (sesli giriş).POST /api/public/widget/voice-speakSesli işlev etkinleştirilmişse, metni sesli konuşmaya dönüştürür (widget'ta sesli çıkış).