ภาพรวม

Quickchat AI มี REST API สำหรับเข้าถึงการตั้งค่า AI Agent ฐานความรู้ บทสนทนา การดำเนินการ AI และอื่น ๆ ด้วยโปรแกรม

ตัวอย่างการตรวจสอบเพิ่มเติม

• เปรียบเทียบวิธีติดตั้ง ตรวจสอบช่องทาง สิทธิ์เข้าถึงเว็บไซต์ และฟีเจอร์ที่คุณระบุเทียบกับตัวเลือกการตั้งค่า Quickchat AI การตรวจสอบนี้ไม่วิเคราะห์เว็บไซต์หรือบัญชีของคุณ

• ตรวจสอบตัวอย่างการเชื่อมต่อ MCP เริ่มต้นการเชื่อมต่อและแสดงเครื่องมือของเอนด์พอยต์เอกสาร Cloudflare หรือ Microsoft Learn เท่านั้น ไม่มีการเข้าสู่ระบบหรือเรียกใช้เครื่องมือ

การยืนยันตัวตน

ทุกเอนด์พอยต์ API ใช้การยืนยันตัวตนด้วยโทเคน Bearer ใส่โทเคน API ในส่วนหัว Authorization ของทุกคำขอ:

Authorization: Bearer <API_TOKEN>

สร้างโทเคนใน แดชบอร์ด Quickchat ที่ แอปภายนอก > API แต่ละโทเคนเป็น JWT ที่มี scenario_id ของคุณ จึงไม่ต้องมีส่วนหัวระบุตัวตนเพิ่มเติม

• อายุโทเคน: 52 สัปดาห์ นับจากสร้าง
• สามารถ เพิกถอน โทเคนจากแดชบอร์ดได้ทุกเมื่อ
• แต่ละโทเคนจำกัดขอบเขตไว้ที่ AI Agent (scenario) เดียว
• การสร้างโทเคนต้องใช้ แพ็กเกจ Business ขึ้นไป ในแพ็กเกจที่ต่ำกว่าตัวเลือกจะปิดใช้งาน และเอนด์พอยต์ส่งกลับ 402 Payment Required

หมายเหตุ

