Javascript API’si

Tawk.to JavaScript API belgelerine hoş geldiniz.

API, web projelerinizde kullanılabilecek esnek metot setleri sağlar. Aşağıdaki metotlardan birini çağırmak için lütfen metotu sayfanızdaki gömülü koddan sonra çağırdığınızdan emin olun.

Web sitenizde görüntülenen sohbet aracını değiştirmek için JavaScript API’sini kullanın.

Popüler kullanımlar:

API’yi nasıl kullandığınızı görmekten her zaman heyecan duyuyoruz, bu yüzden kreasyonlarınızı bizimle paylaşmaktan çekinmeyin!

onLoad

Araç oluşturulduktan hemen sonra geri çağırma işlevi çağrılır. Bu geri çağırma, pop-out (açılır) sohbet penceresinde desteklenmez.

Tawk_API = Tawk_API || {};
Tawk_API.onLoad = function(){
    //place your code here
};

onLoad

Araç oluşturulduktan hemen sonra geri çağırma işlevi çağrılır. Bu geri çağırma, pop-out (açılır) sohbet penceresinde desteklenmez.

Tawk_API = Tawk_API || {};
Tawk_API.onLoad = function(){
    //place your code here
};

onStatusChange

Geri çağırma işlevi, sayfa durumu değiştiğinde çağrılır. İşlev, çevrimiçi, dışarıda veya çevrimdışı olararak değişebilen durumu alacaktır. Bu geri çağırma, pop-out (açılır) sohbet penceresinde desteklenmez.

Tawk_API = Tawk_API || {};
Tawk_API.onStatusChange = function(status){
    //place your code here
};

onBeforeLoad

Geri çağırma işlevi, Tawk_API kullanıma hazır olduğunda ve araç oluşturulmadan önce çağrılır. Bu geri çağırma, pop-out (açılır) sohbet penceresinde desteklenmez.

Tawk_API = Tawk_API || {};
Tawk_API.onBeforeLoad = function(){
    //place your code here
};

onChatMaximized

Araç büyültüldüğünde geri çağırma işlevi çağrılır. Bu geri çağırma, pop-out (açılır) sohbet penceresinde desteklenmez.

Tawk_API = Tawk_API || {};
Tawk_API.onChatMaximized = function(){
    //place your code here
};

onChatMinimized

Araç küçültüldüğünde geri çağırma işlevi çağrılır. Bu geri çağırma, pop-out (açılır) sohbet penceresinde desteklenmez.

Tawk_API = Tawk_API || {};
Tawk_API.onChatMinimized = function(){
    //place your code here
};

onChatHidden

Araç gizlendiğinde geri çağırma işlevi çağrılır. Bu geri çağırma, pop-out (açılır) sohbet penceresinde desteklenmez.

Tawk_API = Tawk_API || {};
Tawk_API.onChatHidden = function(){
    //place your code here
};

onChatStarted

Araç başlatıldığında geri arama işlevi çağrılır.

Tawk_API = Tawk_API || {};
Tawk_API.onChatStarted = function(){
    //place your code here
};

onChatEnded

Araç sonlandırıldığında geri arama işlevi çağrılır. Bu geri çağırma, pop-out (açılır) sohbet penceresinde desteklenmez.

Tawk_API = Tawk_API || {};
Tawk_API.onChatEnded = function(){
    //place your code here
};

onPrechatSubmit

Ön sohbet formu gönderildiğinde geri arama işlevi çağrıldı. Gönderilen formun verileri işleve aktarılır. Bu geri çağırma, pop-out (açılır) sohbet penceresinde desteklenmez.

Tawk_API = Tawk_API || {};
Tawk_API.onPrechatSubmit = function(data){
    //place your code here
};

onOfflineSubmit

Çevrimdışı form gönderildiğinde geri arama işlevi çağrıldı. Gönderilen form verileri geri çağırmaya aktarılır. Form verileri, {ad: ”, e-posta:”, mesaj: ”, sorular: []} içerecektir. Bu geri çağırma, pop-out (açılır) sohbet penceresinde desteklenmez.

Tawk_API = Tawk_API || {};
Tawk_API.onOfflineSubmit = function(data){
    //place your code here
};

visitor{};

Ziyaretçi adını ve e-postasını ayarlamak için kullanılan nesne.Araç komut dosyası indirilmeden önce değerlerin kullanılabilir olması gerektiğinden, bu nesneyi bir işleve yerleştirmeyin.

Araç komut dosyası indirildikten sonra değerleri ayarlamak veya değiştirmek, değerleri panele göndermez.

Ad ve e-posta yükleme zamanında kullanılamayacaksa (örn. Tek sayfalık uygulama, ajax oturumu açma), bunun yerine setAttributes işlevini kullanın.

Tawk_API = Tawk_API || {};
Tawk_API.visitor = {
    name  : 'Name',
    email : 'email@email.com'
};

maximize();

Sohbet aracını en büyük haline getirir.

