會話
列出會話
即時列出會話。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 路由的識別字。
查詢參數
type以逗號分隔的 user、group、channel 精確值；不會 trim 或正規化。
cursor前一回應的 next_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對話識別字。傳送訊息或呼叫對話相關路由時，請以此作為目標。
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指向下一頁的不透明游標。請以 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 與工作區是否有效。