帳號

更新帳號

部分更新帳號中繼資料同渠道設定。冇傳嘅欄位保留現值；null 無效；空 array 或空 object 用嚟清空集合或物件欄位。

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 路由嘅 ID。

請求內容

name

string

可讀嘅帳號名稱。

provider

string

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

enum: telegram, whatsapp, line, twitter, facebook, 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 設定。PATCH 時自訂代理優先；清空後恢復帳號建立時嘅預設設定。舊帳號沿用原有嘅清空行為。

如何理解結果

依本介面的回應欄位與 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 唔同。

billing

object

訊息帳號已付週期，僅餘額帳號存在；不能依錢包餘額推斷已購買。

period_start_at

string

伺服器回傳的已付週期起點。

format: date-time

period_end_at

string

伺服器回傳的已付週期終點。

format: date-time

amount_minor

integer

伺服器不可變金額，單位為 USD 分，須以精確整數處理。

minimum: 1 · format: int64

currency

string

僅 USD。

operation_id

string

來自 billing.operation_id 或刪除回應的公開標識，於原工作區原樣重用。

state

string

計費或操作狀態，不證明帳號已授權、上線或退款已入帳。

enum: ACTIVE, DELETING, DELETED, COMPENSATED, REVIEW

id

string

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

name

string

可讀嘅帳號名稱。

provider

string

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

enum: telegram, whatsapp, line, twitter, facebook, 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。TikTok 支援 qrcode 同 session，但唔支援兩種模式原地切換。

capabilities[]

string[]

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

metadata

object

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

provider_account_ref

string

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

proxy

object

客戶明確設定嘅代理；唔會回傳平台預設出口憑證。

回應

200

200 OK

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

400

請求錯誤

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

401

未授權

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

403

禁止存取

請求已識別，但唔允許執行呢個操作。

404

搵唔到資源

搵唔到請求嘅資源；請結合 error.code 同目前操作核對。

409

衝突

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

422

無法處理嘅實體

請求格式有效，但解析唔到目標渠道會話。

500

伺服器錯誤

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

502

上游閘道錯誤

渠道轉接器或者上游渠道未能完成呢個操作。

失敗後如何處理

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

請按目前操作一併讀取 HTTP 狀態、error.code 同 error.numeric_code。數字碼以字串處理。保留 request_id 排查；佢唔係冪等鍵或任務識別碼。

auth_mode_phone_required · 20019 · 400

此授權方式要求建立帳戶時填寫 provider_data.phone。

處理與重試: 按目前操作同渠道條件修正參數後再請求。重複提交相同嘅無效請求唔會解決錯誤。

示意 JSON；message 會隨實際原因變化 · 400 · 20019

{
  "request_id": "req_example",
  "error": {
    "code": "auth_mode_phone_required",
    "numeric_code": "20019",
    "message": "Phone number is required for this auth mode"
  }
}

invalid_request · 10000 · 400

檢查 JSON 請求內容與必填欄位。

處理與重試: 按目前操作同渠道條件修正參數後再請求。重複提交相同嘅無效請求唔會解決錯誤。

示意 JSON；message 會隨實際原因變化 · 400 · 10000

{
  "request_id": "req_example",
  "error": {
    "code": "invalid_request",
    "numeric_code": "10000",
    "message": "Invalid request parameters"
  }
}

invalid_target_workspace · 11003 · 400

工作區覆寫目標為空或格式無效。請移除覆寫請求標頭，改用目標工作區所屬嘅 API Key。

觸發條件: 適用於帶有 X-Workspace-Id 工作區覆寫請求標頭嘅請求。

處理與重試: 按目前操作同渠道條件修正參數後再請求。重複提交相同嘅無效請求唔會解決錯誤。

示意 JSON；message 會隨實際原因變化 · 400 · 11003

{
  "request_id": "req_example",
  "error": {
    "code": "invalid_target_workspace",
    "numeric_code": "11003",
    "message": "Invalid target workspace"
  }
}

unsupported_provider_auth_mode · 20018 · 400

請使用此渠道支援的 auth_mode。

處理與重試: 選擇文件列為支援嘅渠道同動作。重複請求唔會增加能力或開通內測權限。

示意 JSON；message 會隨實際原因變化 · 400 · 20018

