聯絡人

取得聯絡人詳情

即時回傳聯絡人詳情。一般聯絡人唔存在回傳 404 contact_not_found；目標會話唔存在時回傳 422 contact_not_found、numeric_code=35000、message=Conversation not found。

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

呼叫前準備

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

參數從哪裡取得

account_id: 從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。攞帳號
contact_id: 渠道側聯絡人標識，請當作不透明字串傳遞。whatsapp 同 whatsapp-protocol 統一使用 LID（xxx@lid）。whatsapp-protocol 聯絡人資料欄位缺失時仍可能回傳成功，請以實際回傳欄位為準。

WhatsApp Protocol: 聯絡人詳情需要現有 LID（xxx@lid）。只有入站事件的 data.sender.id 或 data.conversation.id 已以 @lid 結尾時才能直接使用。Protocol 不提供聯絡人清單查詢，此介面也無法從電話號碼推算 LID；沒有 LID 時無法進行此查詢。成功回應可能缺少資料欄位。

請求參數

請求標頭

X-Api-Key

string必填

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

路徑參數

account_id

string必填

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

查詢參數

contact_id

string必填

渠道側聯絡人標識，請當作不透明字串傳遞。whatsapp 同 whatsapp-protocol 統一使用 LID（xxx@lid）。whatsapp-protocol 聯絡人資料欄位缺失時仍可能回傳成功，請以實際回傳欄位為準。

請求內容

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

如何理解結果

僅使用實際返回的資料欄位。標識視為不透明字串，欄位缺失不等於聯絡人不存在。

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "id": "user_example",
    "conversation_id": "peer_example",
    "display_name": "Alice",
    "avatar_url": "",
    "provider_user_id": "user_example",
    "extra": {
      "phone": "8600000000000"
    }
  }
}

回應內容

id

string

聯絡人識別碼。

conversation_id

string

呢個聯絡人嘅對話識別碼；攞佢嚟發訊息或者搵返個對話。

display_name

string

聯絡人嘅顯示名稱；冇嘅話就係空字串。

avatar_url

string

聯絡人嘅頭像 URL；冇嘅話就係空字串。

provider_user_id

string

聯絡人喺渠道側嘅用戶識別碼。

is_blocked

boolean

呢個聯絡人有冇畀連接帳號封鎖。

extra

object

渠道專屬嘅額外欄位，例如 phone。

phone

string

WhatsApp phone JID 中解析出的纯手机号。

first_name

string

当前账号通讯录中保存的联系人简称或名字部分。

full_name

string

当前账号通讯录中保存的完整联系人名称。

push_name

string

联系人自行在 WhatsApp 设置的个人名称。

business_name

string

WhatsApp Business 账号的商业或认证名称。

redacted_phone

string

Provider 仅返回部分号码时的遮蔽手机号。

回應

200

200 OK

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

400

請求錯誤

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

401

未授權

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

404

搵唔到資源

搵唔到請求嘅渠道資源。

409

衝突

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

422

無法處理嘅實體

請求格式有效，但解析唔到目標渠道會話。

500

伺服器錯誤

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

501

渠道未實作

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

502

上游閘道錯誤

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

失敗後如何處理

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

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