渠道方

列出渠道區域

回傳渠道已經開通嘅區域清單。supported 表示渠道係咪喺呢個區域可用；allocatable 表示目前係咪可以喺呢個區域綁定新帳號。

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

呼叫前準備

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

請求參數

請求標頭

X-Api-Key

string必填

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

路徑參數

provider

string必填

用嚟識別嗰條 providers 路由嘅 ID。

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

請求內容

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

如何理解結果

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

回應 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: 檢查必填欄位、格式與渠道條件，修正請求後再呼叫。
invalid_api_key · 11001 · 401: 檢查 X-Api-Key 與工作區是否有效。