Tài liệu tham khảo SDK

Mọi Telybot SDK — Android, iOS, React Native, Flutter, Ionic — đều áp dụng cùng một giao diện nhỏ gọn. Nếu bạn đã dùng một cái, bạn đã dùng được tất cả.

API

Mở kèm một câu hỏi. Truyền một câu hỏi cho show và nó được đặt vào ô tin nhắn của chat; khách hàng đọc rồi nhấn gửi. Nó đi trong #fragment của liên kết, nên không bao giờ đến nhật ký máy chủ. Tối đa 500 ký tự, trên một dòng.

Chat trong màn hình của riêng bạn. Android KeydaBotView, iOS KeydaBot.makeChatViewController hoặc SwiftUI KeydaBotView, React Native <KeydaBotChat />, Flutter KeydaBotChat, và embedWidget() của gói Ionic. Nó không có nút đóng — điều hướng của màn hình bạn là lối ra. Trên Android, nút Quay lại đóng mặt hàng hoặc giỏ hàng đang mở trước: React Native và Flutter làm việc này cho bạn khi chat là màn hình phía trước, còn với KeydaBotView gốc thì phần xử lý Quay lại của bạn gọi goBack() của nó.

Khách hàng đã đăng nhập của bạn. Đưa cho SDK tên, số điện thoại hoặc email của khách hàng và chat sẽ điền những gì ứng dụng của bạn đã biết. Thông tin chỉ được gợi ý, không bao giờ tự gửi: chúng xuất hiện trong biểu mẫu “nói chuyện với người thật”, một đơn hàng, một lịch hẹn và một câu hỏi chào mừng xin tên, số điện thoại hoặc email, và khách hàng là người gửi. Chúng đi trong #fragment của liên kết và là lời của ứng dụng bạn, không phải danh tính đã xác minh. Giá trị mà chat sẽ từ chối bị bỏ qua: tên dài hơn 80 ký tự, số điện thoại không có 8 đến 15 chữ số, địa chỉ email không có tên miền hợp lệ. Chat toàn màn hình của Ionic mở trong trình duyệt hệ thống, vốn lưu địa chỉ trong lịch sử, nên không nhận chúng; widget nhúng của nó thì nhận.

Trả lời khi chat đang đóng. Khi khách hàng yêu cầu nói chuyện với người thật rồi đóng chat, câu trả lời của bạn từ bảng điều khiển sẽ chờ trong cuộc trò chuyện. SDK cho Android, iOS, React Native và Flutter kiểm tra điều này khi ứng dụng của bạn trở lại nền trước và báo cho ứng dụng, để bạn có thể hiện một chấm trên nút chat cho đến khi khách hàng mở chat. Chúng chỉ hỏi về những cuộc chat mà khách hàng đã yêu cầu người thật trong 14 ngày gần nhất. Một cuộc chat mà ứng dụng của bạn giữ tải sẵn ngoài tầm nhìn, như tab Trợ giúp ở nền sau, không được tính là đã đọc: chấm vẫn còn cho đến khi khách hàng nhìn vào. Đây không phải thông báo đẩy: câu trả lời được nhận ra khi ứng dụng được mở.

Cố ý không có gì khác. Không có API gửi tin nhắn và không có lệnh gọi danh tính người dùng — vì cả hai đều chưa hoạt động trọn vẹn từ đầu đến cuối, và một phương thức không hoạt động còn tệ hơn một phương thức không có.

URL mà mọi SDK mở ra

{baseUrl}/chat/{clientId}

baseUrl mặc định là https://telybot.com và có thể ghi đè trên mọi nền tảng, dùng cho môi trường thử nghiệm hoặc bản cài đặt tự lưu trữ.

Tại sao dùng web view và chi phí bạn phải trả

Chỉ có một giao diện chat duy nhất do nền tảng cung cấp và mọi nền tảng đều tải giao diện đó.

Bạn nhận được gì: mọi thay đổi mà chủ doanh nghiệp thực hiện trên bảng điều khiển — màu điểm nhấn, tin nhắn chào mừng, tên bot, chuyển sang trạng thái hoạt động — đều đến với mọi ứng dụng ngay lập tức mà không cần phát hành bản mới. Một bản sửa lỗi áp dụng ở mọi nơi cùng lúc. Khung chat giống hệt nhau trên các nền tảng.

