帳號

建立帳號

建立渠道帳號。auth_mode 必填，淨係可以係 qrcode、code 或 session。當 provider 配 auth_mode 需要手機號（例如 WhatsApp + auth_mode=code），一定要經 provider_data.phone 提供；之後認證動作會重用。

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

呼叫前準備

在伺服器端使用資源所屬工作區的 X-Api-Key，執行範例前替換所有預留位置。

請求

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"
}'

請求參數

請求標頭

X-Api-Key

string必填

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

Content-Type

string必填

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

請求內容

name

string

可讀嘅帳號名稱。

provider

string必填

客戶可用嘅渠道標識：telegram、whatsapp、whatsapp-protocol、line、twitter、zalo 或 tiktok。

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp-protocol, x, x_client, twitter_client

region

string必填

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

minLength: 1

status

string

帳號業務狀態，例如 active 或者 inactive。

runtime_status

string

渠道支援經帳號設定更改時，要求設定嘅運行狀態。

enum: unknown, starting, running, stopping, stopped, reconnecting, disconnected, error

auth_mode

string必填

建立帳號時必填；淨係可以係 qrcode、code 或 session。

enum: qrcode, code, session

capabilities[]

string[]

帳號能力。PATCH 時唔傳代表保留，傳 [] 代表清空，null 無效。

metadata

object

平台側中繼資料。PATCH 時唔傳代表保留，傳 {} 代表清空，null 無效。

provider_account_ref

string

渠道側帳號識別碼，通常會喺授權完成之後寫入。

provider_data

object

渠道專屬設定。PATCH 時唔傳代表保留，傳 {} 代表清空，null 無效。建立 Telegram 帳號時，api_id 同 api_hash 可選；冇指定自訂應用程式憑證就用平台預設應用程式憑證。使用自有應用程式時，請將同一 Telegram 應用程式嘅兩項憑證以字串成對提供。

proxy

object

呢個帳號可選嘅對外 proxy 設定。

如何理解結果

依文件解讀回應欄位與 HTTP 狀態。204 成功沒有回應本文，排查時使用 X-Request-Id。下一步請參閱相關操作。

回應 201 Created

{
  "request_id": "<REQUEST_ID>",
  "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"
  }
}

回應內容

provider_profile

object

渠道回報嘅資料，例如 display_name。帳號未認證之前唔會有。

id

string

渠道側帳號識別碼。WhatsApp 回傳 LID；帳號資料同步完成前可能省略。

device_id

integer

僅 WhatsApp 帳號詳情在可確認目前工作階段時提供的可選登入裝置編號；重新授權後可能改變，不作永久裝置識別。

minimum: 0 · maximum: 65535

phone

string

已歸一化嘅帳號電話號碼，冇空格、連字號同開頭加號。

username

string

渠道回報嘅 username（如有）。

display_name

string

帳號展示名稱；WhatsApp 按 BusinessName 優先、PushName 回退嘅規則生成。

push_name

string

WhatsApp 目前帳號設定嘅 PushName；其他渠道冇定義呢個欄位嘅語義。

business_name

string

WhatsApp BusinessName；渠道冇回傳時呢個欄位會缺失。

first_name

string

渠道回報嘅名（如有）。

last_name

string

渠道回報嘅姓（如有）。

avatar_url

string

渠道回報嘅帳號頭像 URL（如有）。

bio

string

渠道回報嘅帳號簡介或狀態文字（如有）。

platform

string

WhatsApp 配對時回報嘅登入平台識別碼。請當佢係不透明字串並兼容未知值；其他渠道冇定義呢個欄位嘅語義。呢個欄位同 device_platform 唔同。

id

string

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

name

string

可讀嘅帳號名稱。

provider

string

管道識別碼。呼叫其他介面時原樣使用 API 回傳的值；此介面的回傳範圍請看下方列舉。

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp-protocol

region

string

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

status

string

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

runtime_status

string

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

enum: unknown, starting, running, stopping, stopped, reconnecting, disconnected, error

auth_mode

string

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

capabilities[]

string[]

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

metadata

object

你自己存喺帳號上面嘅環境標籤。

provider_account_ref

string

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

proxy

object

帳號綁定嘅對外 proxy 設定，未設定就唔會回。

回應

201

201 Created

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

400

請求錯誤

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

401

未授權

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

409

衝突

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

500

伺服器錯誤

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

503

服務不可用

所需嘅後端服務暫時不可用。

失敗後如何處理

檢查 HTTP 狀態和 error.code/numeric_code，保留 request_id。依原因修正參數、繼續授權或檢查狀態。重試傳送及寫入前確認上次結果，避免重複操作。錯誤碼參考

invalid_request · 10000 · 400: 檢查必填欄位、格式與渠道條件，修正請求後再呼叫。
invalid_api_key · 11001 · 401: 檢查 X-Api-Key 與工作區是否有效。