API 參考

渠道方

列出渠道區域

回傳某個 provider 已開通的區域。supported 代表 provider 在該區域是否可運作；allocatable 代表目前是否可在該區域綁定新帳號。

GEThttps://api.unifyport.ai/v1/providers/{provider}/regions

支援渠道

all

呼叫前準備

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

請求參數

請求標頭

X-Api-Key
string必填

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

路徑參數

provider
string必填

用於該 providers 路由的識別字。

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp-protocol, x, x_client, twitter_client

請求內容

此介面無需 JSON 請求內容。

如何理解結果

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

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "provider": "telegram",
    "regions": [
      {
        "region": "global",
        "supported": true,
        "allocatable": true
      }
    ]
  }
}

回應內容

provider
string

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

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

regions[]
object[]

區域清單，每筆項目包含 supported 與 allocatable。

region
string

渠道部署區域識別字。

supported
boolean

渠道是否已在此區域運作。

allocatable
boolean

目前是否可以在此區域分配新帳號。

回應

200

200 OK

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

400

請求錯誤

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

401

未授權

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

500

伺服器錯誤

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

失敗後如何處理

檢查 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 與工作區是否有效。