กำลังโหลด...

กำลังโหลด...

เอกสารอ้างอิง API

REST API v3.0

RESTful API · OAuth 2.0 · webhook · sandbox · จำกัด 1,000 req/min

เริ่มต้นใช้งาน ทดลองใน Sandbox ดูเอนด์พอยต์ทั้งหมด

เริ่มต้นอย่างรวดเร็ว

เริ่มต้นใช้งาน MeQueue API ใน 3 ขั้นตอน:

1. รับ API Key

ไปที่ Admin → ตั้งค่า → API Keys → สร้าง key ใหม่

2. เรียก API ครั้งแรก

curl https://api-mequeue.up.railway.app/api/v1/queues/branch/BRANCH_ID/stats \
  -H "Authorization: Bearer mq_live_xxx..." \
  -H "Content-Type: application/json"

3. รับ response JSON

{
  "ok": true,
  "data": {
    "current": "A049",
    "waiting": 8,
    "serving": 2,
    "avgWaitMinutes": 8.4
  }
}

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

MeQueue API ใช้ Bearer token authentication ใน HTTP header:

Authorization: Bearer mq_live_xxx...

ประเภท API Key: mq_live_* (production), mq_test_* (sandbox)

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

ทุกการตอบกลับใช้รูปแบบ JSON envelope คำขอที่ล้มเหลวจะคืนค่า ok:false พร้อมอ็อบเจ็กต์ error และรหัสสถานะ HTTP มาตรฐาน

{
  "ok": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Branch not found"
  }
}

รหัส	ความหมาย
200	OK — คำขอสำเร็จ
201	Created — สร้างข้อมูลสำเร็จ
400	Bad Request — ข้อมูลไม่ผ่านการตรวจสอบ
401	Unauthorized — ไม่มีหรือโทเคนไม่ถูกต้อง
403	Forbidden — ไม่มีสิทธิ์สำหรับบทบาทหรือผู้เช่านี้
404	Not Found — ไม่พบข้อมูล
429	Too Many Requests — เกินขีดจำกัดอัตราการเรียก
500	Server Error — เกิดข้อผิดพลาดในระบบ

การจำกัดอัตรา

แพ็กเกจ	req/min	req/day
Starter	100	10K
Business	500	100K
Pro	1,000	500K
Enterprise	กำหนดเอง	กำหนดเอง

ทรัพยากร

เอนด์พอยต์ทุกทรัพยากรขึ้นต้นด้วย /api/v1 และต้องใช้ Bearer token รหัส (ID) เป็นตัวระบุที่คาดเดาไม่ได้

ผู้เช่า

จัดการบัญชีผู้เช่าปัจจุบัน การใช้งาน และการเรียกเก็บเงิน

เมธอด	เอนด์พอยต์	รายละเอียด
GET	/tenants/me	โปรไฟล์และแพ็กเกจของผู้เช่าปัจจุบัน
PATCH	/tenants/me	แก้ไขโปรไฟล์ผู้เช่าปัจจุบัน
GET	/tenants/usage	การใช้งานและโควตาของแพ็กเกจ
GET	/tenants/invoices	รายการใบแจ้งหนี้
GET	/tenants/:id	ดึงข้อมูลผู้เช่าตามรหัส (ผู้ดูแลระบบ)

สาขา

สร้างและจัดการสาขาภายใต้ผู้เช่า

เมธอด	เอนด์พอยต์	รายละเอียด
GET	/branches	รายการสาขาทั้งหมด
POST	/branches	สร้างสาขา
GET	/branches/:id	ดึงข้อมูลสาขาตามรหัส
PATCH	/branches/:id	แก้ไขสาขา
DELETE	/branches/:id	ลบสาขา

บริการ

กำหนดบริการที่ลูกค้าสามารถรับคิวได้

เมธอด	เอนด์พอยต์	รายละเอียด
GET	/services	รายการบริการทั้งหมด
POST	/services	สร้างบริการ
GET	/services/:id	ดึงข้อมูลบริการตามรหัส
PATCH	/services/:id	แก้ไขบริการ
DELETE	/services/:id	ลบบริการ

เคาน์เตอร์

