GET/api/public/widget/history

โหลดประวัติข้อความก่อนหน้าของการสนทนาในวิดเจ็ต เช่น หลังจากโหลดหน้าใหม่

ส่ง `widget_code`, `session_id`, และ `visitor_id` เป็นพารามิเตอร์คำค้นหา การตอบกลับจะมีรายการ `messages` ในออบเจ็กต์ `data` พร้อม `role` (`user` หรือ `assistant`), `text`, และ `created_at` ตามลำดับการสนทนา การเรียกนี้เป็นแบบอ่านอย่างเดียวและเป็น idempotent จำเป็นต้องมีส่วนหัว `X-Widget-Token` พร้อม Embed Token และ `widget_code` หากโทเค็นหายไป เซิร์ฟเวอร์จะตอบกลับด้วย 401 `WIDGET_TOKEN_MISSING` หากไม่ถูกต้องคือ 401 `WIDGET_TOKEN_INVALID` การเรียกจากโดเมนที่ไม่ได้รับอนุมัติจะได้รับ 403 `WIDGET_ORIGIN_DENIED` วิดเจ็ตที่ถูกปิดใช้งานจะได้รับ 404 `WIDGET_DISABLED` หาก `session_id` หรือ `visitor_id` หายไป เซิร์ฟเวอร์จะตอบกลับด้วย 400 `PARAMS_REQUIRED` หากเซสชันไม่เป็นที่รู้จักอีกต่อไป ให้เริ่มการสนทนาใหม่

ภาพรวม

การเรียกใช้: GET /api/public/widget/history เอนด์พอยต์นี้อยู่ในกลุ่ม “แชทวิดเจ็ต” ของ API ของ Zentor App เอนด์พอยต์นี้ต้องใช้โทเค็นฝังวิดเจ็ต (widget embed token) ที่ถูกต้อง การเรียกใช้นี้เป็นแบบ idempotent: การเรียกซ้ำด้วยข้อมูลเดิมจะได้ผลลัพธ์เดิม พารามิเตอร์ที่จำเป็น: widget_code (query), session_id (query), visitor_id (query) กรณีข้อผิดพลาดที่จัดทำเอกสารไว้: 400 PARAMS_REQUIRED ตัวอย่างการตอบกลับด้านล่างแสดงโครงสร้างของการตอบกลับที่สำเร็จในรูปแบบ JSON

การยืนยันตัวตนและความปลอดภัย

Widget-Embed-Token (Header X-Widget-Token) + รายการ Origin ที่อนุญาต

Idempotent (เรียกซ้ำได้ผลเหมือนเดิม): ใช่

พารามิเตอร์

widget_code(query, string, จำเป็น)— โค้ดวิดเจ็ตจากโค้ดฝังของคุณ
session_id(query, string, จำเป็น)— Session ID ของการสนทนาจากการตอบกลับของ `message`
visitor_id(query, string, จำเป็น)— Visitor ID ที่สร้างโดยวิดเจ็ตและจัดเก็บไว้ในเบราว์เซอร์

ตัวอย่างการตอบกลับ

{"ok":true,"data":{"messages":[{"role":"user","text":"สวัสดี...","created_at":"..."},{"role":"assistant","text":"...","created_at":"..."}]}}

รหัสข้อผิดพลาด

400 PARAMS_REQUIRED — `session_id` หรือ `visitor_id` หายไป

พฤติกรรมที่ตรวจสอบแล้ว

เซสชันที่มีอยู่จะได้รับ 200 พร้อมประวัติข้อความ พารามิเตอร์ที่หายไปจะได้รับ 400 `PARAMS_REQUIRED`

แชทวิดเจ็ต

GET /api/public/widget/healthตรวจสอบความพร้อมใช้งานของบริการวิดเจ็ตแบบง่าย ๆGET /api/public/widget/config/:widget_codeส่งคืนการตั้งค่าสาธารณะของวิดเจ็ต (ชื่อที่แสดง ข้อความต้อนรับ ดีไซน์ ภาษา ฟังก์ชันเสียง) สำหรับการเริ่มต้นในเบราว์เซอร์POST /api/public/widget/messageส่งข้อความของผู้เยี่ยมชมไปยังแชทบอทและส่งคำตอบกลับมา – เอนด์พอยต์หลักของแชทวิดเจ็ตPOST /api/public/widget/pollดึงข้อความที่มาถึงหลังจากเวลาที่ระบุ – เช่น คำตอบของพนักงานที่รับช่วงการสนทนาPOST /api/public/widget/ratingจัดเก็บคะแนนของผู้เยี่ยมชมสำหรับบทสนทนา (มีประโยชน์หรือไม่มีประโยชน์)POST /api/public/widget/trackบันทึกเหตุการณ์การใช้งานแบบไม่ระบุตัวตนของวิดเจ็ต (เช่น “วิดเจ็ตถูกเปิด”) สำหรับการวิเคราะห์ในแดชบอร์ดPOST /api/public/widget/voice-transcribeแปลงการบันทึกเสียงของผู้เยี่ยมชมเป็นข้อความ (การป้อนด้วยเสียง) หากเปิดใช้งานฟังก์ชันเสียงสำหรับวิดเจ็ตPOST /api/public/widget/voice-speakแปลงข้อความเป็นเสียงพูด (การส่งออกด้วยเสียงในวิดเจ็ต) หากเปิดใช้งานฟังก์ชันเสียงแล้ว

บทความที่เกี่ยวข้อง

← แชทวิดเจ็ต