Chi phí: đoạn chat cần có kết nối. Không có chế độ ngoại tuyến và chưa có thông báo đẩy.

Chúng tôi muốn bạn biết điều này trước khi đưa sản phẩm lên sóng hơn là phát hiện ra nó sau khi đã xong.

Các cam kết từ mỗi SDK

1. Thoát điều hướng. Liên kết đến bất kỳ nguồn gốc nào khác sẽ mở trong trình duyệt hệ thống thay vì thay thế khung chat. Nếu không có tính năng này, chỉ một lần chạm vào liên kết ở chân trang sẽ chấm dứt cuộc trò chuyện của khách hàng mà không có cách nào quay lại.
2. Duy trì cuộc trò chuyện. Bộ nhớ DOM được bật, vì vậy khách hàng đóng ứng dụng và quay lại sẽ thấy đoạn chat ở đúng vị trí họ đã dừng (trong vòng 24 giờ).
3. Bàn phím không bao giờ che khuất ô nhập liệu.
4. Khu vực an toàn được tôn trọng — không có khung chat nào hiển thị bên dưới tai thỏ hoặc thanh điều hướng.
5. Không có lỗi sự cố nào ảnh hưởng đến ứng dụng của bạn. Khi tải thất bại, ứng dụng sẽ hiển thị nút thử lại.
6. Không có công cụ phân tích, không có mã nhận danh thiết bị, không có bên thứ ba phụ thuộc. Việc thêm Telybot SDK không làm tăng thêm trình theo dõi nào vào ứng dụng của bạn.
7. Quay lại đóng trước thứ khách hàng đang xem. Trên Android, Quay lại khi đang mở một mặt hàng, giỏ hàng hoặc lịch hẹn sẽ đóng thứ đó, rồi mới đóng chat (SDK 0.2.0 trở lên).

Trong chat

Tất cả những điều này đến từ trang được lưu trữ, nên đến được mọi ứng dụng mà không cần cập nhật SDK:

• Một tin nhắn chào mừng với các nút gợi ý, bằng ngôn ngữ đã đặt cho bot.
• Cuộc trò chuyện được giữ trên thiết bị trong 24 giờ, và chat không tạo id khách truy cập. Trên một trang web, cuộc trò chuyện kéo dài một tab trình duyệt. (Chat toàn màn hình của Ionic SDK cần 0.2.0 cho việc này.)
• Đơn hàng và lịch hẹn, khi doanh nghiệp nhận chúng: giỏ hàng, ngày và giờ hẹn, liên kết để gọi cho doanh nghiệp khi một đơn hàng hoặc lịch hẹn đã chờ quá lâu, và “Thêm vào lịch” cho lịch hẹn đã xác nhận.
• Tệp đính kèm: ảnh (JPEG, PNG, WebP, GIF) và các tệp PDF, DOCX, TXT, CSV và MD. SDK Android và Flutter cần phiên bản 0.1.4 trở lên cho nút đính kèm, và Flutter cần 0.2.0 cho tài liệu.
• “Thêm vào lịch” là liên kết đến một tệp .ics. iOS mở nó trong Lịch dưới dạng một lịch để đăng ký theo dõi. Android gợi ý ứng dụng lịch của điện thoại nếu ứng dụng đó nhập được tệp .ics — Google Lịch hiện tại làm được — còn không thì trình duyệt tải tệp xuống.

Định dạng Client id

kb_live_ followed by 8-48 hexadecimal characters

Bất kỳ điều gì khác đều sẽ bị từ chối khi khởi tạo thay vì hiển thị lỗi 404 trước mặt khách hàng. Client id được thiết kế để công khai — nó hiển thị trên bất kỳ trang nào nhúng widget — và không có khả năng đọc hoặc thay đổi tài khoản của bạn. Xem thêm tại giới hạn và bảo mật.

Nguồn

Công khai, theo giấy phép MIT: github.com/telybotai/telybot-Sdks. Thỏa thuận chung mà mọi gói phải tuân theo nằm ở CONTRACT.md ở đầu kho lưu trữ đó.