開發者文件
One API. Every Channel.
用統一嘅 API 接入多渠道訊息,透過標準 Webhook 承接所有入站事件。
快速上手
簡介
UnifyPort 就係一套 REST API 加一條標準 webhook 事件流,覆蓋 Telegram、WhatsApp、LINE、X(原 Twitter)、Zalo 同 TikTok。發訊息統一行 POST /v1/messages,收返嚟嘅全部係標準化事件——唔使逐個渠道接佢哋自己嘅 SDK,亦可以揀官方 UnifyPort Node.js、PHP、Go 或 Python SDK。
概覽
工作區
工作區用於管理訊息帳戶、API Key 與 Webhook。呼叫介面時使用目標工作區的 X-Api-Key,無需在請求內容另外填寫工作區 ID。
帳號
訊息帳戶是你接入 UnifyPort 的一個 Telegram、WhatsApp 等渠道帳戶。建立後完成渠道授權,再透過它收發訊息。
連線狀態(Runtime)
訊息帳戶與渠道之間的連線狀態。透過 runtime_status 查詢,與帳戶授權状态分開判斷;running 表示連線已就緒。
Webhook
Webhook 係你持久保存入站流量嘅入口。UnifyPort 冇 REST 訊息歷史讀取介面,亦唔保證重播漏咗嘅投遞;請先註冊端點並喺事件到達時保存。WhatsApp 首次同步或重連之後可能下發有限嘅 best-effort HistorySync,但唔係完整歸檔。
驗證你嘅 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、WhatsApp 帳號及可接收公網 HTTPS 請求的 Webhook。API Key 與簽章密鑰保存在伺服器端。先用下方請求檢查 API Key。
- 有 JSON 內容嘅成功同錯誤回應會喺頂層帶 request_id;成功刪除等 204 無回應內容嘅請求只會透過 X-Request-Id 回應標頭傳回呢個值。回報問題時請提供佢。你亦可自帶 X-Request-Id 請求標頭,有 JSON 回應時會回顯為 client_request_id,畀用戶端對帳。