{
  "request_id": "req_example",
  "error": {
    "code": "unsupported_provider_auth_mode",
    "numeric_code": "20018",
    "message": "Auth mode not supported by this provider"
  }
}

invalid_api_key · 11001 · 401

檢查 API Key 是否正確且已啟用。

處理與重試: 保留 request_id 同結構化錯誤碼，先排查目前操作，再決定下一步。

示意 JSON；message 會隨實際原因變化 · 401 · 11001

{
  "request_id": "req_example",
  "error": {
    "code": "invalid_api_key",
    "numeric_code": "11001",
    "message": "Invalid API key"
  }
}

missing_api_key · 11000 · 401

請加入 X-Api-Key 請求標頭。

處理與重試: 保留 request_id 同結構化錯誤碼，先排查目前操作，再決定下一步。

範例 · 401 · 11000

{
  "request_id": "req_xxx",
  "error": {
    "code": "missing_api_key",
    "numeric_code": "11000",
    "message": "Missing X-Api-Key header"
  }
}

workspace_override_forbidden · 11002 · 403

請求嘗試使用呢個 API Key 無權使用嘅工作區覆寫。請移除覆寫請求標頭，改用目標工作區所屬嘅 API Key。

觸發條件: 適用於帶有 X-Workspace-Id 工作區覆寫請求標頭嘅請求。

處理與重試: 保留 request_id 同結構化錯誤碼，先排查目前操作，再決定下一步。

示意 JSON；message 會隨實際原因變化 · 403 · 11002

{
  "request_id": "req_example",
  "error": {
    "code": "workspace_override_forbidden",
    "numeric_code": "11002",
    "message": "Workspace override is not allowed"
  }
}

target_workspace_not_found · 11004 · 404

覆寫指定嘅工作區不存在或不可用。請核對工作區歸屬，移除覆寫請求標頭並使用目標工作區 API Key；重複請求唔會增加存取權限。

觸發條件: 適用於帶有 X-Workspace-Id 工作區覆寫請求標頭嘅請求。

處理與重試: 核對目標識別碼、資源歸屬同目前工作區。唔好將已確認缺少或無法存取嘅目標當成暫時服務故障自動重試。

示意 JSON；message 會隨實際原因變化 · 404 · 11004

{
  "request_id": "req_example",
  "error": {
    "code": "target_workspace_not_found",
    "numeric_code": "11004",
    "message": "Target workspace not found"
  }
}

duplicate_provider_account · 20015 · 409

工作區內已有另一個帳戶綁定相同渠道身分。

處理與重試: 保留 request_id 同結構化錯誤碼，先排查目前操作，再決定下一步。

示意 JSON；message 會隨實際原因變化 · 409 · 20015

{
  "request_id": "req_example",
  "error": {
    "code": "duplicate_provider_account",
    "numeric_code": "20015",
    "message": "A provider account with the same identity already exists in this workspace"
  }
}

egress_configuration_pending · 20032 · 409

暫時無法確認或讀取平台預設網絡設定；唔代表帳號已登出。

觸發條件: 呢個操作使用平台分配嘅網絡容量或帳號固定嘅預設網絡設定。

處理與重試: 保留 request_id，再次寫入前核對帳號或建立結果。等容量或設定恢復，或聯絡支援；唔好自動反覆建立帳號、更換網絡或重啟帳號。

示意 JSON；message 會隨實際原因變化 · 409 · 20032

{
  "request_id": "req_example",
  "error": {
    "code": "egress_configuration_pending",
    "numeric_code": "20032",
    "message": "Account network configuration is pending verification"
  }
}

provider_not_ready · 30009 · 409

連線尚未就緒，請檢查授權及 runtime_status 後再決定是否重試。

處理與重試: 查詢授權及運行狀態，再按目標狀態同渠道支援選擇刷新、啟動或重連。連線問題本身唔證明已登出；執行依賴連線嘅業務操作前確認 running。

示意 JSON；message 會隨實際原因變化 · 409 · 30009

{
  "request_id": "req_example",
  "error": {
    "code": "provider_not_ready",
    "numeric_code": "30009",
    "message": "Provider client is not ready"
  }
}

provider_not_ready · 30015 · 409

渠道運行進程已停止。啟動前確認呢個係咪預期狀態；運行態停止本身唔等於已登出。

適用渠道: WhatsApp

