API Tiện ích

Dành cho nhà phát triển, hoặc bất kỳ ai muốn khung trò chuyện mở ra từ nút của riêng họ.

Đang cài đặt

<script src="https://keyda.in/business/widget.js"
        data-key="kb_live_your_key_here" async></script>

Thẻ mã script chỉ cần src và data-key. Mọi thứ khác — màu sắc, vị trí, lời chào, ngôn ngữ — đều đến từ bảng điều khiển của bạn, vì vậy bạn không bao giờ phải triển khai lại trang web để thay đổi chúng.

Tiện ích được hiển thị bằng ngôn ngữ đã đặt tại Cài đặt → Ngôn ngữ bot của bạn nói: nút bấm, gợi ý nhập và thông báo của nó, cùng hướng bố cục (tiếng Ả Rập và tiếng Urdu được viết từ phải sang trái). Các chuỗi văn bản này đi kèm với cấu hình của tiện ích, vì vậy không cần thêm yêu cầu thứ hai và không có gì để bạn phải dịch.

Chế độ

Nổi (mặc định). Nút khởi chạy ở góc, mở bảng trò chuyện.

Nhúng. Đặt một vùng chứa trống trên trang và khung chat sẽ tự điền vào đó:

<div data-keyda-bot style="height:520px"></div>

Khung chứa cần có chiều cao. Ở chế độ nội tuyến, khung trò chuyện luôn hiển thị nên không có gì cần mở hay đóng.

JavaScript API

Có sẵn trên window.KeydaBot sau khi mã nguồn đã tải xong:

Ví dụ — mở khung chat từ nút "Trò chuyện với chúng tôi" của chính bạn:

<button onclick="KeydaBot.open()">Chat with us</button>

Cách hoạt động trên trang của bạn

• Bảng điều khiển mở ra phía trên nút khởi chạy, nút này giữ nguyên vị trí và biến thành nút đóng. Chạm lại vào đó, dấu ✕ ở tiêu đề hoặc nhấn Escape sẽ đóng đoạn chat.
• Khách truy cập có thể mở rộng bảng trò chuyện từ tiêu đề — nó sẽ phủ kín chiều cao cửa sổ và rộng tới 760px — và lựa chọn này được ghi nhớ trong trình duyệt của họ. Trên điện thoại, bảng trò chuyện đã chiếm toàn màn hình nên nút này sẽ không hiển thị.
• Cài đặt kích thước logo của bạn làm thay đổi logo chứ không phải nút bấm: trình khởi chạy vẫn giữ nguyên kích thước và logo sẽ lớn lên bên trong đó. Kích thước nút (Cài đặt → Giao diện) mới là thứ thay đổi kích thước của chính nút bấm — nhỏ, vừa hoặc lớn — bất kể hình dạng nào.
• Bốn hình dạng nút: hình viên thuốc có nhãn của bạn, hình bong bóng tròn, hình vuông bo góc và hình bong bóng trò chuyện có đuôi. Đuôi nằm ở phía hướng về trang của bạn.
• Mọi thành phần hiển thị bên trong shadow root, do đó CSS của bạn không thể làm hỏng tiện ích và CSS của tiện ích cũng không thể ảnh hưởng đến trang web của bạn.
• Bảng điều khiển chỉ tải khi khách mở lên, do đó không làm chậm trang web của bạn.
• Cuộc trò chuyện của một khách truy cập sẽ tiếp tục trong 24 giờ nếu họ quay lại, sau đó bắt đầu lại từ đầu. Mở lại bảng trò chuyện sẽ khôi phục toàn bộ luồng — bao gồm cả tệp đính kèm, và một câu hỏi của luồng chào hỏi vẫn đang chờ câu trả lời.
• Biểu tượng kẹp giấy trong khung soạn tin cho phép khách truy cập đính kèm tối đa ba ảnh hoặc tài liệu vào một tin nhắn (kích thước và loại tệp có trong Giới hạn và bảo mật). Ảnh được giảm kích thước ngay trên trình duyệt trước khi tải lên, vì vậy một bức ảnh 12 megapixel sẽ rời khỏi trang chỉ còn vài trăm kilobyte. Tắt tính năng tệp tại Cài đặt và nút này sẽ biến mất.
• Một luồng chào hỏi chạy dưới dạng các bong bóng tin nhắn thông thường: các lựa chọn trở thành nút bấm bên dưới bong bóng, nút Bỏ qua xuất hiện khi một bước là tùy chọn, và gợi ý nhập của khung soạn tin trở thành câu hỏi. Một luồng đã hoàn tất sẽ được ghi nhớ trong trình duyệt của khách truy cập trong 30 ngày.
• Nếu không thể kết nối với trợ lý, tiện ích sẽ hiển thị một thông báo ngắn và tuyệt đối không làm phát sinh lỗi trên trang của bạn.

Trong các SDK ứng dụng

Cùng một khung chat chạy trên mọi SDK, vì vậy tệp đính kèm và luồng chào hỏi sẽ đến với ứng dụng của bạn mà không cần phát hành bản mới — chỉ có một ngoại lệ. Việc mở trình chọn tệp từ một web view là nhiệm vụ của ứng dụng chủ. Các gói iOS, React Native và Ionic đã làm được điều này; Android và Flutter cần SDK 0.1.4 trở lên. Trên các phiên bản cũ hơn, tiện ích sẽ nhận diện được ứng dụng chủ và ẩn biểu tượng kẹp giấy thay vì hiển thị một nút bấm không có tác dụng.