ข้อมูลอ้างอิง SDK

Telybot SDK ทุกตัว ไม่ว่าจะเป็น Android, iOS, React Native, Flutter, Ionic ต่างใช้สัญญาการทำงานชุดเดียวกัน หากคุณเคยใช้ตัวใดตัวหนึ่งแล้ว คุณก็สามารถใช้ตัวอื่นๆ ได้ทันที

API

โทร	สิ่งที่ระบบทำได้
`init` / `initialize`	จัดเก็บ Client ID ของคุณ ตรวจสอบความถูกต้อง และแจ้งเตือนทันทีหากรูปแบบไม่ถูกต้อง
`show`	แสดงแชททับแอปของคุณ รับคำถามเพิ่มเติมสำหรับช่องข้อความได้ (0.2.0)
`dismiss`	ปิดหน้าต่าง
`isShowing`	ว่ามีการแสดงผลอยู่หรือไม่ในขณะนี้
แชทแบบฝัง	แชทภายในหน้าจอของคุณเอง เช่น แท็บช่วยเหลือ (0.2.0)
`onShow` / `onDismiss`	แจ้งเมื่อแชทเปิดและปิด บน Android และ iOS (0.2.0)
`setVisitor`	ชื่อ โทรศัพท์ และอีเมลของลูกค้าที่ลงชื่อเข้าใช้แล้ว เสนอให้ในฟอร์มของแชท (0.2.0)
`hasUnreadReply` / `onReply`	การตอบกลับจากทีมของคุณที่ลูกค้ายังไม่เห็น (0.2.0)

เปิดพร้อมคำถาม ส่งคำถามให้ show แล้วคำถามจะอยู่ในช่องข้อความของแชท ลูกค้าอ่านแล้วแตะส่ง คำถามเดินทางใน #fragment ของลิงก์ จึงไม่เคยไปถึงล็อกของเซิร์ฟเวอร์ สูงสุด 500 ตัวอักษร ในบรรทัดเดียว

แชทภายในหน้าจอของคุณเอง Android KeydaBotView, iOS KeydaBot.makeChatViewController หรือ SwiftUI KeydaBotView, React Native <KeydaBotChat />, Flutter KeydaBotChat และ embedWidget() ของแพ็กเกจ Ionic ไม่มีปุ่มปิด — การนำทางของหน้าจอคุณคือทางออก บน Android ปุ่มย้อนกลับจะปิดรายการหรือตะกร้าที่เปิดอยู่ก่อน: React Native และ Flutter ทำให้คุณเองขณะที่แชทเป็นหน้าจอด้านหน้า และกับ KeydaBotView แบบเนทีฟ การจัดการย้อนกลับของคุณจะเรียก goBack() ของมัน

ลูกค้าที่ลงชื่อเข้าใช้ของคุณ ส่งชื่อ หมายเลขโทรศัพท์ หรืออีเมลของลูกค้าให้ SDK แล้วแชทจะเติมสิ่งที่แอปของคุณรู้อยู่แล้ว ข้อมูลจะถูกเสนอให้ ไม่มีการส่งเอง: จะปรากฏในฟอร์ม “คุยกับคน” คำสั่งซื้อ การจอง และคำถามต้อนรับที่ขอชื่อ โทรศัพท์ หรืออีเมล แล้วลูกค้าเป็นผู้ส่งเอง ข้อมูลเดินทางใน #fragment ของลิงก์ และเป็นคำบอกจากแอปของคุณ ไม่ใช่ตัวตนที่ยืนยันแล้ว ค่าที่แชทจะปฏิเสธจะถูกตัดออก: ชื่อยาวกว่า 80 ตัวอักษร หมายเลขโทรศัพท์ที่ไม่มี 8 ถึง 15 หลัก ที่อยู่อีเมลที่ไม่มีโดเมนที่ถูกต้อง แชทแบบเต็มหน้าจอของ Ionic เปิดในเบราว์เซอร์ของระบบซึ่งเก็บที่อยู่ไว้ในประวัติ จึงไม่รับข้อมูลเหล่านี้ ส่วนวิดเจ็ตแบบฝังรับได้

