Message Endpoint API
ต้องการส่งข้อความไปยังบอท DealDroid ของคุณจากแอปพลิเคชันของคุณเองหรือไม่? Message Endpoint API ช่วยให้คุณส่งข้อความในนามของลูกค้าได้แบบอัตโนมัติ ทำให้คุณสามารถผสานรวม DealDroid เข้ากับเวิร์กโฟลว์ที่กำหนดเอง แอปมือถือ หรือระบบของบริษัทอื่นได้
คุณสามารถทำอะไรได้บ้างกับ Endpoint API?
Section titled “คุณสามารถทำอะไรได้บ้างกับ Endpoint API?”Message Endpoint API ช่วยให้คุณสามารถ:
- 📱 สร้างอินเทอร์เฟซแชทที่กำหนดเอง — สร้างแอปมือถือหรือ UI แชทบนเว็บของคุณเอง
- 🔗 เชื่อมต่อระบบภายนอก — ผสานรวมกับ CRM, ตั๋วสนับสนุน หรือแพลตฟอร์มอื่นๆ
- 🤖 ทำการสนทนาอัตโนมัติ — เรียกใช้การโต้ตอบของบอทจากระบบแบ็กเอนด์ของคุณ
- 💬 ส่งข้อความในนามของผู้ใช้ — ส่งต่อข้อความของลูกค้าผ่านโครงสร้างพื้นฐานของคุณ
- 🧪 ทดสอบบอทของคุณ — ทดสอบขั้นตอนการสนทนาแบบอัตโนมัติ
เริ่มต้นใช้งาน
Section titled “เริ่มต้นใช้งาน”Base URL
Section titled “Base URL”เข้าถึง API endpoints ทั้งหมดผ่าน:
https://your-dealdroid.com/api/droids/:droidId/endpoint/แทนที่ :droidId ด้วย Droid ID จริงของคุณ (คุณสามารถหาได้ในแดชบอร์ด DealDroid ของคุณ)
การยืนยันตัวตน
Section titled “การยืนยันตัวตน”endpoints ทั้งหมดต้องใช้ Bearer token ใน header Authorization
ตัวอย่าง header:
Authorization: Bearer <your-token>สำคัญ: เก็บ token ของคุณให้ปลอดภัยและอย่าเปิดเผยในโค้ดฝั่งไคลเอนต์หรือ repositories สาธารณะ
รับ API Token ของคุณ
Section titled “รับ API Token ของคุณ”
เพื่อรับ API token ของคุณ:
- เข้าสู่ระบบแดชบอร์ด DealDroid ของคุณ
- ไปที่ Automation Panel จากแถบด้านข้างซ้าย
- ค้นหา automation “When Receive message from Third Party”
- Bearer token ของคุณจะแสดงที่นี่
- คัดลอกและเก็บไว้อย่างปลอดภัย
การหมุนเวียน Token ของคุณ
Section titled “การหมุนเวียน Token ของคุณ”หากคุณต้องการสร้าง token ใหม่ (เช่น ด้วยเหตุผลด้านความปลอดภัย):
- เปิด Automation Panel
- ค้นหา “When Receive message from Third Party”
- คลิก Regenerate เพื่อสร้าง token ใหม่
- อัปเดตแอปพลิเคชันของคุณด้วย token ใหม่
⚠️ คำเตือน: การสร้าง token ใหม่จะทำให้ token เก่าใช้งานไม่ได้ทันที ตรวจสอบให้แน่ใจว่าได้อัปเดตแอปพลิเคชันทั้งหมดที่ใช้ API
API Endpoints ที่มีให้ใช้งาน
Section titled “API Endpoints ที่มีให้ใช้งาน”DealDroid มี API endpoints 7 ตัวเพื่อโต้ตอบกับบอทของคุณ ด้านล่างนี้คือภาพรวมของ endpoints ที่มีให้ใช้งาน:
1. Send Text Message
Section titled “1. Send Text Message”ส่งข้อความไปยังบอท DealDroid ของคุณในนามของลูกค้า
Endpoint: POST /api/droids/:droidId/endpoint/send
กรณีการใช้งาน: ส่งข้อความของลูกค้าไปยังบอทของคุณจากแอปพลิเคชันหรือระบบที่กำหนดเอง
2. Get Channels
Section titled “2. Get Channels”ดึงรายการช่องทางที่กำหนดค่าไว้สำหรับ droid ของคุณ
Endpoint: GET /api/droids/:droidId/endpoint/channels
กรณีการใช้งาน: รับข้อมูลเกี่ยวกับช่องทางการสื่อสารทั้งหมด (LINE, Facebook, WhatsApp ฯลฯ) ที่เชื่อมต่อกับบอทของคุณ
3. Get Messages
Section titled “3. Get Messages”ดึงข้อความการสนทนาสำหรับลูกค้าที่ระบุ
Endpoint: GET /api/droids/:droidId/endpoint/messages/:customerId
กรณีการใช้งาน: แสดงการสนทนาที่ผ่านมาในอินเทอร์เฟซแชทที่กำหนดเองหรือเพื่อวัตถุประสงค์ในการวิเคราะห์
4. Get Customer Config
Section titled “4. Get Customer Config”รับข้อมูลโดยละเอียดและการกำหนดค่าสำหรับลูกค้าที่ระบุ
Endpoint: GET /api/droids/:droidId/endpoint/customer/:customerId
กรณีการใช้งาน: ดึงข้อมูลโปรไฟล์ลูกค้า รวมถึงชื่อ ข้อมูลติดต่อ การตั้งค่าภาษา และสถานะการเปิดใช้งานบอท
ตัวอย่างการตอบกลับรวมถึง: customerId, externalId, channelId, botEnabled, avatar, socialName, name, phone, address, city, zipcode, email, language และอื่นๆ
5. Update Customer
Section titled “5. Update Customer”เปิดหรือปิดใช้งานบอทสำหรับลูกค้าที่ระบุ
Endpoint: POST /api/droids/:droidId/endpoint/customer/:customerId
พารามิเตอร์ Body: botEnabled (boolean) - ตั้งค่าเป็น true เพื่อเปิดใช้งาน, false เพื่อปิดใช้งานบอทสำหรับลูกค้ารายนี้
กรณีการใช้งาน: สลับการทำงานอัตโนมัติของบอทเปิด/ปิดสำหรับลูกค้าที่ระบุ (เช่น เมื่อต้องการให้มนุษย์เข้ามาจัดการ)
6. Get Droid Answer
Section titled “6. Get Droid Answer”ให้ DealDroid สร้างการตอบกลับที่ขับเคลื่อนด้วย AI โดยอิงจากประวัติการแชทและข้อความใหม่
Endpoint: POST /api/droids/:droidId/endpoint/get-droid-answer
พารามิเตอร์ Body:
humanMessage(string) - ข้อความใหม่ที่ต้องการรับการตอบกลับchatHistory(array) - ข้อความการสนทนาก่อนหน้าเพื่อเป็นบริบท
กรณีการใช้งาน:
-
โหมดตอบกลับเท่านั้น: ใช้เมื่อคุณต้องการให้ DealDroid สร้างการตอบกลับเท่านั้นโดยไม่ต้องจัดการขั้นตอนการสนทนา แอปพลิเคชันของคุณจัดการการแชทในขณะที่ DealDroid ให้การตอบกลับที่ชintelligent
-
ความช่วยเหลือสำหรับแอดมิน: สร้างการตอบกลับที่แนะนำสำหรับเจ้าหน้าที่มนุษย์ แทนที่จะให้ DealDroid ตอบกลับอัตโนมัติ ใช้ endpoint นี้เพื่อเตรียมร่างการตอบกลับที่แอดมินสามารถตรวจสอบ แก้ไข และส่งด้วยตนเอง
ส่งคืน: การตอบกลับของ AI, ข้อมูลเชิงลึกของลูกค้า (Intent, ภาษา, คำหลักผลิตภัณฑ์), ข้อมูลตะกร้าสินค้า และการแยกวิเคราะห์ที่อยู่
7. Get Alternative Text
Section titled “7. Get Alternative Text”สร้างคำอธิบายข้อความทางเลือกที่ขับเคลื่อนด้วย AI สำหรับรูปภาพที่ผู้ใช้ส่งมา
Endpoint: POST /api/droids/:droidId/endpoint/get-image-alt
พารามิเตอร์ Body: imageUrl (string) - URL ของรูปภาพที่จะวิเคราะห์ (รองรับ .jpg, .jpeg, .png, .gif, .webp)
กรณีการใช้งาน: สร้างคำอธิบายรูปภาพสำหรับรูปภาพที่ผู้ใช้อัปโหลดก่อนส่งไปยัง AI เพื่อสร้างการตอบกลับ (Get Droid Answer) โดยค่าเริ่มต้น หากรูปภาพที่ส่งไปยัง AI ไม่มีข้อความทางเลือก AI จะสร้างคำอธิบายโดยอัตโนมัติ อย่างไรก็ตาม หากคุณสร้างคำอธิบายล่วงหน้าโดยใช้ endpoint นี้และรวมไว้กับรูปภาพ AI จะข้ามขั้นตอนการสร้างคำอธิบาย ซึ่งจะช่วยเพิ่มความเร็วในการตอบกลับอย่างมาก
ส่งคืน: alt text ที่สร้างโดย AI, เวลาในการดำเนินการ และข้อมูลเมตาสำหรับการติดตาม
เอกสารโดยละเอียด
Section titled “เอกสารโดยละเอียด”สำหรับข้อกำหนดที่สมบูรณ์ ตัวอย่าง request/response และการทดสอบแบบโต้ตอบของ endpoints ทั้งหมด โปรดดูเอกสาร Postman ของเรา:
📘 ดูเอกสาร API ฉบับเต็มบน Postman
เอกสาร Postman รวมถึง:
- ✅ ข้อกำหนด endpoint โดยละเอียด
- ✅ พารามิเตอร์ที่จำเป็นและเป็นตัวเลือก
- ✅ ตัวอย่าง request body
- ✅ รูปแบบและตัวอย่างการตอบกลับ
- ✅ รหัสและข้อความข้อผิดพลาด
- ✅ สภาพแวดล้อมการทดสอบ API แบบโต้ตอบ
คำถามที่พบบ่อย
Section titled “คำถามที่พบบ่อย”Q: ฉันได้รับ 403 Forbidden ทำไม?
Section titled “Q: ฉันได้รับ 403 Forbidden ทำไม?”A: คุณอาจใช้ customerId หรือ droidId ที่ผิด หรือ token ของคุณไม่มีสิทธิ์เข้าถึงลูกค้ารายนี้
Q: ฉันจะหมุนเวียน token ของฉันได้อย่างไร?
Section titled “Q: ฉันจะหมุนเวียน token ของฉันได้อย่างไร?”A: เปิด Automation Panel ของ DealDroid ค้นหา “When Receive message from Third Party” และคลิก Regenerate เพื่อเปลี่ยน token สำหรับ endpoint
Q: ฉันสามารถส่งรูปภาพได้หรือไม่?
Section titled “Q: ฉันสามารถส่งรูปภาพได้หรือไม่?”A: ได้ คุณสามารถส่ง URL รูปภาพในฟิลด์ humanMessage เมื่อใช้ Send Text Message endpoint ตรวจสอบให้แน่ใจว่า URL สามารถเข้าถึงได้แบบสาธารณะ
Q: มีการจำกัดอัตราหรือไม่?
Section titled “Q: มีการจำกัดอัตราหรือไม่?”A: การจำกัดอัตราแตกต่างกันไปตามแผน ติดต่อแอดมิน DealDroid ของคุณสำหรับข้อจำกัดเฉพาะในบัญชีของคุณ
Q: ฉันสามารถใช้สิ่งนี้ในแอปพลิเคชันเบราว์เซอร์ได้หรือไม่?
Section titled “Q: ฉันสามารถใช้สิ่งนี้ในแอปพลิเคชันเบราว์เซอร์ได้หรือไม่?”A: ด้วยเหตุผลด้านความปลอดภัย คุณควรเรียก API จากเซิร์ฟเวอร์แบ็กเอนด์ของคุณเท่านั้น อย่าเปิดเผย Bearer token ของคุณใน JavaScript ฝั่งไคลเอนต์
Q: ฉันจะรู้ได้อย่างไรว่าจะใช้ customerId ใด?
Section titled “Q: ฉันจะรู้ได้อย่างไรว่าจะใช้ customerId ใด?”A: คุณสามารถรับ customerId จาก webhook payloads เมื่อได้รับข้อความจากลูกค้า
Q: จะเกิดอะไรขึ้นหาก token ของฉันถูกบุกรุก?
Section titled “Q: จะเกิดอะไรขึ้นหาก token ของฉันถูกบุกรุก?”A: สร้าง token ของคุณใหม่ทันทีใน Automation Panel token เก่าจะถูกยกเลิกทันที
เอกสารอ้างอิง API ฉบับสมบูรณ์
Section titled “เอกสารอ้างอิง API ฉบับสมบูรณ์”สำหรับเอกสาร API ที่ทันสมัยและครอบคลุมที่สุด รวมถึง endpoints พารามิเตอร์ และตัวอย่างทั้งหมด โปรดดูเอกสาร Postman ของเรา:
📘 ดูเอกสาร API ฉบับเต็มบน Postman
เอกสาร Postman เป็นแหล่งข้อมูลหลักของเรา และได้รับการอัปเดตอย่างต่อเนื่องด้วยฟีเจอร์และการปรับปรุงล่าสุด
เสร็จเรียบร้อย! 🎉
Section titled “เสร็จเรียบร้อย! 🎉”คุณพร้อมที่จะผสานรวม DealDroid เข้ากับแอปพลิเคชันของคุณแล้ว!
ด้วย Message Endpoint API คุณสามารถสร้างการผสานรวมที่กำหนดเองที่ทรงพลังซึ่งขยายการเข้าถึงของบอทของคุณนอกเหนือจากแพลตฟอร์มการส่งข้อความแบบดั้งเดิม ไม่ว่าคุณจะกำลังสร้างแอปมือถือ เชื่อมต่อกับ CRM หรือทำเวิร์กโฟลว์อัตโนมัติ — API ของ DealDroid ทำให้เป็นไปได้
อย่าลืมเก็บ tokens ของคุณให้ปลอดภัยและดูเอกสาร Postman สำหรับข้อกำหนด API ที่สมบูรณ์
ต้องการความช่วยเหลือหรือไม่? เรายินดีสนับสนุนคุณ! 😊