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

เอกสารสำหรับนักพัฒนา

One API. Every Channel.

เชื่อมต่อทุกเส้นทางข้อความผ่าน API เดียว พร้อมรับ inbound event ผ่าน Webhook มาตรฐาน

เริ่มต้นใช้งาน

บทนำ

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

ภาพรวม

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

เวิร์กสเปซใช้จัดการบัญชีรับส่งข้อความ API Key และ Webhook เมื่อเรียก API ให้ใช้ X-Api-Key ของเวิร์กสเปซนั้น โดยไม่ต้องใส่ ID เวิร์กสเปซในเนื้อหาคำขอ

บัญชี

บัญชีรับส่งข้อความคือบัญชี Telegram, WhatsApp หรือช่องทางอื่นที่เชื่อมต่อกับ UnifyPort สร้างบัญชีและทำขั้นตอนอนุญาตของช่องทางให้เสร็จก่อนรับส่งข้อความ

สถานะการเชื่อมต่อ (Runtime)

สถานะการเชื่อมต่อระหว่างบัญชีกับช่องทาง ตรวจ runtime_status แยกจากการอนุญาต ค่า running หมายถึงการเชื่อมต่อพร้อมใช้งาน

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
  • เตรียม API Key ของ workspace บัญชี WhatsApp และ Webhook HTTPS สาธารณะ เก็บ 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.

ขั้นถัดไป

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

จากพื้นที่ทำงานว่างเปล่าไปสู่ข้อความ WhatsApp แรกและอีเวนต์ขาเข้าครั้งแรกของคุณ

ความสามารถของผู้ให้บริการ

แต่ละช่องทางรองรับชนิดข้อความ แอ็กชัน และอีเวนต์ใดบ้างจริง ๆ ในปัจจุบัน

การรับอีเวนต์

ส่วนหัวของการส่ง การตรวจสอบลายเซ็น HMAC การ retry และการรับประกันลำดับ

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

ซองข้อความข้อผิดพลาดและรหัสข้อผิดพลาดแบบ machine-readable ทั้งหมด จัดกลุ่มตามสถานะ HTTP