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. Dengan e-mel atau userId, kenalan terus dicipta walaupun pengguna tidak pernah membuka sembang. signedUpAt (Date, saat Unix atau rentetan ISO 8601) ialah masa pengguna mendaftar dalam produk anda; tanpanya, tarikh pendaftaran kenalan kekal kosong.
Respondo.identify({
email: 'user@example.com',
name: 'John Doe',
userId: 'usr_123',
signedUpAt: '2024-05-31T10:00:00Z',
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().
Acara juga membuka tinjauan pop-up yang menunggunya (When and where): serta-merta pada halaman yang sepadan, atau apabila tiba di halaman sedemikian dalam masa 30 minit, contohnya selepas ubah hala.
Respondo.track('purchase_completed', {
plan: 'pro',
amount: 49
});Respondo.startSurvey(surveyId)
Membuka tinjauan pop-up yang aktif sekarang, di mana-mana halaman, tanpa mengambil kira Show on, peraturan halaman, masa di halaman, acara pencetus dan khalayak. Salin id daripada editor tinjauan (Additional ways to share). Tinjauan yang telah dijawab pelawat tidak dipaparkan lagi. Boleh dipanggil sebelum widget selesai dimuatkan.
Respondo.startSurvey('<survey-id>');Respondo.open(message?) / Respondo.close()
Membuka atau menutup messenger daripada butang anda sendiri. Hantar rentetan kepada open untuk bermula dengan ruang mesej yang sudah diisi. Panggil selepas Respondo.init(); panggilan yang dibuat semasa pelancar masih muncul akan digunakan sebaik sahaja ia muncul.
Respondo.open();
Respondo.open('I have a question about my invoice');
Respondo.close();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:
| Data | Sumber |
|---|---|
| IP klien | Pengepala HTTP |
| Pelayar / OS | Pengepala User-Agent |
| Bahasa | Pengepala Accept-Language |
| Zon waktu | Intl API (JavaScript) |
| URL halaman | window.location |
| Perujuk | Pengepala Referer |