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 路由的識別字。

請求內容

此介面無需 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

封鎖清單的指紋；可快取之，並於下次呼叫時比對，毋須逐項比對陣列即可偵測變更。

回應

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