帳號授權

匯入會話

透過會話 URL 或渠道專用憑證發起授權。TikTok session 帳號使用 tiktok.cookies；pending 時須查詢授權及執行狀態，直到 authorized 且 running。HTTP 200 本身不代表授權完成。

POSThttps://api.unifyport.ai/v1/accounts/{account_id}/auth/session

支援渠道

TelegramXFacebookTikTokWhatsApp Protocol

呼叫前準備

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

依管道準備工作階段資料：Telegram 和 X 使用既有工作階段 URL 或參照，只有 WhatsApp Protocol 使用 whatsapp-protocol 憑證物件。先查看對應管道指南，勿將工作階段資料與密鑰寫入日誌。

參數從哪裡取得

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

請求

curl -X POST "https://api.unifyport.ai/v1/accounts/{account_id}/auth/session" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "session_url": "https://example.com/account.session"
}'

請求參數

請求標頭

X-Api-Key

string必填

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

Content-Type

string必填

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

路徑參數

account_id

string必填

用於該 authentication 路由的識別字。

請求內容

session_url

string

既有渠道會話的 URL 或參考。 Facebook 必須提供 session_url，指向含 cookies 陣列及 c_user、xs、datr 的 JSON。匯入成功後仍須確認執行狀態就緒。

format: uri

whatsapp-protocol

object

WhatsApp Protocol 會話匯入憑證，只能透過此巢狀物件提交至 /v1/accounts/{account_id}/auth/session，不能透過 provider_data 提交。提供此物件時，phone、static_pub_key、static_pri_key、identity_pub_key 和 identity_pri_key 必填。回應不會回傳協定金鑰或其他敏感憑證。phone 用於身分一致性驗證；協定公鑰、私鑰僅供上游啟動使用。edge_routing 由平台固定注入，不得提交。

phone

string

匯入工作階段時若提供 whatsapp-protocol，phone 為必填的非空字串，用於身分一致性驗證。格式化輸入允許包含空格、連字號、括號或加號；伺服器將其正規化為正數字串。

minLength: 1

platform

integer

WhatsApp Protocol 會話匯入的平台值（int32）。

format: int32

app_version

string

WhatsApp Protocol 會話匯入的應用程式版本。

server_address

string

WhatsApp Protocol 會話匯入的渠道伺服器位址。

fallback_server_addresses[]

string[]

WhatsApp Protocol 會話匯入的備用伺服器位址清單。

country

string

WhatsApp Protocol 會話匯入的國家代碼。

device

integer

WhatsApp Protocol 會話匯入的裝置值（uint32）。

format: uint32

static_pub_key

string

協定公鑰；僅供寫入。

minLength: 1

static_pri_key

string

協定私鑰；僅供寫入。

minLength: 1

identity_pub_key

string

身分公鑰；僅供寫入。

minLength: 1

identity_pri_key

string

身分私鑰；僅供寫入。

minLength: 1

hash

string

已棄用的相容欄位；目前值會被忽略且不儲存，建議省略。

peer_kem_public

string

對端 KEM 公鑰；僅供寫入。

auth_hex_data

string

目前的十六進位認證資料；僅供寫入。

authhexdata

string

已棄用的舊版十六進位認證資料欄位；僅供寫入。

pq_handshake_mode

string

WhatsApp Protocol 會話匯入的 PQ 交握模式。

use_xxkem_handshake

boolean

WhatsApp Protocol 會話匯入是否使用 XXKEM 交握。

tiktok

object

僅用於 auth_mode=session 的 TikTok 帳號。提交時，tiktok 必須是唯一的頂層欄位，其內部僅接受 cookies 與選填的 user_id。整個匯入 JSON 不超過 65536 位元組。通過格式驗證不表示憑證有效或授權成功。需要掃碼或驗證碼時會回傳相應等待狀態；session 模式暫不提供這些步驟的互動接續。不保證重複匯入會覆蓋既有登入或實現 Cookie 熱替換。

user_id

string

選填相容欄位，不用於身分驗證或綁定；實際身分以授權結果為準。

cookies[]

object[]

提交 tiktok 時必填：包含 1–128 個 Cookie 的唯寫陣列。同名同網域不可重複，其他匯出的 Cookie 屬性予以保留。有效性由登入結果判斷。

minItems: 1 · maxItems: 128

name

string

每個 TikTok Cookie 必填的非空名稱。

minLength: 1

value

string

每個 TikTok Cookie 必填的非空值；唯寫。

minLength: 1

domain

string

每個 TikTok Cookie 必填的非空網域，保留匯出值。

minLength: 1

path

string

每個 TikTok Cookie 必填的路徑，必須以 / 開頭。

pattern: ^/

expires

number

選填的匯出 Unix 秒時間戳或工作階段 Cookie 標記；不在匯入階段判斷是否過期。

secure

boolean

選填的 TikTok Cookie 匯出 Secure 旗標。

http_only

boolean

選填的 TikTok Cookie 匯出 HttpOnly 旗標。

same_site

string

選填的 TikTok Cookie 匯出 SameSite 值。

如何理解結果

先讀取授權結果，再檢查 runtime_status。匯入與建立連線是不同階段。

回應 pending · TikTok session

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "account_id": "acc_example",
    "provider": "tiktok",
    "action": "import_session",
    "status": "pending",
    "runtime_status": "starting"
  }
}