Tawk_API.maximize();

//Example

Tawk_API.onLoad = function(){
    Tawk_API.maximize();
};

minimize();

Sohbet aracını en küçük haline getirir.

Tawk_API.minimize();

//Example

Tawk_API.onLoad = function(){
    Tawk_API.minimize();
};

toggle();

Mevcut duruma göre sohbet aracını simge durumuna en küçük veya en büyük haline getirir.

Tawk_API.toggle();

//Example

Tawk_API.onLoad = function(){
    Tawk_API.toggle();
};

popup();

Sohbet aracını açılır pencere (popout) olarak açar.

Tawk_API.popup();

//Example

Tawk_API.onLoad = function(){
    Tawk_API.popup();
};

getWindowType();

Satır içi veya gömülü, mevcut araç türünü döndürür.

Tawk_API.getWindowType();

//Example

Tawk_API.onLoad = function(){
    if(Tawk_API.getWindowType() === 'inline'){
        // do something if it's inline
    }else{
        // do something if it's embed
    }
};

showWidget();

Sohbet aracını gösterir.

Tawk_API.showWidget();

//Example

Tawk_API.onLoad = function(){
    Tawk_API.showWidget();
};

hideWidget();

Sohbet aracını gizler.

Tawk_API.hideWidget();

//Example

Tawk_API.onLoad = function(){
    Tawk_API.hideWidget();
};

toggleVisibility();

Mevcut görünürlük durumuna göre sohbet aracını gizler veya gösterir.

Tawk_API.toggleVisibility();

//Example

Tawk_API.onLoad = function(){
    Tawk_API.toggleVisibility();
};

getStatus();

Mevcut sayfa durumunu döndürür (çevrimiçi, dışarıda veya çevrimdışı).

Tawk_API.getStatus();

//Example

Tawk_API.onLoad = function(){
    var pageStatus = Tawk_API.getStatus();

    if(pageStatus === 'online'){
        // do something for online
    }else if(pageStatus === 'away'){
        //do something for away
    }else{
        // do something for offline
    }
};

isChatMaximized();

Sohbet aracı en büyük halinde olsa da bir boole cebirine (doğru veya yanlış) döndürür.

Tawk_API.isChatMaximized();


//Example

Tawk_API.onLoad = function(){
    if(Tawk_API.isChatMaximized()){
        //do something if it's maximized
    }
};

isChatMinimized();

Sohbet aracı en büyük halinde olsa da bir boole cebirine (doğru veya yanlış) döndürür.

Tawk_API.isChatMinimized();

//Example

Tawk_API.onLoad = function(){
    if(Tawk_API.isChatMinimized()){
        // do something if it's minimized
    }
};

isChatHidden();

Sohbet aracı gizlenmiş olsa da bir boole cebirine (doğru veya yanlış) döndürür.

Tawk_API.isChatHidden();

//Example

Tawk_API.onLoad = function(){
    if(Tawk_API.isChatHidden()){
        // do something if chat widget is hidden
    }
};

isChatOngoing();

Şu an devam eden bir sohbet olup olmadığına bakılmaksızın bir boole cebirine (doğru veya yanlış) döndürür.

Tawk_API.isChatOngoing();

//Example

Tawk_API.onLoad = function(){
    if(Tawk_API.isChatOngoing()){
        //do something if there's ongoing chat
    }
};

isVisitorEngaged();

Ziyaretçinin o anda sohbet ediyor olmasına veya bir sohbet talep etmesine bakılmaksızın bir boole cebirine (doğru veya yanlış) döndürür.

Tawk_API.isVisitorEngaged();

//Example

Tawk_API.onLoad = function(){
    if(Tawk_API.isVisitorEngaged()){
        // do something if visitor is engaged in chat
    }
};

endChat();

Devam eden mevcut sohbeti sonlandırır.

Tawk_API.endChat();

//Example

Tawk_API.onLoad = function(){
    Tawk_API.endChat();
};

setAttributes();

Bu sohbet / ziyaretçiyle ilgili özel meta verileri ayarlayın.

Bu işlev iki değer alır; öznitelik ve geri çağırma;

Öznitelik değeri, bir anahtar değer çifti olan object (nesne) veri türündedir.

Anahtar, dize veri türündedir ve yalnızca alfasayısal karakterler ve “-” (kısa çizgi) içerebilir.

Ayrıca bu işlevi ziyaretçi adını ve e-postasını ayarlamak için de kullanabilirsiniz, ancak önce güvenli modu etkinleştirmeniz ve bu işlevde de hesaplanan hush (karma) değerini sağlamanız gerekir.

Bunun nasıl yapılacağını öğrenmek için aşağıdaki güvenli mod bölümüne bakın.

Güvenli modda olmasının nedeni, veri bütünlüğünü sağlamaktır. Araçtan panele gönderilen değerin gerçek olduğundan ve değiştirilmediğinden emin olmayı sağlar.

