Dokumentasi

JavaScript API

Kaedah global yang tersedia selepas skrip widget dimuatkan.

Respondo.init(config)#

Memulakan dan melekapkan widget. Mesti dipanggil sekali. Mengembalikan instans widget.

const widget = Respondo.init({
  agentId: 'YOUR_AGENT_ID'
});

Respondo.identify(identity)#

Melampirkan identiti pengguna pada sesi semasa. Panggil selepas log masuk.

Respondo.identify({
  email: 'user@example.com',
  name: 'John Doe',
  userId: 'usr_123',
  userHash: 'hmac_sha256_signature', // pilihan, untuk pengesahan identiti
  metadata: { plan: 'pro' },
  properties: {                      // sifat kenalan tersuai
    account_type: 'enterprise',      // kunci ditakrifkan dalam Tetapan Ejen
    region: 'eu-west'
  }
});

Respondo.track(name, properties?)#

Merekodkan peristiwa di sebelah klien bagi pelawat semasa (contohnya pembelian, naik taraf pelan). Peristiwa boleh memulakan Tour yang dicetuskan peristiwa dan dikira ke arah matlamat tour. Penghantaran usaha-terbaik dengan keepalive, jadi peristiwa yang dicetuskan sejurus sebelum navigasi (ubah hala checkout) tetap sampai. Panggil selepas init().

Respondo.track('purchase_completed', {
  plan: 'pro',
  amount: 49
});

Respondo.destroy()#

Membuang widget daripada halaman. Berguna untuk SPA apabila menavigasi ke halaman yang tidak sepatutnya memaparkan widget. Ia tidak mengosongkan identiti pelawat atau perbualan yang tersimpan — untuk log keluar, gunakan Respondo.reset().

// Buang widget daripada halaman
Respondo.destroy();

// Mulakan semula kemudian jika perlu (menyambung semula perbualan yang sama)
Respondo.init({ agentId: 'YOUR_AGENT_ID' });

Respondo.reset()#

Log keluar / serahan peranti berkongsi. Mengosongkan id pelawat tanpa nama, perbualan yang tersimpan dan token sesi daripada pelayar, membatalkan token sesi di sisi pelayan supaya salinannya berhenti berfungsi, dan melekapkan semula widget tanpa nama yang segar. Panggil ini daripada cangkuk log keluar aplikasi anda.

// Semasa log keluar — padamkan identiti, perbualan dan sesi, mula segar
Respondo.reset();

Pengumpulan Data Automatik

Widget menangkap dan menyimpan maklumat berikut secara automatik bagi setiap perbualan:

DataSumber
IP klienPengepala HTTP
Pelayar / OSPengepala User-Agent
BahasaPengepala Accept-Language
Zon waktuIntl API (JavaScript)
URL halamanwindow.location
PerujukPengepala Referer