การตอบกลับขณะที่แชทปิดอยู่ เมื่อลูกค้าขอคุยกับคนแล้วปิดแชท คำตอบของคุณจากแดชบอร์ดจะรออยู่ในบทสนทนา SDK สำหรับ Android, iOS, React Native และ Flutter จะตรวจสอบเมื่อแอปของคุณกลับมาอยู่หน้าสุดและแจ้งแอปของคุณ เพื่อให้คุณแสดงจุดบนปุ่มแชทได้จนกว่าลูกค้าจะเปิดแชท โดยจะถามเฉพาะแชทที่ลูกค้าขอคุยกับคนภายใน 14 วันที่ผ่านมาเท่านั้น แชทที่แอปของคุณโหลดไว้นอกสายตา เช่น แท็บช่วยเหลือที่อยู่เบื้องหลัง จะไม่นับว่าอ่านแล้ว จุดจะคงอยู่จนกว่าลูกค้าจะดู นี่ไม่ใช่การแจ้งเตือนแบบพุช การตอบกลับจะถูกสังเกตเมื่อเปิดแอป

ตั้งใจไม่มีอย่างอื่นอีก ไม่มี API ส่งข้อความและไม่มีการเรียกตัวตนผู้ใช้ — เพราะทั้งสองอย่างยังทำงานไม่ครบตั้งแต่ต้นจนจบ และเมธอดที่ใช้ไม่ได้นั้นแย่กว่าเมธอดที่ไม่มี

URL ที่ SDK ทุกตัวเปิดใช้งาน

{baseUrl}/chat/{clientId}

baseUrl มีค่าเริ่มต้นเป็น https://telybot.com และสามารถแทนที่ได้ในทุกแพลตฟอร์ม สำหรับการทดสอบ (staging) หรือการติดตั้งด้วยตนเอง

ทำไมต้องใช้เว็บวิว และมีค่าใช้จ่ายอย่างไร

มีอินเทอร์เฟซแชทเพียงรูปแบบเดียวที่ให้บริการโดยแพลตฟอร์ม และทุกช่องทางจะโหลดอินเทอร์เฟซเดียวกันนี้

สิ่งที่คุณจะได้รับ: การเปลี่ยนแปลงที่เจ้าของทำในแดชบอร์ด ไม่ว่าจะเป็นสีเน้น ข้อความต้อนรับ ชื่อบอท หรือการเปิดใช้งาน จะส่งผลไปยังทุกแอปทันทีโดยไม่ต้องปล่อยอัปเดต การแก้ไขจะเกิดขึ้นพร้อมกันทุกที่ แชทจะมีรูปแบบเหมือนกันในทุกแพลตฟอร์ม

ค่าใช้จ่าย: การแชทจำเป็นต้องมีการเชื่อมต่ออินเทอร์เน็ต ปัจจุบันยังไม่มีโหมดออฟไลน์และยังไม่มีการแจ้งเตือนแบบ Push Notification

เราอยากให้คุณทราบเรื่องนี้ก่อนที่จะเริ่มใช้งานจริง ดีกว่ามาพบภายหลัง

การรับประกันที่ SDK แต่ละตัวมอบให้

