API 參考

會話

取得會話詳情

即時回傳一條會話的詳情。conversation_id 透過 query 參數傳入（其值即為 List conversations 回傳的 id）。回應固定包含 conversation_id / type / title / avatar_url（缺值時為空字串），並依會話類型補上 members_count 等欄位；找不到會話時回傳 404。

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

呼叫前準備

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

參數從哪裡取得
account_id
從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。 取得帳號
conversation_id
要查詢的對話 — 即列出對話時以 conversation_id 回傳的值。

請求參數

請求標頭

X-Api-Key
string必填

工作區 API Key，工作區會由此標頭解析得到。

路徑參數

account_id
string必填

用於該 conversations 路由的識別字。

查詢參數

conversation_id
string必填

要查詢的對話 — 即列出對話時以 conversation_id 回傳的值。

type
string

對話類型（user、group 或 channel），用於釐清查詢對象。

enum: user, group, channel

請求內容

此介面無需 JSON 請求內容。

如何理解結果

依文件解讀回應欄位與 HTTP 狀態。204 成功沒有回應本文，排查時使用 X-Request-Id。下一步請參閱相關操作。

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "conversation_id": "peer_example",
    "type": "group",
    "title": "Group title",
    "avatar_url": "",
    "description": "...",
    "unread_count": 0,
    "members_count": 42
  }
}

回應內容

conversation_id
string

對話識別字。傳送訊息或呼叫對話相關路由時，請以此作為目標。

type
string

標準對話類型：user、group 或 channel。WhatsApp 社群公告群組繼續使用 group。

enum: user, group, channel

title
string

對話的顯示標題。

username
string

渠道有提供時回傳的對話 username。

avatar_url
string

頭像 URL；若未設定則為空字串。

description
string

群組或頻道描述（若有提供）。

last_message_at
string

最近一則訊息的 RFC3339 時間戳記。

format: date-time

last_message_text
string

最近一則訊息的文字預覽（若有）。

unread_count
integer

對話中的未讀訊息數量。

format: int64

members_count
integer

成員數量；針對群組對話回傳。

format: int64

subscribers_count
integer

頻道類對話的訂閱者數量（若有）。

format: int64

is_pinned
boolean

連接帳號是否已置頂此對話。

is_muted
boolean

連接帳號是否已將此對話靜音。

created_at
string

渠道有提供時回傳的對話建立時間。

format: date-time

extra
object

渠道擴充欄位；WhatsApp 群組對話可包含公告群組分類，對話列表不保證提供該分類。

is_announcement_group
boolean

僅 WhatsApp 群組提供。true 表示已確認為社群公告群組，false 表示本次資料已確認不符合公告群組條件；缺少表示未知，不回傳 null。此分類不表示目前帳號具備傳送訊息的權限。

回應

200

200 OK

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

400

請求錯誤

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

401

未授權

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

404

找不到資源

找不到請求的渠道資源。

409

衝突

目前操作與既有的渠道帳號或資源衝突。

500

伺服器錯誤

服務遇到了未預期的錯誤。

501

渠道尚未實作

所選渠道尚未實作此操作。

502

上游閘道錯誤

渠道轉接器或上游渠道未能完成此操作。

失敗後如何處理

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

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