Chatbot
Letakkan butang chatbot Keural pada laman web organisasi dengan kod pemasangan.
Organisasi boleh memasang chatbot Keural pada laman web sendiri. Pelawat menekan butang di sudut skrin, dan tetingkap chatbot dibuka. Kod pemasangan yang dijana pada skrin pengurusan cukup ditampal ke laman web.
Cipta chatbot
- Pemilik atau pentadbir organisasi menekan Tambah chatbot dalam Pengurusan organisasi → Urus chatbot.
- Masukkan nama chatbot dan domain asas (contoh:
https://example.com), kemudian daftarkan. - Buka chatbot dan tetapkan ketiga-tiga tab.
| Tab | Tetapan |
|---|---|
| Token·Kod pemasangan | Semak token, salin kod pemasangan (HTML · Next.js) |
| Tetapan UI chatbot | Imej butang (PNG·JPG·GIF·WebP) dan paparannya, nama chatbot, paparan·lanjutan·warna pengepala, warna butang, kedudukan butang (kiri·kanan), serta ofset mendatar·menegak. Semak dengan pratonton |
| Tetapan lanjutan | Alamat halaman tempat chatbot boleh dibuka (domain dibenarkan, maksimum 5) |
- Tampal kod pemasangan pada laman web anda.
Kod pemasangan
Dalam tab Token·Kod pemasangan, salin kod untuk HTML atau Next.js. Kod terdiri daripada dua bahagian.
- Pemuat: cipta fungsi
Keural, kemudian muat turun skrip chatbot (/plugin/keural-widget@1.0.1.js) secara async selepas halaman selesai dimuatkan. Arahan yang dipanggil sebelum skrip dimuatkan disimpan dalam baris gilir dan dijalankan mengikut susunan. - Arahan permulaan:
Keural('boot', { token: '…' }). Token bermula denganwgt_.
Versi skrip terkunci pada alamat tersebut. Apabila versi baharu dikeluarkan, salin semula kod pemasangan dan gantikannya. Jika kod pemasangan dimasukkan dua kali pada halaman yang sama, kod kedua diabaikan dan ralat dicatat dalam konsol.
<script id="keural-one-script">
/* Kod yang disalin daripada tab Token·Kod pemasangan */
</script>Dalam Next.js, gunakan <Script id="keural-one-script" strategy="afterInteractive"> daripada next/script. Untuk memaparkan chatbot pada semua halaman, letakkan dalam root layout.
Pilihan permulaan
Nilai dalam boot diutamakan berbanding tetapan dalam skrin pengurusan. Gunakan untuk menukar rupa mengikut halaman.
Keural('boot', {
token: 'wgt_…',
theme: 'system',
header: { enabled: true, extended: true, draggable: true, title: 'Sokongan pelanggan', color: '#495BD8' },
button: { visible: true, iconUrl: 'https://example.com/icon.png', color: '#495BD8', position: 'right', offsetX: 30, offsetY: 30 },
});| Pilihan | Nilai | Nama tetapan dalam skrin |
|---|---|---|
token | Wajib. Token daripada kod pemasangan | — |
theme | light · dark · system | — |
header.enabled | Memaparkan pengepala | Paparkan pengepala |
header.extended | Memaparkan butang lihat besar pada pengepala | Lanjutkan pengepala |
header.draggable | Pengepala boleh diseret untuk mengalihkan tetingkap (lalai true) | — |
header.title | Tajuk pengepala | Nama chatbot |
header.color | Warna pengepala | Warna pengepala |
button.visible | Memaparkan butang | Paparkan butang |
button.iconUrl | Alamat imej butang | Imej butang |
button.color | Warna butang | Warna butang |
button.position | left · right | Kedudukan butang |
button.offsetX · button.offsetY | Jarak dari tepi skrin (px) | Ofset X · Ofset Y |
Nilai lalai chatbot baharu ialah: paparan dan lanjutan pengepala dihidupkan, warna pengepala dan butang #495BD8, kedudukan kanan, ofset 30px, dan tema system.
Kawalan dari halaman
| Panggilan | Gelagat |
|---|---|
Keural('open') · Keural.open() | Membuka tetingkap chatbot. |
Keural('close') · Keural.close() | Menutup tetingkap. |
Keural('toggle') · Keural.toggle() | Menutup jika terbuka, membuka jika tertutup. |
Keural('reload') · Keural.reload() | Memuat semula tetingkap chatbot. |
Keural('badge', n) · Keural.badge(n) | Memaparkan lencana nombor pada butang. |
Keural.isLoaded() | true jika skrip telah selesai dimuatkan |
Keural.onOpen(cb) · Keural.onClose(cb) | Memanggil cb apabila tetingkap dibuka atau ditutup. |
Kaedah seperti Keural.open() hanya berfungsi selepas skrip dimuatkan. Jika dipanggil sebaik sahaja halaman dibuka, gunakan bentuk fungsi seperti Keural('open') supaya ia dijalankan mengikut susunan.
<button onclick="Keural('open')">Hubungi kami</button>Butang lalai juga boleh disembunyikan (button.visible: false) dan chatbot dibuka melalui butang sendiri.
Saiz skrin
Tetingkap chatbot berukuran 390×800px, dan dibuka dalam skrin penuh jika lebar skrin 480px atau kurang. Butang lihat besar pada pengepala membesarkan tetingkap.
Domain paparan
- Chatbot dibuka pada halaman yang hosnya sama dengan domain asas. Host dibandingkan termasuk port, dan huruf besar atau kecil tidak dibezakan. Alamat yang bermula dengan
www.dan subdomain dianggap host yang berlainan. Untuk menguji pada pelayan pembangunan, cipta chatbot berasingan dengan alamat tersebut sebagai domain asas. - Domain asas tidak boleh diubah selepas dicipta. Untuk menukarnya, cipta chatbot baharu.
- Jika domain dibenarkan dalam Tetapan lanjutan dibiarkan kosong, chatbot dibuka pada semua halaman dalam domain asas. Jika domain dibenarkan diisi, chatbot hanya dibuka pada halaman yang alamatnya bermula dengan domain tersebut. Jika laluan ditulis, seperti
https://example.com/help, skopnya menjadi halaman di bawah laluan itu. Domain dibenarkan mesti bermula denganhttp://atauhttps://dan maksimum 5. - Token dalam kod pemasangan terdedah pada halaman. Sambungkan chatbot hanya dengan kandungan yang boleh didedahkan kepada umum.
Dasar keselamatan (CSP)
Jika laman telah menetapkan Content-Security-Policy, benarkan perkara berikut. Alamat merujuk kepada keural.ai.
| Arahan | Yang dibenarkan |
|---|---|
script-src | https://keural.ai, skrip sebaris daripada kod pemasangan ('unsafe-inline' atau hash·nonce) |
connect-src | https://api.keural.ai |
frame-src | https://keural.ai |
style-src | 'unsafe-inline' atau nonce (chatbot memasukkan gaya ke dalam halaman) |
img-src | Alamat imej butang, https://keural.ai, https://api.keural.ai |