會話
列出會話
即時列出會話。limit 範圍 1..100，預設 20；type 係逗號分隔嘅 user / group / channel 精確值，唔會 trim。WhatsApp 冇傳 label_id 時淨係回傳「特別關注」會話。無效 cursor 嘅處理按渠道而定。
https://api.unifyport.ai/v1/accounts/{account_id}/conversations呼叫前準備
在伺服器端使用資源所屬工作區的 X-Api-Key，執行範例前替換所有預留位置。
參數從哪裡取得
- account_id
- 從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。 攞帳號
請求參數
請求標頭
X-Api-Key工作區 API Key，工作區會由呢個標頭解析得出嚟。
路徑參數
account_id用嚟識別嗰條 conversations 路由嘅 ID。
查詢參數
type逗號分隔嘅 user、group、channel 精確值；唔會 trim 或正規化。
cursor上一個回應嘅 next_cursor。唔填或留空由第一頁開始；無效或過期 cursor 嘅處理按渠道而異。
limit單頁數量範圍 1..100；預設值睇各端點說明。
minimum: 1 · maximum: 100
label_id渠道標籤精確識別碼；WhatsApp 省略時回傳「特別關注」會話。
請求內容
呢個介面唔需要 JSON 請求內容。
如何理解結果
依文件解讀回應欄位與 HTTP 狀態。204 成功沒有回應本文，排查時使用 X-Request-Id。下一步請參閱相關操作。
回應 200 OK
{
"request_id": "<REQUEST_ID>",
"data": {
"items": [
{
"conversation_id": "peer_example",
"type": "user",
"title": "Display name",
"avatar_url": "",
"unread_count": 3,
"last_message_at": "2026-05-13T10:00:00Z"
}
],
"next_cursor": "",
"has_more": false
}
}
回應內容
conversation_id對話識別碼。發送訊息或者 call 對話路由嗰陣攞佢做目標。
type對話類型：user、group 或者 channel。
enum: user, group, channel
title對話嘅顯示標題。
username渠道有提供時回傳嘅對話 username。
avatar_url頭像 URL；冇設定嘅話就係空字串。
description群組或者頻道嘅描述，有就回。
last_message_at最近一條訊息嘅 RFC3339 時間戳。
format: date-time
last_message_text最近一條訊息嘅文字預覽，有就回。
unread_count對話入面未讀訊息嘅數目。
format: int64
members_count成員數目；群組對話先會回。
format: int64
subscribers_count頻道類對話嘅訂閱者數目，有就回。
format: int64
is_pinned連接帳號有冇置頂呢個對話。
is_muted連接帳號有冇將呢個對話靜音。
created_at渠道有提供時回傳嘅對話建立時間。
format: date-time
extra標準結構未覆蓋嘅渠道專屬欄位。
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 與工作區是否有效。