API 參考
快速入門

簡介

UnifyPort 用一套 REST API 加一條標準 webhook 事件流,統一接入 Telegram、WhatsApp、LINE、X(原 Twitter)、Zalo 與 TikTok。透過 POST /v1/messages 發送,所有入站流量以標準化事件接收——無需接入各渠道自己的 SDK,也可選用官方 UnifyPort Node.js、PHP、Go 或 Python SDK。

總覽

工作區

你的隔離邊界。X-Api-Key 請求標頭對應且僅對應一個工作區,並授予其完整存取權——請求內容中無需再傳任何 workspace id。

帳號

一個渠道登入 = 一台虛擬裝置。透過 API 建立帳號,用該渠道支援的流程完成授權(掃碼、驗證碼或會話匯入),之後就用它收發訊息。

執行環境

每個帳號背後的即時連線程序。授權成功後會自動啟動;其狀態以 runtime_status 暴露。完整狀態機見「帳號生命週期」。

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 請求標頭進行認證。
  • UnifyPort 目前僅向特定客戶開放。請聯絡團隊取得工作區存取權與你的第一組 API Key。
  • 有 JSON 內容的成功與錯誤回應會在頂層帶有 request_id;成功刪除等 204 無回應內容的請求只透過 X-Request-Id 回應標頭傳回此值。回報問題時請提供它。你也可以自帶 X-Request-Id 請求標頭,有 JSON 回應時會回顯為 client_request_id,供用戶端對帳。

下一步