回應 authorized

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "account_id": "acc_example",
    "status": "authorized"
  }
}

回應內容

account_id

string

本回應所對應的渠道帳號。

status

string

目前授權流程狀態，例如 pending_auth、awaiting_qr_scan、awaiting_code、pending、passkey_required、passkey_pending、passkey_confirmation、passkey_confirmation_sent、authorized 或 failed。

回應

200

200 OK

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

400

請求錯誤

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

401

未授權

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

403

禁止存取

請求已識別，但不允許執行此操作。

404

找不到資源

找不到請求的資源；請結合 error.code 和目前操作核對。

409

衝突

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

500

伺服器錯誤

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

502

上游閘道錯誤

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

失敗後如何處理

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

結合目前操作讀取 HTTP 狀態、error.code 和 error.numeric_code。數字碼以字串處理。保留 request_id 排查；它不是冪等鍵或任務識別碼。

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

provider_invalid_request · 30001 · 400

檢查管道專屬欄位及格式。

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

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

{
  "request_id": "req_example",
  "error": {
    "code": "provider_invalid_request",
    "numeric_code": "30001",
    "message": "Provider rejected the request"
  }
}

unsupported_action · 30005 · 400

無法識別此帳號操作，請使用文件列出的操作。

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

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

{
  "request_id": "req_example",
  "error": {
    "code": "unsupported_action",
    "numeric_code": "30005",
    "message": "Action not supported"
  }
}

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

account_already_authorized · 20016 · 409

帳號已完成授權，本次動作拒絕重複授權。重新整理授權狀態並沿用已完成結果，不要循環重新授權或取消。

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

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

{
  "request_id": "req_example",
  "error": {
    "code": "account_already_authorized",
    "numeric_code": "20016",
    "message": "Account is already authorized; re-authentication is not required"
  }
}

account_binding_not_found · 30006 · 409

帳號尚無有效的管道連線綁定，請檢查帳號狀態。

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

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

{
  "request_id": "req_example",
  "error": {
    "code": "account_binding_not_found",
    "numeric_code": "30006",
    "message": "Account is not bound to an available server"
  }
}

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_account_mismatch · 20017 · 409

請求中的管道身分與帳號綁定不一致。

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

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

{
  "request_id": "req_example",
  "error": {
    "code": "provider_account_mismatch",
    "numeric_code": "20017",
    "message": "Authenticated provider account does not match the bound account; re-scan with the original account"
  }
}

provider_not_ready · 30009 · 409

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

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

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

wallet_account_creation_in_progress · 20030 · 409

同一工作區已有餘額帳號正在建立，或目標帳號尚未完成初始化。

處理與重試: 帳號建立發生競爭時，依 Retry-After 等待。若原請求提供 Idempotency-Key，請沿用原鍵重試。授權請求遇到此錯誤時，使用建立回應的 billing.operation_id 查詢 GET /v1/account-operations/{operation_id}，等待 data.state=SUCCEEDED 後在原帳號上重試原操作。billing.state=ACTIVE 不代表初始化完成；請勿重新建立帳號。

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

{
  "request_id": "req_example",
  "error": {
    "code": "wallet_account_creation_in_progress",
    "numeric_code": "20030",
    "message": "Account creation is in progress; please wait"
  }
}

run_auth_action_failed · 20010 · 500

執行授權動作：授權動作失敗，需檢查既有流程，不代表必須重新授權。

處理與重試: 查詢目前授權流程，檢查是否需要使用者操作。不要僅因本次失敗重新發起授權，也不要向已過期或已結束的工作階段重複提交。

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

{
  "request_id": "req_example",
  "error": {
    "code": "run_auth_action_failed",
    "numeric_code": "20010",
    "message": "Failed to run auth action"
  }
}

run_auth_action_failed · 20020 · 500

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

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

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

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

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

provider_adapter_not_found · 30004 · 502

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

處理與重試: 查詢目前授權流程，檢查是否需要使用者操作。不要僅因本次失敗重新發起授權，也不要向已過期或已結束的工作階段重複提交。

示意 JSON；message 隨實際原因變化 · 502 · 30004

{
  "request_id": "req_example",
  "error": {
    "code": "provider_adapter_not_found",
    "numeric_code": "30004",
    "message": "Provider adapter unavailable"
  }
}

provider_unavailable · 30002 · 502

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

處理與重試: 查詢目前授權流程，檢查是否需要使用者操作。不要僅因本次失敗重新發起授權，也不要向已過期或已結束的工作階段重複提交。

範例 · 502 · 30002

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

provider_unavailable · 30020 · 502

whatsapp-protocol 同步請求以 numeric_code=30020 標識帳號登入受限，可影響工作階段匯入、執行狀態、傳送與聯絡人查詢，並保留目前操作的 HTTP 狀態與 code。不要將 WhatsApp 的 20102 回呼契約套用到此渠道。

處理與重試: 停止自動傳送與重試，引導使用者前往官方 WhatsApp 用戶端檢查並處理限制。問題解決並完成必要的重新授權後再恢復；先前為 running 不證明限制已解除。

適用渠道: WhatsApp Protocol

範例 · 502 · 30020

{
  "request_id": "req_example_account_restricted",
  "error": {
    "code": "provider_unavailable",
    "numeric_code": "30020",
    "message": "Account login is restricted. Check the official WhatsApp app for details."
  }
}