帳號

列出帳號

列出目前工作區嘅渠道帳號。帳號嘅認證狀態經過 Authentication 介面公開。

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

呼叫前準備

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

請求參數

請求標頭

X-Api-Key

string必填

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

查詢參數

limit

integer

每頁最多返回嘅帳號數，範圍係 1 至 100，唔填時係 20。無效值或重複傳入 limit 會返回 400 invalid_request（numeric_code=10000）；讀取後續頁面時可以調整此值。

minimum: 1 · maximum: 100

cursor

string

帳號列表嘅不透明游標。唔填或傳入空字串會讀取第一頁；讀取後續頁面時，將上次回應嘅 data.next_cursor 原樣傳返。只適用於簽發時嘅 workspace；無效、重複傳入或跨 workspace 使用 cursor 會返回 400 invalid_request（numeric_code=10000）。

請求內容

呢個介面唔需要 JSON 請求內容。

如何理解結果

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

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "items": [
      {
        "id": "acc_example",
        "name": "Telegram Production",
        "provider": "telegram",
        "region": "global",
        "status": "active",
        "runtime_status": "running",
        "auth_mode": "qrcode",
        "capabilities": [
          "send_message",
          "receive_message"
        ],
        "metadata": {
          "env": "production"
        },
        "provider_account_ref": "provider-side-identifier",
        "provider_profile": {
          "id": "778899",
          "phone": "8600000000000",
          "username": "production_bot",
          "display_name": "Production Bot",
          "first_name": "Production",
          "last_name": "Bot",
          "avatar_url": "https://example.com/avatar.jpg",
          "bio": "Customer support"
        }
      }
    ],
    "has_more": false
  }
}

回應內容

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 設定，未設定就唔會回。

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

has_more

boolean

帳號列表係咪仲有下一頁。

next_cursor

string

帳號列表下一頁嘅不透明游標，只會喺 has_more=true 時返回；讀取下一頁時原樣傳入 cursor，最後一頁會省略此欄位。

回應

200

200 OK

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

400

請求錯誤

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

401

未授權

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

500

伺服器錯誤

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

失敗後如何處理

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

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