Tham chiếu API

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

One API. Every Channel.

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 (trước đây là 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, PHP, Go hoặc Python.

Tổng quan

Workspace

Không gian làm việc quản lý tài khoản nhắn tin, API Key và Webhook. Dùng X-Api-Key của không gian đó khi gọi API; không cần thêm ID không gian vào nội dung yêu cầu.

Tài khoản

Tài khoản nhắn tin là tài khoản Telegram, WhatsApp hoặc kênh khác được kết nối với UnifyPort. Tạo tài khoản, hoàn tất ủy quyền kênh rồi dùng để gửi và nhận tin nhắn.

Trạng thái kết nối (Runtime)

Trạng thái kết nối giữa tài khoản nhắn tin và kênh. Kiểm tra runtime_status riêng với ủy quyền; running cho biết kết nối đã sẵn sàng.

Webhook

Điểm vào để lưu bền vững lưu lượng inbound. UnifyPort không có REST API đọc lịch sử tin nhắn và không bảo đảm replay delivery bị lỡ, vì vậy hãy đăng ký webhook trước và lưu event khi nhận. WhatsApp HistorySync có thể cung cấp tính liên tục gần đây dạng best-effort giới hạn sau bootstrap hoặc reconnect, nhưng không phải archive đầy đủ.

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.
  • Chuẩn bị API Key của workspace, tài khoản WhatsApp và Webhook HTTPS công khai. Giữ API Key và khóa ký trên máy chủ. Dùng yêu cầu dưới đây để kiểm tra khóa.
  • 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.

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.