帳號POST

建立帳號

建立渠道帳號。auth_mode 必填且僅可為 qrcode、code 或 session。當 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、twitter、zalo 或 tiktok。

enum: telegram, whatsapp, line, twitter, zalo, tiktok, 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 無效。

proxy

object

此帳號可選的對外 proxy 設定。

回應內容

id

string

唯一的帳號識別字（acc_...）。請用於帳號層級的路由。

name

string

可讀的帳號名稱。

provider

string

渠道識別字，例如 telegram、whatsapp、line、twitter、zalo 或 tiktok。

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

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 設定，未設定時省略。

provider_profile

object

渠道回報的個人檔案，例如 display_name。帳號認證完成前不會出現。

id

string

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

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 不同。

回應

201

201 Created

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

400

請求錯誤

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

401

未授權

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

409

衝突

目前操作與既有的渠道帳號或資源衝突。

500

伺服器錯誤

服務遇到了未預期的錯誤。

503

服務無法使用

所需的後端服務暫時無法使用。

請求

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