聯絡人
列出聯絡人
即時列出聯絡人。limit 範圍 1..100，預設 50；cursor 無效或過期時由各渠道分別處理。q 匹配 display_name / phone / username，updated_since 用於渠道支援嘅增量同步。
https://api.unifyport.ai/v1/accounts/{account_id}/contacts呼叫前準備
在伺服器端使用資源所屬工作區的 X-Api-Key，執行範例前替換所有預留位置。
參數從哪裡取得
- account_id
- 從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。 攞帳號
請求參數
請求標頭
X-Api-Key工作區 API Key，工作區會由呢個標頭解析得出嚟。
路徑參數
account_id用嚟識別嗰條 contacts 路由嘅 ID。
查詢參數
cursor上一個回應嘅 next_cursor。唔填或留空由第一頁開始；無效或過期 cursor 嘅處理按渠道而異。
limit單頁數量範圍 1..100；預設值睇各端點說明。
minimum: 1 · maximum: 100
q搜尋過濾條件，會比對 display_name、phone 或者 username。
updated_sinceRFC3339 時間戳；淨係回喺嗰陣之後有更新嘅聯絡人，喺渠道支援嘅時候用嚟做增量同步。
format: date-time
請求內容
呢個介面唔需要 JSON 請求內容。
如何理解結果
依文件解讀回應欄位與 HTTP 狀態。204 成功沒有回應本文，排查時使用 X-Request-Id。下一步請參閱相關操作。
回應 200 OK
{
"request_id": "<REQUEST_ID>",
"data": {
"items": [
{
"id": "user_example",
"conversation_id": "peer_example",
"display_name": "Alice",
"avatar_url": "",
"provider_user_id": "user_example",
"extra": {
"phone": "8600000000000"
}
}
],
"next_cursor": "",
"has_more": false
}
}
回應內容
id聯絡人識別碼。
conversation_id呢個聯絡人嘅對話識別碼；攞佢嚟發訊息或者搵返個對話。
display_name聯絡人嘅顯示名稱；冇嘅話就係空字串。
avatar_url聯絡人嘅頭像 URL；冇嘅話就係空字串。
provider_user_id聯絡人喺渠道側嘅用戶識別碼。
is_blocked呢個聯絡人有冇畀連接帳號封鎖。
extraobject渠道專屬嘅額外欄位，例如 phone。
extra渠道專屬嘅額外欄位，例如 phone。
phoneWhatsApp phone JID 中解析出的纯手机号。
first_name当前账号通讯录中保存的联系人简称或名字部分。
full_name当前账号通讯录中保存的完整联系人名称。
push_name联系人自行在 WhatsApp 设置的个人名称。
business_nameWhatsApp Business 账号的商业或认证名称。
redacted_phoneProvider 仅返回部分号码时的遮蔽手机号。
next_cursor下一頁嘅 opaque cursor。攞返佢做 cursor 傳返入嚟；如果係空字串就代表冇下一頁喇。
has_more呢一頁之後仲有結果嗰陣會係 true。
回應
200200 OK
請求成功，回應內容嘅例子如上。
400請求錯誤
請求內容、路徑或者參數無效。
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 與工作區是否有效。