API 參考

聯絡人

攞黑名單

回傳已封鎖聯絡人識別碼嘅完整清單。dhash 係清單指紋——快取低，下次叫嗰陣比對下，就唔使逐項 diff 都知有冇變化。

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/contacts/blocklist

呼叫前準備

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

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

請求參數

請求標頭

X-Api-Key
string必填

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

路徑參數

account_id
string必填

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

請求內容

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

如何理解結果

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

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "blocklist": [
      "user_example",
      "user_other"
    ],
    "dhash": "2:abcdef123456"
  }
}

回應內容

blocklist[]
string[]

已封鎖聯絡人識別碼嘅陣列。

dhash
string

封鎖名單嘅指紋；cache 住佢，下次 call 嗰陣比對返，唔使逐個 diff 個陣列都知有冇變。

回應

200

200 OK

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

401

未授權

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

409

衝突

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

500

伺服器錯誤

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

501

渠道未實作

所選渠道未實作呢個操作。

502

上游閘道錯誤

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

失敗後如何處理

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

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