API 參考

開發者文件

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,供用戶端對帳。

下一步