Chuyển đến nội dung
KeuralDocs
Nhà phát triển

Chatbot

Đặt nút chatbot Keural lên trang web của tổ chức bằng mã cài đặt.

Tổ chức có thể đặt chatbot Keural lên trang web của mình. Khi khách truy cập nhấn vào nút ở góc màn hình, cửa sổ chatbot sẽ mở ra. Mã cài đặt được tạo trong màn hình quản trị, bạn chỉ cần dán vào trang web, không cần tự xây dựng giao diện như với Kit.

Tạo chatbot

  1. Chủ sở hữu hoặc quản trị viên tổ chức nhấn Thêm chatbot trong Quản lý tổ chức → Chatbot.
  2. Nhập tên chatbot và tên miền cơ sở (ví dụ: https://example.com), sau đó đăng ký.
  3. Mở chatbot và cấu hình ba tab.
TabCài đặt
Token·mã cài đặtKiểm tra token và sao chép mã cài đặt (HTML · Next.js)
Giao diện chatbotẢnh nút (PNG, JPG, GIF, WebP), hiển thị nút, tên chatbot, hiển thị·mở rộng·màu tiêu đề, màu nút, vị trí nút (trái hoặc phải) và độ lệch ngang·dọc. Xem trước để kiểm tra
Nâng caoĐịa chỉ trang mà chatbot được phép mở (tên miền cho phép, tối đa 5)
  1. Dán mã cài đặt vào trang web của bạn.

Mã cài đặt

Ở tab Token·mã cài đặt, sao chép mã HTML hoặc Next.js. Mã gồm hai phần.

  • Bộ tải: tạo hàm Keural, khi trang tải xong thì tải bất đồng bộ script chatbot (/plugin/keural-widget@1.0.1.js). Các lệnh được gọi trước khi script tải xong sẽ được xếp hàng và thực thi theo thứ tự.
  • Lệnh khởi động: Keural('boot', { token: '…' }). Token bắt đầu bằng wgt_.

Phiên bản script được cố định trong địa chỉ. Khi có phiên bản mới, hãy sao chép lại mã cài đặt và thay thế. Nếu dán mã cài đặt hai lần trên cùng một trang, lần thứ hai sẽ bị bỏ qua và console ghi lỗi.

<script id="keural-one-script">
  /* Mã sao chép từ tab Token·mã cài đặt */
</script>

Trong Next.js, dùng <Script id="keural-one-script" strategy="afterInteractive"> của next/script. Để hiển thị trên mọi trang, hãy đặt trong root layout.

Tùy chọn khởi động

Giá trị truyền vào boot được ưu tiên hơn cài đặt trong màn hình quản trị. Dùng khi bạn muốn thay đổi giao diện theo từng trang.

Keural('boot', {
  token: 'wgt_…',
  theme: 'system',
  header: { enabled: true, extended: true, draggable: true, title: 'Hỗ trợ khách hàng', color: '#495BD8' },
  button: { visible: true, iconUrl: 'https://example.com/icon.png', color: '#495BD8', position: 'right', offsetX: 30, offsetY: 30 },
});
Tùy chọnGiá trịTên cài đặt trên màn hình
tokenBắt buộc. Token từ mã cài đặt—
themelight · dark · system—
header.enabledHiển thị tiêu đềHiển thị tiêu đề
header.extendedHiển thị nút xem lớn trên tiêu đềMở rộng tiêu đề
header.draggableCho phép kéo tiêu đề để di chuyển cửa sổ (mặc định true)—
header.titleTiêu đềTên chatbot
header.colorMàu tiêu đềMàu tiêu đề
button.visibleHiển thị nútHiển thị nút
button.iconUrlĐịa chỉ ảnh nútẢnh nút
button.colorMàu nútMàu nút
button.positionleft · rightVị trí nút
button.offsetX · button.offsetYKhoảng cách từ mép màn hình (px)Độ lệch X · Độ lệch Y

Giá trị mặc định của chatbot mới: hiển thị và mở rộng tiêu đề, màu tiêu đề và nút #495BD8, bên phải, độ lệch 30 px, chủ đề system.

Điều khiển từ trang

Lệnh gọiTác dụng
Keural('open') · Keural.open()Mở cửa sổ chatbot.
Keural('close') · Keural.close()Đóng cửa sổ.
Keural('toggle') · Keural.toggle()Nếu đang mở thì đóng; nếu đang đóng thì mở.
Keural('reload') · Keural.reload()Tải lại cửa sổ chatbot.
Keural('badge', n) · Keural.badge(n)Hiển thị huy hiệu số trên nút.
Keural.isLoaded()true khi script đã tải xong
Keural.onOpen(cb) · Keural.onClose(cb)Gọi cb khi cửa sổ mở hoặc đóng.

Các phương thức như Keural.open() chỉ hoạt động sau khi script tải xong. Khi gọi ngay sau khi trang tải, hãy dùng dạng hàm Keural('open'). Dạng này được thực thi theo thứ tự.

<button onclick="Keural('open')">Liên hệ tư vấn</button>

Bạn cũng có thể ẩn nút mặc định (button.visible: false) và mở chatbot bằng nút riêng trên trang.

Kích thước màn hình

Cửa sổ chatbot có kích thước 390×800 px, và khi chiều rộng màn hình từ 480 px trở xuống, cửa sổ mở toàn màn hình. Nút xem lớn trên tiêu đề giúp phóng to cửa sổ.

Tên miền hiển thị

  • Chatbot chỉ mở trên các trang có host trùng với tên miền cơ sở. Host được so sánh cả cổng, không phân biệt chữ hoa chữ thường. Địa chỉ có www. và tên miền phụ là host khác. Để thử trên máy chủ phát triển, hãy tạo một chatbot riêng với địa chỉ đó làm tên miền cơ sở.
  • Tên miền cơ sở không thể thay đổi sau khi tạo. Muốn đổi, hãy tạo chatbot mới.
  • Nếu để trống tên miền cho phép trong Nâng cao, chatbot mở trên mọi trang thuộc tên miền cơ sở. Nếu thêm tên miền cho phép, chatbot chỉ mở trên các trang bắt đầu bằng địa chỉ đó. Nếu nhập cả đường dẫn như https://example.com/help, phạm vi sẽ thu hẹp xuống các trang bên dưới đường dẫn đó. Tên miền cho phép bắt đầu bằng http:// hoặc https://, tối đa 5 mục.
  • Token trong mã cài đặt được hiển thị trên trang. Chỉ kết nối chatbot với nội dung có thể công khai.

Chính sách bảo mật nội dung (CSP)

Nếu trang web đã áp dụng Content-Security-Policy, hãy cho phép các mục sau. Địa chỉ tính theo keural.ai.

Chỉ thịCho phép
script-srchttps://keural.ai và script nội tuyến của mã cài đặt ('unsafe-inline' hoặc hash hoặc nonce)
connect-srchttps://api.keural.ai
frame-srchttps://keural.ai
style-src'unsafe-inline' hoặc nonce (chatbot thêm kiểu vào trang)
img-srcĐịa chỉ ảnh nút, https://keural.ai và https://api.keural.ai

Trên trang này