開發者文件

一處連接,萬路暢通

用統一嘅 API 接入多渠道訊息,透過標準 Webhook 承接所有入站事件。

快速上手

簡介

UnifyPort 就係一套 REST API 加一條標準 webhook 事件流,覆蓋 Telegram、WhatsApp、LINE、X(Twitter)、Zalo 同 TikTok。發訊息統一行 POST /v1/messages,收返嚟嘅全部係標準化事件——唔使逐個渠道接佢哋自己嘅 SDK,亦可以揀官方 UnifyPort Node.js 或 PHP SDK。

概覽

工作區

你嘅隔離邊界。X-Api-Key 標頭剛好對應一個工作區,並且攞到佢嘅完整存取權——請求內容入面唔使再傳任何 workspace id。

帳號

一個渠道登入 = 一台虛擬裝置。經 API 建立,再用嗰個渠道支援嘅流程(掃碼、驗證碼或者會話匯入)完成授權,跟住就可以靠佢收發訊息。

執行環境

每個帳號背後嗰條實際連線進程。授權成功之後會自動啟動;狀態經 runtime_status 暴露出嚟。完整狀態機請睇「帳號生命週期」。

Webhook

入站流量嘅唯一紀錄。UnifyPort 唔會持久化訊息歷史,漏咗嘅事件亦唔會重播——記住先註冊好 webhook 端點,事件一到就將需要嘅內容存低。

驗證你嘅 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,請聯絡我哋團隊。
  • 每個回應(成功與錯誤)頂層都帶 request_id,並透過 X-Request-Id 回應標頭回傳——回報問題時請提供此值。你亦可自帶 X-Request-Id 請求標頭,佢會原樣回顯為 client_request_id,畀用戶端對帳。

下一步