เอนด์พอยต์แชตแบบเรียลไทม์ (POST https://app.quickchat.ai/chat) รับโทเคน Bearer เดียวกับ API ส่วนอื่น แต่อยู่นอกเส้นทางหลัก /v1/api/ และต้องระบุ scenario_id ในเนื้อหาคำขอ ดูรายละเอียดทั้งหมดในหน้า แชต

ขอบเขตสิทธิ์ของโทเคน

โทเคน API สร้างได้ด้วยหนึ่งในสองขอบเขตสิทธิ์:

ขอบเขตสิทธิ์	ระดับการเข้าถึง	คำอธิบาย
read_all	อ่านอย่างเดียว	อ่านทรัพยากรทั้งหมดได้ แต่สร้าง อัปเดต หรือลบไม่ได้
write_all	อ่านและเขียน	เข้าถึงทุกเอนด์พอยต์ รวมถึงการเขียนข้อมูล

• กำหนดขอบเขตสิทธิ์เมื่อสร้างโทเคนในแดชบอร์ดที่ แอปภายนอก > API
• ขอบเขต write_all รวมสิทธิ์ทั้งหมดของ read_all โดยอัตโนมัติ
• การใช้โทเคน read_all กับเอนด์พอยต์เขียนข้อมูลจะได้ 403 พร้อม "Insufficient token scope. Required: write_all"

เคล็ดลับ

ใช้โทเคน read_all สำหรับติดตาม ตรวจวิเคราะห์ และการเชื่อมต่อที่อ่านอย่างเดียว ใช้ write_all เฉพาะเมื่อการเชื่อมต่อต้องสร้างหรือแก้ไขทรัพยากร

ขอบเขตสิทธิ์ที่แต่ละกลุ่มเอนด์พอยต์ต้องการ:

กลุ่มเอนด์พอยต์	การอ่าน	การเขียน
การตั้งค่าแชตบอต	read_all	write_all
การตั้งค่าฐานความรู้	read_all	write_all
บทความ	read_all	write_all
URL บทความแต่ละภาษา	read_all	write_all
แท็ก	read_all	ไม่มี
อัปโหลดไฟล์	ไม่มี	write_all
นำเข้าเนื้อหาภายนอก	ไม่มี	write_all
ฐานความรู้ Intercom	read_all	write_all
การตั้งค่าวิดเจ็ต	read_all	write_all
การสนทนา	read_all	ไม่มี
เมทาดาทาของบทสนทนา	read_all	write_all
การตั้งค่าการส่งต่อ	read_all	write_all
คะแนนการสนทนา	read_all	write_all
การดำเนินการ AI	read_all	write_all

URL หลัก

กลุ่มเอนด์พอยต์	URL หลัก
ฐานความรู้ การดำเนินการ AI อัปโหลดไฟล์ นำเข้า การตั้งค่าแชตบอต วิดเจ็ต การส่งต่อ คะแนนการสนทนา	https://app.quickchat.ai/v1/api/
การสนทนา	https://app.quickchat.ai/v1/api_core/
แชตแบบเรียลไทม์	https://app.quickchat.ai/chat

ขีดจำกัดอัตราคำขอ

ขีดจำกัดอัตราคำขอใช้แยกตามโทเคนและเอนด์พอยต์

ประเภท	ขีดจำกัด	ใช้กับ
READ	120 คำขอ/นาที	GET และการแสดงรายการ
WRITE	60 คำขอ/นาที	POST, PATCH, PUT, DELETE
HEAVY	20 คำขอ/นาที	อัปโหลดไฟล์ นำเข้า และดึงเนื้อหาเว็บ

เมื่อเกินขีดจำกัด API จะส่งกลับ HTTP 429 Too Many Requests

Webhooks

Quickchat AI ไม่ ส่ง webhook ออกไป ไม่มีการสมัครรับเหตุการณ์เพื่อให้เราส่ง POST ไปยังเอนด์พอยต์ของคุณเมื่อมีข้อความเข้า มีการส่งต่อ หรือปิดบทสนทนา

ทางเลือกที่มีรองรับจุดประสงค์ต่างกัน:

• การดำเนินการ AI เรียก API ของคุณระหว่างสนทนา API Actions มีโหมด ให้ AI ตัดสินใจ, ก่อนตอบครั้งแรก และ เมื่อเมทาดาทาตรงตามเงื่อนไข โหมดอัตโนมัติพยายามเรียกหนึ่งครั้งต่อบทสนทนาภายใต้เงื่อนไขที่ระบุ ไม่ใช่การสมัครรับทุกข้อความหรือทุกการส่งต่อ ใช้กับงานอย่างบันทึกลีดหรือแจ้งระบบเมื่อข้อมูลที่ต้องการพร้อม
• Google Sheets เพิ่มแถวเมื่อการดำเนินการทำงาน ไม่ได้บันทึกทุกข้อความหรือทุกการส่งต่อโดยอัตโนมัติ
• เรียกตรวจสอบ API การสนทนา เป็นระยะ เพื่อดึงบทสนทนาที่เก็บไว้และเหตุการณ์ รวมถึงข้อความและเครื่องหมายการส่งต่อที่บันทึกไว้ ใช้การแบ่งหน้าและเคารพขีดจำกัด READ ข้างต้น การเรียกเป็นระยะมีความล่าช้า และการเปรียบเทียบสถานะระหว่างรอบอาจพลาดการเปลี่ยนแปลงระหว่างทาง อย่าถือว่าเป็นประวัติครบถ้วนของทุกการส่งต่อหรือการเปลี่ยนผู้รับผิดชอบ

การเข้าถึง API ต้องใช้แพ็กเกจ Business ดู แพ็กเกจและขีดจำกัด

การแบ่งหน้า

เอนด์พอยต์แสดงรายการรองรับการแบ่งหน้าผ่านพารามิเตอร์การค้นหา:

พารามิเตอร์	คำอธิบาย
limit จำนวนเต็ม	จำนวนรายการต่อหน้า
offset จำนวนเต็ม	จำนวนรายการที่จะข้าม

การตอบกลับแบบแบ่งหน้าใช้โครงสร้างนี้:

{
  "items": [],
  "offset": 0,
  "limit": 10,
  "count": 100
}

การจัดการข้อผิดพลาด

ข้อผิดพลาดทั้งหมดส่งกลับเป็น JSON ในรูปแบบนี้:

{
  "errors": {
    "root": [
      {
        "message": "Description of the error",
        "code": "ERROR_CODE"
      }
    ]
  }
}

สถานะ	รหัส	คำอธิบาย
400	BAD_REQUEST	อินพุตไม่ถูกต้องหรือขาดฟิลด์ที่จำเป็น
401	PERMISSION_DENIED	โทเคนไม่ถูกต้อง หมดอายุ หรือถูกเพิกถอน
402	PAYMENT_REQUIRED	ต้องมีการสมัครใช้งานที่ใช้งานอยู่
403	PERMISSION_DENIED	โทเคนไม่มีขอบเขตสิทธิ์ที่ต้องใช้สำหรับการดำเนินการนี้
404	NOT_FOUND	ไม่พบทรัพยากร
409	CONFLICT	การดำเนินการขัดแย้งกัน (เช่น แก้ไขพร้อมกัน)
422	VALIDATION_ERROR	เนื้อหาคำขอไม่ผ่านการตรวจสอบ schema
429	TOO_MANY_REQUESTS	เกินขีดจำกัดอัตราคำขอ
500	UNKNOWN	ข้อผิดพลาดภายในเซิร์ฟเวอร์
503	SERVICE_UNAVAILABLE	ไม่พร้อมให้บริการชั่วคราว

---