การนำทางออกนอกหน้าต่างแชท ลิงก์ไปยังแหล่งอื่นจะเปิดในเบราว์เซอร์ของระบบแทนที่จะแทนที่หน้าต่างแชท หากไม่มีสิ่งนี้ การแตะลิงก์ที่ส่วนท้ายเพียงครั้งเดียวจะทำให้การสนทนาของลูกค้าสิ้นสุดลงโดยไม่มีทางกลับมา
ความต่อเนื่องของบทสนทนา ระบบเปิดใช้งาน DOM storage ไว้ ดังนั้นหากลูกค้าปิดแอปแล้วกลับเข้ามาใหม่ จะยังคงเห็นบทสนทนาเดิมค้างอยู่ (ภายใน 24 ชั่วโมง)
คีย์บอร์ดจะไม่บังช่องกรอกข้อมูล
รองรับพื้นที่ปลอดภัย — แชทจะไม่ถูกแสดงทับรอยบากหน้าจอหรือแถบโฮม
ไม่มีการแครชในแอปของคุณ หากโหลดข้อมูลล้มเหลว ระบบจะแสดงปุ่มให้ลองใหม่
ไม่มีการวิเคราะห์ ไม่มีตัวระบุอุปกรณ์ และไม่มีการพึ่งพาบุคคลที่สาม การเพิ่ม Telybot SDK จะไม่เพิ่มตัวติดตามลงในแอปของคุณ
ปุ่มย้อนกลับจะปิดสิ่งที่ลูกค้ากำลังดูก่อน บน Android การย้อนกลับขณะเปิดรายการ ตะกร้า หรือการจองอยู่จะปิดสิ่งนั้นก่อน แล้วจึงปิดแชท (SDK 0.2.0 ขึ้นไป)

ในแชท

ทั้งหมดนี้มาจากหน้าที่โฮสต์ไว้ จึงไปถึงทุกแอปโดยไม่ต้องอัปเดต SDK:

ข้อความต้อนรับพร้อมปุ่มคำแนะนำ ในภาษาที่ตั้งค่าไว้สำหรับบอต
บทสนทนาจะถูกเก็บไว้ในอุปกรณ์ 24 ชั่วโมง และแชทไม่สร้างรหัสผู้เยี่ยมชม บนเว็บไซต์ บทสนทนาอยู่ได้หนึ่งแท็บเบราว์เซอร์ (แชทแบบเต็มหน้าจอของ Ionic SDK ต้องใช้ 0.2.0 สำหรับเรื่องนี้)
คำสั่งซื้อและการจอง เมื่อธุรกิจเปิดรับ: ตะกร้า วันและเวลาจอง ลิงก์โทรหาธุรกิจเมื่อคำสั่งซื้อหรือการจองรอนานเกินไป และ “เพิ่มลงในปฏิทิน” สำหรับการจองที่ยืนยันแล้ว
ไฟล์แนบ: รูปภาพ (JPEG, PNG, WebP, GIF) และไฟล์ PDF, DOCX, TXT, CSV และ MD ปุ่มแนบไฟล์ต้องใช้ SDK ของ Android และ Flutter เวอร์ชัน 0.1.4 ขึ้นไป และเอกสารต้องใช้ Flutter 0.2.0
“เพิ่มลงในปฏิทิน” คือลิงก์ไปยังไฟล์ .ics iOS จะเปิดในแอปปฏิทินเป็นปฏิทินให้สมัครรับ Android จะเสนอแอปปฏิทินของโทรศัพท์หากแอปนั้นนำเข้าไฟล์ .ics ได้ — Google Calendar รุ่นปัจจุบันทำได้ — ไม่เช่นนั้นเบราว์เซอร์จะดาวน์โหลดไฟล์

รูปแบบ Client ID

kb_live_ followed by 8-48 hexadecimal characters

ข้อมูลอื่นใดจะถูกปฏิเสธตั้งแต่ขั้นตอน init แทนที่จะแสดงหน้า 404 ต่อหน้าลูกค้า Client ID ถูกออกแบบมาให้เป็นสาธารณะ ซึ่งสามารถมองเห็นได้ในเว็บไซต์ใดก็ตามที่ฝังวิดเจ็ตนี้ และไม่มีสิทธิ์ในการอ่านหรือเปลี่ยนแปลงบัญชีของคุณ ดูเพิ่มเติมที่ ข้อจำกัดและความปลอดภัย

แหล่งที่มา

เป็นสาธารณะและใช้สัญญาอนุญาตแบบ MIT: github.com/telybotai/telybot-Sdks ข้อตกลงร่วมที่ทุกแพ็กเกจต้องปฏิบัติตามอยู่ใน CONTRACT.md ที่ด้านบนของที่เก็บข้อมูลนั้น