Tài liệu nhà phát triển

Một cổng, mọi kênh.

Kết nối mọi tuyến nhắn tin qua một API thống nhất, với sự kiện Webhook chuẩn cho lưu lượng inbound.

Bắt đầu

Giới thiệu

UnifyPort là một REST API cộng một luồng sự kiện webhook chuẩn cho Telegram, WhatsApp, LINE, X (Twitter), Zalo và TikTok. Gửi bằng POST /v1/messages, nhận mọi thứ dưới dạng sự kiện đã chuẩn hóa — không cần SDK riêng của từng provider; bạn có thể dùng SDK UnifyPort chính thức cho Node.js hoặc PHP.

Tổng quan

Workspace

Ranh giới cách ly của bạn. Tiêu đề X-Api-Key ánh xạ tới đúng một workspace và cấp toàn quyền truy cập vào đó — không cần thêm workspace id nào trong nội dung yêu cầu.

Tài khoản

Một phiên đăng nhập kênh = một thiết bị ảo. Tạo qua API, ủy quyền bằng luồng mà provider hỗ trợ (QR, mã xác nhận hoặc nhập session), rồi gửi và nhận thông qua nó.

Runtime

Tiến trình kết nối trực tiếp đứng sau mỗi tài khoản. Nó tự khởi động sau khi ủy quyền thành công; trạng thái được lộ ra qua runtime_status. Xem Vòng đời tài khoản để biết máy trạng thái đầy đủ.

Webhook

Bản ghi duy nhất của lưu lượng inbound. UnifyPort không lưu lịch sử tin nhắn và sự kiện bị lỡ không được phát lại — hãy đăng ký điểm cuối webhook trước, rồi lưu những gì bạn cần ngay khi sự kiện đến.

Xác minh API key của bạn

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

Ghi chú

  • Base URL: https://api.unifyport.ai. Mọi điểm cuối /v1 đều xác thực bằng tiêu đề X-Api-Key.
  • UnifyPort hiện chỉ mở cho một số khách hàng được chọn. Hãy liên hệ với nhóm để được cấp quyền truy cập workspace và API key đầu tiên của bạn.
  • Every response (success and error) carries a top-level request_id, also returned as the X-Request-Id response header — quote it when reporting issues. Send your own X-Request-Id request header and it is echoed back as client_request_id for client-side reconciliation.

Bước tiếp theo

Bắt đầu nhanh

Từ một workspace trống đến tin nhắn WhatsApp đầu tiên và sự kiện đến đầu tiên của bạn.

Năng lực nhà cung cấp

Mỗi kênh hiện thực sự hỗ trợ những loại tin nhắn, hành động và sự kiện nào.

Nhận sự kiện

Tiêu đề khi gửi sự kiện, xác minh chữ ký HMAC, cơ chế retry và bảo đảm thứ tự.

Tham chiếu mã lỗi

Phong bì lỗi và mọi mã lỗi máy đọc được, nhóm theo mã trạng thái HTTP.