Ondestek ile yeni bir dönem başlıyor! İşletmenize özel yapay zeka destekli chatbotlar yayında.

Ondestek API

Ondestek Javascript Dökümantasyon

Ondestek sohbet penceresi için tasarlanmış javascript api dökümanıdır. Sadece önyüzde(frontend) çalışmaktadır.

Ondestek apisini dinleyebilmek için öncelikle ondestek istemcisinin tamamen yüklendiğini beklemek gerekmektedir. Aksi takdirde api çalışmayacaktır. API kodlarının tümünü window.onDestekClientReady kod bloğunun içerisinde çalıştırmanız gerekmektedir.

onDestekClientReady
Ondestek istemcisi tamamen yüklendiğinde içeriğinde kod bloğunu çalıştırır.
// OnDestek API tamamen yüklendiğinde 
window.onDestekClientReady = function(){
       
    // Sohbet penceresini kapatıyoruz.  
OnDestekClient.api.closeWindow();

    var myButton = document.getElementById("myButton");
    // Sitenin online / offline durumunu dinliyoruz.  
    OnDestekClient.api.listenStatus(function(status){
        if(status === true){
            myButton.innerText = "Canlı Destek - ONLINE";
        } else {
            myButton.innerText = "Canlı Destek - OFFLINE";
        }
    })

    // Butona tıklandığında sohbet penceresini açtırıyoruz   
    myButton.addEventListener("click", function(){
        OnDestekClient.api.openWindow();
    });
}
listenStatus
Sitenin online veya offline olma durumlarını dinler. Müşteri temsilcilerinden en az 1 kişi online olduğu durumda site çevrimiçi olur. Hiç bir müşteri temsilcisi online değil ise offline modu aktifleşir.
Kullanım: listenStatus: function(Function handler)
window.onDestekClientReady = function(){
    OnDestekClient.api.listenStatus(function(status){
        console.log("site status changed to: "+status);
    });
}
openWindow
Kapalı olan sohbet penceresini açık hale getirir.
Kullanım: openWindow: function()
window.onDestekClientReady = function(){
    OnDestekClient.api.openWindow();
}
closeWindow
Açık olan sohbet penceresini kapatır.
Kullanım: closeWindow: function()
window.onDestekClientReady = function(){
    OnDestekClient.api.closeWindow();
}
hideWidget
Sohbet penceresini bütünüyle gizler.
Kullanım: hideWidget: function()
window.onDestekClientReady = function(){
    OnDestekClient.api.hideWidget();
}
showWidget
Sohbet penceresini gösterir. openWindow methodu gibi pencere açmaz. Sadece gösterimini sağlar.
Kullanım: showWidget: function()
window.onDestekClientReady = function(){
    OnDestekClient.api.showWidget();
}
setName
Bağlı ziyaretçinin isim bilgisini kaydeder.
Kullanım: setName: function(String name, Function handler)
window.onDestekClientReady = function(){
    OnDestekClient.api.setName("John", function(e){
        if(e.success){
            console.log("Başarıyla kaydedildi.");
        } else {
            console.error(e.detail);
        }
    });
}
setEmail
Bağlı ziyaretçinin eposta bilgisini kaydeder.
Kullanım: setEmail: function(String email, Function handler)
window.onDestekClientReady = function(){
    OnDestekClient.api.setEmail("johndoe@email.com", function(e){
        if(e.success){
            console.log("Başarıyla kaydedildi.");
        } else {
            console.error(e.detail);
        }
    });
}
setPhone
Bağlı ziyaretçinin telefon bilgisini kaydeder.
Kullanım: setPhone: function(String phone, Function handler)
window.onDestekClientReady = function(){
    OnDestekClient.api.setPhone("111222333", function(e){
        if(e.success){
            console.log("Başarıyla kaydedildi.");
        } else {
            console.error(e.detail);
        }
    })
}
setCompany
Bağlı ziyaretçinin firma adı bilgisini kaydeder.
Kullanım: setCompany: function(String company, Function handler)
window.onDestekClientReady = function(){
    OnDestekClient.api.setCompany("Acme", function(e){
        if(e.success){
            console.log("Başarıyla kaydedildi.");
        } else {
            console.error(e.detail);
        }
    })
}
setDescription
Bağlı ziyaretçinin açıklama bilgisini kaydeder. Üzerine yazıldığından daha önce kaydedilen açıklama silinmiş olur.
Kullanım: setDescription: function(String description, Function handler)
window.onDestekClientReady = function(){
    OnDestekClient.api.setDescription("some description", function(e){
        if(e.success){
            console.log("Başarıyla kaydedildi.");
        } else {
            console.error(e.detail);
        }
    })
}
appendDescription
Bağlı ziyaretçinin açıklama bilgisini günceller. Üzerine ekleme yapıldığından önceki açıklama bilgisi korunur.
Kullanım: appendDescription: function(String description, Function handler)
window.onDestekClientReady = function(){
    OnDestekClient.api.appendDescription("additional description", function(e){
        if(e.success){
            console.log("Başarıyla kaydedildi.");
        } else {
            console.error(e.detail);
        }
    })
}
saveVisitor
Bağlı ziyaretçinin bilgilerini kaydeder.
Kullanım: saveVisitor: function(Object params, Function handler)
window.onDestekClientReady = function(){
    var params = {
        fullname: "John Doe",
        email: "john@doe.com",
        phone: "111222333",
        company: "Acme - A Company Makes Everything",
        note: "some note about visitor..."
    }
    OnDestekClient.api.saveVisitor(params, function(e){
        if(e.success){
            console.log("Başarıyla kaydedildi.");
        } else {
            console.error(e.detail);
        }
    })
}
sendMessage
Çevrimdışı mesaj gönderir.
Kullanım: sendMessage: function(Object params, Function handler)
window.onDestekClientReady = function(){
    var params = {
        fullname: "John Doe",
        email: "john@doe.com",
        phone: "111222333",
        message: "this is a test message !"
    }
    OnDestekClient.api.sendMessage(params, function(e){
        if(e.success){
            console.log("Başarıyla kaydedildi.");
        } else {
            console.error(e.msg);
        }
    })
}