Infoset Chat JavaScript API dökümanı

Infoset sohbet aracı kodunu sayfanıza yüklediğinizde, bu kod bir sohbet aracınızla etkileşime girmenizi ve çeşitli araçlara erişmenizi sağlayan bir InfosetChat JavaScript nesnesi oluşturur. Bu nesne; ziyaretçi bilgilerini sayfa yenilemeden güncellemeniz, mesajlaşma penceresiyle etkileşime girmeniz gibi özelliklere olanak tanır.

InfosetChat('boot', options);

Infoset sohbet aracını başlatmak için 'boot' fonksiyonunu kullanabilirsiniz. Bu fonksiyon, 2. parametre olarak ziyaretçi verileri ve sohbet aracının ayarlarını alır.

Örnek kod:

InfosetChat('boot', {
  widget: {
    apiKey: 'abc12345' 
  },
  visitor: {
    id: '1',
    firstName: 'Ahmet',
    lastName: 'Yılmaz',
    email: '[email protected]',
    customFields: {
      ozelVeriAlani: 'Deger'
    }
  }
});

TypeScript tanımları:

declare type InfosetChatBootOptions = {
  widget: {
    apiKey: string;
    color?: string;
    customLauncher?: string;
    alignment?: 'left' | 'right';
    horizontalPadding?: number;
    verticalPadding?: number;
    tags?: string;
  };
  visitor?: {
    id?: string;
    firstName?: string;
    lastName?: string;
    email?: string;
    phone?: string;
    photoUrl?: string;
    userHash?: string;
    createdAt?: string;
    customFields?: object;
    company?: string;
  }; 
};

declare function InfosetChat(operation: 'boot', opts: InfosetChatBootOptions): void; 

InfosetChat('shutdown')

Bir kullanıcı uygulamanızdan çıkış yaptığında bu fonksiyonu çağırmalısınız. Bu fonksiyon Infoset’in çerezlerini temizler ve sohbet aracını kapatır.

Örnek kod:

InfosetChat('shutdown');

InfosetChat('hide')

Infoset sohbet penceresini kapatır.

Örnek kod:

InfosetChat('hide');

InfosetChat('show')

Infoset sohbet penceresini açar. 2. parametre ile sohbet penceresinde belirli bir sayfanın açılmasını sağlayabilirsiniz.

Örnek kod:

InfosetChat('show'); // En son aktif sayfayı açar
InfosetChat('show', 'home'); // Sohbet aracı anasayfasını açar
InfosetChat('show', 'conversation'); // Sohbet aracı görüşme panelini açar
InfosetChat('show', 'previous_conversations'); // Önceki görüşmelerin listelendiği sayfayı açar

TypeScript tanımı:

declare function InfosetChat(
  operation: 'show',
  page?: 'home' | 'conversation' | 'previous_conversations',
): boolean;

InfosetChat('identify', visitorData)

Sohbet aracı boot edildikten sonra ziyaretçinin bilgilerini dinamik olarak güncellemeniz gerekirse bu fonksiyonu kullanabilirsiniz. Fonksiyonun 2. parametresindeki yeni ziyaretçi verileri, mevcut verilerle birleştirilecek ve Infoset’teki ilgili kişi bilgileri de güncellenecektir.

Örnek kod:

InfosetChat('identify', {
  email: "[email protected]"
});

TypeScript tanımı:

declare function InfosetChat(
  operation: 'identify',
  visitorData: InfosetChatBootOptions['visitor'],
): void;

InfosetChat('getVisitorId')

Mevcut ziyaretçinin benzersiz ID değerini döner.

Örnek kod:

var visitorId = InfosetChat('getVisitorId');

TypeScript tanımı:

declare function InfosetChat(operation: 'getVisitorId'): string | undefined | null;

InfosetChat('stopTriggers')

Infoset panelinde tanımlamış olduğunuz sohbet tetikleyicilerinin mevcut ziyaretçi için geçici olarak çalışmasını durdurur.

Örnek kod:

InfosetChat('stopTriggers');

InfosetChat('startTriggers')

Infoset panelinde tanımlamış olduğunuz sohbet tetikleyicilerinin mevcut ziyaretçi için çalışmasını devam ettirir.

Örnek kod:

InfosetChat('startTriggers');

InfosetChat('onBoot', Function)

Sohbet aracı başladığında 2. parametrede ilettiğiniz fonksiyonun çalışmasını sağlar.

Örnek kod:

InfosetChat('onBoot', function() { /* Do stuff */ });

InfosetChat('onHide', Function)

Sohbet penceresi kapatıldığında 2. parametrede ilettiğiniz fonksiyonun çalışmasını sağlar.

Örnek kod:

InfosetChat('onHide', function() { /* Do stuff */ });

InfosetChat('onShow', Function)

Sohbet penceresi açıldığında 2. parametrede ilettiğiniz fonksiyonun çalışmasını sağlar.

Örnek kod:

InfosetChat('onShow', function() { /* Do stuff */ });

InfosetChat('onTriggerShow', Function)

Bir sohbet tetikleyicisi çalıştığında 2. parametrede ilettiğiniz fonksiyonun çalışmasını sağlar.

Örnek kod:

InfosetChat('onTriggerShow', function() { /* Do stuff */ });

TypeScript tanımı:

declare function InfosetChat(
  operation: 'onTriggerShow',
  fn: (data: { id: number; name: string; message: string }) => any,
): boolean;

InfosetChat('onTriggerHide', Function)

Bir sohbet tetikleyicisi gizlendiğinde 2. parametrede ilettiğiniz fonksiyonun çalışmasını sağlar.

Örnek kod:

InfosetChat('onTriggerHide', function(triggerData) { /* Do stuff */ });

TypeScript tanımı:

declare function InfosetChat(
  operation: 'onTriggerHide',
  fn: (data: { id: number; name: string; message: string }) => any,
): boolean;

InfosetChat('onUnreadCountChange', Function)

Ziyaretçinin okumadığı mesaj sayısı değiştiğinde 2. parametrede ilettiğiniz fonksiyonun çalışmasını sağlar.

Örnek kod:

InfosetChat('onUnreadCountChange', function(count) { /* Do stuff */ });

TypeScript tanımı:

declare function InfosetChat(
  operation: 'onUnreadCountChange',
  fn: (count: number) => any,
): boolean;