เอกสารอ้างอิง API
เริ่มต้นใช้งาน

บทนำ

UnifyPort คือ REST API หนึ่งเดียวบวกสตรีมอีเวนต์ webhook มาตรฐานหนึ่งชุด สำหรับ Telegram, WhatsApp, LINE, X (เดิมชื่อ Twitter), Zalo และ TikTok ส่งด้วย POST /v1/messages แล้วรับทุกอย่างเป็นอีเวนต์ที่ปรับเป็นมาตรฐาน — ไม่ต้องใช้ SDK เฉพาะของแต่ละ provider และเลือกใช้ SDK ทางการของ UnifyPort สำหรับ Node.js, PHP, Go หรือ Python ได้

ภาพรวม

พื้นที่ทำงาน

ขอบเขตการแยกข้อมูลของคุณ ส่วนหัว X-Api-Key ชี้ไปยังพื้นที่ทำงานเดียวเท่านั้นและให้สิทธิ์เข้าถึงเต็มรูปแบบ — ไม่ต้องส่ง workspace id เพิ่มในเนื้อหาของคำขอ

บัญชี

การล็อกอินหนึ่งช่องทาง = อุปกรณ์เสมือนหนึ่งเครื่อง สร้างผ่าน API ให้สิทธิ์ด้วยโฟลว์ที่ผู้ให้บริการรองรับ (QR, รหัสยืนยัน หรือนำเข้า session) จากนั้นใช้ส่งและรับข้อความผ่านบัญชีนั้น

รันไทม์

กระบวนการเชื่อมต่อจริงที่อยู่เบื้องหลังแต่ละบัญชี จะเริ่มอัตโนมัติหลังการให้สิทธิ์สำเร็จ สถานะของมันแสดงผ่าน runtime_status ดูสเตตแมชชีนฉบับเต็มได้ที่ วงจรชีวิตของบัญชี

Webhook

ช่องทางสำหรับเก็บทราฟฟิกขาเข้าอย่างถาวร UnifyPort ไม่มี REST API สำหรับอ่านประวัติข้อความและไม่รับประกัน replay ของ delivery ที่พลาด จึงควรลงทะเบียน webhook และบันทึก event เมื่อมาถึง WhatsApp HistorySync อาจให้ข้อมูลล่าสุดแบบ best-effort อย่างจำกัดหลัง bootstrap หรือ reconnect แต่ไม่ใช่ archive ที่สมบูรณ์

ตรวจสอบ API key ของคุณ

Shell

curl https://api.unifyport.ai/v1/workspace \
  -H "X-Api-Key: <YOUR_API_KEY>"

หมายเหตุ

  • Base URL: https://api.unifyport.ai ทุกจุดเชื่อมต่อ /v1 ยืนยันตัวตนด้วยส่วนหัว X-Api-Key
  • ขณะนี้ UnifyPort เปิดให้บริการเฉพาะลูกค้าที่ได้รับคัดเลือก ติดต่อทีมงานเพื่อขอสิทธิ์เข้าถึงพื้นที่ทำงานและรับ API key ชุดแรกของคุณ
  • JSON success and error responses carry a top-level request_id; requests with no response body, such as successful 204 deletes, expose it only through the X-Request-Id response header. Quote that value when reporting issues. Send your own X-Request-Id request header and it is echoed as client_request_id in JSON responses for client-side reconciliation.

ขั้นถัดไป