帳號

更新帳號

部分更新帳號中繼資料與渠道設定。未傳欄位（包括 provider 與 region）保留現值；null 無效；空陣列或空物件用於清空集合或物件欄位。

PATCHhttps://api.unifyport.ai/v1/accounts/{account_id}

支援渠道

all

呼叫前準備

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

參數從哪裡取得

account_id: 從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。取得帳號

請求

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

請求參數

請求標頭

X-Api-Key

string必填

工作區 API Key，工作區會由此標頭解析得到。

Content-Type

string必填

傳送 JSON 請求內容時請使用 application/json。

路徑參數

account_id

string必填

用於該 accounts 路由的識別字。

請求內容

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 無效。TikTok provider_data.enable_comment 僅接受 Boolean，預設 false；字串、數字、null 回傳 400 invalid_request。線上修改需 reconnect，start 成功不代表設定已套用；關閉不撤回已排隊事件。Telegram 的 code、qrcode、session 均可省略 api_id 與 api_hash；自訂憑證須為同一應用程式的成對字串。建立時未指定自訂憑證、非空設定替換時缺省憑證欄位，均使用平台預設值；所需預設設定不可用時請求失敗。平台預設憑證變更不會替換既有帳號憑證。請勿記錄金鑰。

proxy

object

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

如何理解結果

依本介面的回應欄位與 HTTP 狀態判斷結果，再透過相關操作選擇下一步。

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "id": "acc_example",
    "name": "Telegram Production",
    "provider": "telegram",
    "status": "active",
    "auth_mode": "code"
  }
}

回應內容

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

回應

200

200 OK

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

400

請求錯誤

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

401

未授權

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

409

衝突

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

500

伺服器錯誤

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

502

上游閘道錯誤

渠道轉接器或上游渠道未能完成此操作。

失敗後如何處理

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

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