Bir işlev olan geri çağırma, kaydetme işleminin başarısız olup olmadığını bildirmek için çağrılacaktır.

Hata mesajı döndürüldü :

  1. INVALID_ATTRIBUTES: Hiçbir öznitelik gönderilmedi
  2. SESSION_EXPIRED: Ziyaretçinin mevcut oturumunun süresi doldu
  3. SERVER_ERROR: Dahili sunucu hatası
  4. ACCESS_ERROR: Sayfaya erişim hatası
  5. ATTRIBUTE_LIMIT_EXCEEDED: Toplam özel öznitelik sayısı (ad, e-posta ve karma (hash) hariç) 50’dir
  6. CONTAINS_INVALID_KEY: Özel anahtar alfasayısal veya kısa çizgi değil (tuşlar küçük harfle yazılacaktır)
  7. CONTAINS_INVALID_VALUE: Özel değer boş veya toplam uzunluk 255 karakterden fazla
Tawk_API.setAttributes(attributes, callback);

//Example

Tawk_API.onLoad = function(){
    Tawk_API.setAttributes({
        'id'    : 'A1234',
        'store' : 'Midvalley'
    }, function(error){});
};


//Example for setting name and email

Tawk_API.onLoad = function(){
    Tawk_API.setAttributes({
        'name'  : 'Name',
        'email' : 'email@email.com',
        'hash'  : 'hash value'
    }, function(error){});
}

addEvent();

Sohbet etmek için özel bir olay ayarlayın.
Bu fonksiyon 3 değer alır; olay adı, isteğe bağlı bir meta veri (metadata) ve geri çağırma işlevi.

Etkinlik adı dize (string) veri türündedir ve yalnızca alfasayısal karakterler ve “-” (kısa çizgi) içerebilir.

Bir işlev olan geri çağırma, kaydetmenin başarısız olup olmadığını bildirmek için çağrılacaktır.

INVALID_EVENT_NAME, INVALID_ATTRIBUTES, ATTRIBUTE_LIMIT_EXCEEDED, CONTAINS_INVALID_KEY, CONTAINS_INVALID_VALUE, SESSION_EXPIRED, SERVER_ERROR

Tawk_API.addEvent(eventName, metadata, callback);

//Example

Tawk_API.onLoad = function(){
    Tawk_API.addEvent('requested-quotation', function(error){});

    Tawk_API.addEvent('product-add-to-cart', {
        'sku'    : 'A0012',
        'name'  : 'Jeans',
        'price' :'50'
    }, function(error){});
};

addTags();

Sohbete etiketler ekleyin.
Bu işlev iki değer alır; etiketler ve geri çağırma.
Bu, Array veri tipindedir.
Etiketlerin içeriği String veri türünde olmalıdır.

Toplam etiket sayısı 10’dur.
Bir işlev olan geri çağırma, kaydetmenin başarısız olup olmadığını bildirmek için çağrılacaktır.

INVALID_TAGS, TAG_LIMIT_EXCEEDED, VERSION_CONFLICT, SESSION_EXPIRED, SERVER_ERROR

Tawk_API.addTags(tags, callback);

//Example

Tawk_API.onLoad = function(){
    Tawk_API.addTags(['hello', 'world'], function(error){});
};

removeTags();

Sohbetteki etiketleri kaldır.
Bu işlev iki değer alır; etiketler ve geri arama.
Bu, Array veri tipindedir.
Etiketlerin içeriği String veri türünde olmalıdır.

Bir işlev olan geri çağırma, kaydetmenin başarısız olup olmadığını bildirmek için çağrılacaktır.

INVALID_TAGS, TAG_LIMIT_EXCEEDED, SESSION_EXPIRED, SERVER_ERROR

Tawk_API.removeTags(tags, callback);

//Example

Tawk_API.onLoad = function(){
    Tawk_API.removeTags(['hello', 'world'], function(error){});
};

Secure Mode

Güvenli yöntem, gönderdiğiniz verilerin gerçekten sizden geldiğini garanti altına almaktır.

üvenli modu etkinleştirmek için aşağıdaki kodu sayfanıza gömülü olarak yerleştirin.

Karma (hash), SHA256, kullanıcı e-postası ve sitenizin API anahtarı kullanılarak sunucu tarafında oluşturulan HMAC’dir.

API anahtarınızı
Yönetici>Varlık Ayarları’ndan alabilirsiniz.

Tawk_API = Tawk_API || {};
Tawk_API.visitor = {
    name  : 'Name',
    email : 'email@email.com',
    hash  : '<calculate-hash>'
};

// Here is an example showing how you could do it using PHP

Tawk_API = Tawk_API || {};
Tawk_API.visitor = {
    name  : ' echo $user->name; ?>',
    email : ' echo $user->email; ?>',
    hash  : ' echo hash_hmac("sha256", $user->email, ""); ?>'
};
© Copyright 2020 tawk.to, inc. Tüm Hakları Saklıdır.