會話

取得會話詳情

即時回傳一條會話嘅詳情。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: 想查嘅對話 —— 即係 List conversations 回返嘅 conversation_id 嗰個值。

請求參數

請求標頭

X-Api-Key

string必填

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

路徑參數

account_id

string必填

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

查詢參數

conversation_id

string必填

想查嘅對話 —— 即係 List conversations 回返嘅 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

對話識別碼。發送訊息或者 call 對話路由嗰陣攞佢做目標。

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 與工作區是否有效。