จัดการเคาน์เตอร์บริการและสถานะแบบเรียลไทม์

เมธอด	เอนด์พอยต์	รายละเอียด
GET	/counters/branch/:branchId	รายการเคาน์เตอร์ในสาขา
POST	/counters	สร้างเคาน์เตอร์
PATCH	/counters/:id	แก้ไขเคาน์เตอร์
PATCH	/counters/:id/status	ตั้งสถานะเคาน์เตอร์ (เปิด / พัก / ปิด)
DELETE	/counters/:id	ลบเคาน์เตอร์

คิว

ออกบัตรคิวและควบคุมคิวสด — เรียก ปิดงาน ข้าม โอน

เมธอด	เอนด์พอยต์	รายละเอียด
POST	/queues	ออกบัตรคิวใหม่
GET	/queues/branch/:branchId	รายการบัตรคิวสดของสาขา
GET	/queues/branch/:branchId/stats	สถิติรอ / กำลังให้บริการของสาขาแบบเรียลไทม์
GET	/queues/tenant	รายการบัตรคิวทั้งหมดของผู้เช่า
PATCH	/queues/:id/call	เรียกบัตรคิวไปยังเคาน์เตอร์
PATCH	/queues/:id/complete	ปิดงานบัตรคิว
PATCH	/queues/:id/skip	ข้ามบัตรคิว
PATCH	/queues/:id/cancel	ยกเลิกบัตรคิว
PATCH	/queues/:id/transfer	โอนบัตรคิวไปยังบริการ / เคาน์เตอร์อื่น

ลูกค้า

ข้อมูลลูกค้าและผู้สนใจ จัดการผ่าน CRM

เมธอด	เอนด์พอยต์	รายละเอียด
GET	/crm/leads	รายการลูกค้า / ผู้สนใจ
POST	/crm/leads	สร้างข้อมูลลูกค้า
PATCH	/crm/leads/:id	แก้ไขข้อมูลลูกค้า
GET	/crm/segments	รายการกลุ่มลูกค้า

พนักงาน

จัดการพนักงานประจำเคาน์เตอร์และสถานะพร้อมให้บริการ

เมธอด	เอนด์พอยต์	รายละเอียด
GET	/staff	รายการพนักงานทั้งหมด
POST	/staff	สร้างพนักงาน
GET	/staff/branch/:branchId	รายการพนักงานในสาขา
PATCH	/staff/:id	แก้ไขข้อมูลพนักงาน
PATCH	/staff/:id/online	สลับสถานะออนไลน์ / ออฟไลน์ของพนักงาน

รายงาน

การวิเคราะห์รวมข้ามสาขา บริการ และพนักงาน

เมธอด	เอนด์พอยต์	รายละเอียด
GET	/reports/summary	สรุปตัวชี้วัดตามช่วงเวลา
GET	/reports/hourly	ปริมาณคิวรายชั่วโมง
GET	/reports/by-service	แยกตามบริการ
GET	/reports/trend	แนวโน้มปริมาณคิวตามเวลา
GET	/reports/leaderboard	กระดานจัดอันดับพนักงาน

เว็บฮุก

สมัครรับเหตุการณ์คิวและรับการเรียกกลับแบบเรียลไทม์

เมธอด	เอนด์พอยต์	รายละเอียด
GET	/webhooks	รายการการสมัครรับ webhook
POST	/webhooks	สร้างการสมัครรับ webhook
PATCH	/webhooks/:id	แก้ไขการสมัครรับ webhook
DELETE	/webhooks/:id	ลบการสมัครรับ webhook

ชุด AI

การพยากรณ์ วิเคราะห์ การตลาด และเสียงด้วย AI

เมธอด	เอนด์พอยต์	รายละเอียด
GET	/ai/sage/forecast	Queue Sage — พยากรณ์ความต้องการ
POST	/ai/lens/ask	Insight Lens — วิเคราะห์ด้วยภาษาธรรมชาติ
POST	/ai/maestro	Marketing Maestro — ร่างแคมเปญ
POST	/ai/voice/clone	Voice Cloner — ลงทะเบียนเสียง

กำลังโหลด...