示意 JSON；message 會隨實際原因變化 · 409 · 30015

{
  "request_id": "req_example",
  "error": {
    "code": "provider_not_ready",
    "numeric_code": "30015",
    "message": "Provider runtime is stopped"
  }
}

egress_change_not_supported · 20034 · 422

帳號使用固定預設網絡，唔支援透過一般帳號更新更改地區或渠道。

觸發條件: 呢個操作使用平台分配嘅網絡容量或帳號固定嘅預設網絡設定。

處理與重試: 選擇文件列為支援嘅渠道同動作。重複請求唔會增加能力或開通內測權限。

示意 JSON；message 會隨實際原因變化 · 422 · 20034

{
  "request_id": "req_example",
  "error": {
    "code": "egress_change_not_supported",
    "numeric_code": "20034",
    "message": "The requested network change is not supported"
  }
}

update_account_failed · 20003 · 500

更新帳號：未分類錯誤中斷今次改動，需要確認資源最終狀態。

處理與重試: 先讀取資源目前狀態，確認上次改動結果，再決定是否重試。保留 request_id；結果未知時唔好自動重複寫入。

示意 JSON；message 會隨實際原因變化 · 500 · 20003

{
  "request_id": "req_example",
  "error": {
    "code": "update_account_failed",
    "numeric_code": "20003",
    "message": "Failed to update account"
  }
}

update_account_failed · 20020 · 500

核對 account_id，並使用帳號所屬工作區的 X-Api-Key。此工作區下未找到的帳號無法使用目前 Key 存取。

觸發條件: 適用於帳號不存在嘅情況；保留原 HTTP 狀態同操作 code，透過 numeric_code 細分帳號缺失。

處理與重試: 核對目標識別碼、資源歸屬同目前工作區。唔好將已確認缺少或無法存取嘅目標當成暫時服務故障自動重試。

示意 JSON；message 會隨實際原因變化 · 500 · 20020

{
  "request_id": "req_example",
  "error": {
    "code": "update_account_failed",
    "numeric_code": "20020",
    "message": "Account not found"
  }
}

update_account_failed · 30010 · 500

渠道未能完成本次操作。message 可能喺「Provider operation failed:」後附原始原因；文字可以改動，唔係穩定嘅程式介面。

觸發條件: 只適用於真正切換授權模式並調用 WhatsApp 登出嘅情況；一般帳號資料更新唔會觸發呢個數字細分。

處理與重試: 先讀取資源目前狀態，確認上次改動結果，再決定是否重試。保留 request_id；結果未知時唔好自動重複寫入。

適用渠道: WhatsApp

示意 JSON；message 會隨實際原因變化 · 500 · 30010

{
  "request_id": "req_example",
  "error": {
    "code": "update_account_failed",
    "numeric_code": "30010",
    "message": "Provider operation failed"
  }
}

update_account_failed · 30021 · 500

本次請求時帳戶未連線至訊息平台。WhatsApp 新增聯絡人可傳回 500 / create_contact_failed / 30021。這不代表帳戶已登出，也不保證目前運行狀態仍為 disconnected；請先查詢目前狀態，再選擇復原操作。

觸發條件: 只適用於真正切換授權模式並調用 WhatsApp 登出嘅情況；一般帳號資料更新唔會觸發呢個數字細分。

處理與重試: 暫停依賴連線嘅業務操作。先調用 POST /v1/accounts/{account_id}/runtime/refresh，按最新狀態恢復，確認 runtime_status=running 後再請求業務介面。重發前確認上次寫入結果。

適用渠道: WhatsApp

示意 JSON；message 會隨實際原因變化 · 500 · 30021

{
  "request_id": "req_example",
  "error": {
    "code": "update_account_failed",
    "numeric_code": "30021",
    "message": "Account is not connected to the messaging platform"
  }
}

provider_unavailable · 30002 · 502

渠道服務暫時無法使用，請檢查狀態或稍後再試；重試寫入操作前先確認上次結果。

處理與重試: 先讀取資源目前狀態，確認上次改動結果，再決定是否重試。保留 request_id；結果未知時唔好自動重複寫入。

範例 · 502 · 30002

{
  "request_id": "req_example_provider_unavailable",
  "error": {
    "code": "provider_unavailable",
    "numeric_code": "30002",
    "message": "Provider service unavailable"
  }
}