← API 參考
帳號POST

建立帳號

建立一個渠道帳號。支援嘅 provider 包括 telegram、whatsapp、twitter、line、zalo 等等；按帳號連接流程揀對應 auth_mode。當揀嘅 provider 配合 auth_mode 需要手機號嘅時候（例如 WhatsApp 配 auth_mode=code），手機號要喺呢度透過 provider_data.phone 傳入 — 平台會將佢持久化喺帳號上，後續嘅認證動作會自動回放呢個號碼。

https://api.unifyport.ai/v1/accounts

請求標頭

X-Api-Key
string必填

工作區 API Key，工作區會由呢個標頭解析得出嚟。

Content-Type
string必填

發送 JSON 請求內容嘅時候請用 application/json。

路徑參數

呢個介面冇路徑參數。

請求內容

name
string必填

可讀嘅帳號名稱。

provider
string必填

渠道方標識，例如 telegram、whatsapp、line 或 zalo。

region
string必填

用嚟分配嘅渠道區域。記住經 列出渠道區域 揀返個 allocatable: true 嘅區域。

auth_mode
string

認證流程：code、qrcode 或者 session。

provider_data
object

渠道專屬嘅設定，唔好喺 log 入面暴露入面嘅密鑰欄位。

metadata
object

平台側嘅環境標籤中繼資料。

回應內容

id
string

帳號嘅唯一識別碼（acc_...）。喺帳號層級嘅路由入面用佢。

name
string

可讀嘅帳號名稱。

provider
string

渠道標識，例如 telegram、whatsapp、line、twitter 或者 zalo。

region
string

帳號分配落去嘅渠道區域。

status
string

帳號嘅生命週期狀態，例如 active。

runtime_status
string

標準化嘅運行狀態，係 unknown、starting、running、stopping、stopped、reconnecting、disconnected 或者 error 其中一個。

auth_mode
string

帳號用嘅認證流程：code、qrcode 或者 session。

capabilities
string[]

帳號開咗嘅能力，例如 send_message 同 receive_message。

provider_account_ref
string

渠道側嘅識別碼，你可以扣返上去，攞嚟同你自己系統嘅帳號對應。

回應

201
201 Created

請求成功，回應內容嘅例子如上。

400
請求錯誤

請求內容、路徑或者參數無效。

401
未授權

X-Api-Key 請求標頭缺少或者無效。

409
衝突

目前操作同現有嘅渠道帳號或者資源衝突。

500
伺服器錯誤

服務遇到咗未預期嘅錯誤。

請求

curl -X POST https://api.unifyport.ai/v1/accounts \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Telegram Production",
  "provider": "telegram",
  "region": "global",
  "status": "active",
  "auth_mode": "qrcode",
  "capabilities": ["send_message", "receive_message"],
  "provider_data": {},
  "metadata": {
    "env": "production"
  },
  "provider_account_ref": "provider-side-identifier"
}'

回應

{
  "data": {
    "id": "acc_example",
    "name": "Telegram Production",
    "provider": "telegram",
    "region": "global",
    "status": "active",
    "runtime_status": "stopped",
    "auth_mode": "qrcode",
    "capabilities": ["send_message", "receive_message"],
    "provider_account_ref": "provider-side-identifier"
  }
}