API 參考

會話

列出會話成員

列出 group 類型會話的成員。conversation_id 透過 query 參數傳入,以 cursor / limit 分頁。每筆回傳 peer_id / display_name / avatar_url;role 僅為 member、admin 或 superadmin,其中 superadmin 表示群主或建立者。會話類型不支援成員查詢(例如一對一)時回傳 400。

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

呼叫前準備

在伺服器端使用資源所屬工作區的 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

cursor
string

前一回應的 next_cursor。省略或留空從第一頁開始;無效或過期游標的處理依渠道而異。

limit
integer

單頁數量範圍 1..100;預設值見各端點說明。

minimum: 1 · maximum: 100

請求內容

此介面無需 JSON 請求內容。

如何理解結果

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

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "items": [
      {
        "peer_id": "user_example",
        "display_name": "",
        "avatar_url": "",
        "role": "superadmin"
      }
    ],
    "next_cursor": "",
    "has_more": false
  }
}

回應內容

peer_id
string

成員的渠道側穩定識別字,請當作不透明字串儲存與使用。

username
string

渠道有提供時回傳的成員 username。

display_name
string

成員顯示名稱;若缺少則為空字串。

avatar_url
string

成員頭像 URL;若缺少則為空字串。

role
string

正規化群組角色:群主或建立者為 superadmin,管理員為 admin,一般或未知角色為 member。

enum: member, admin, superadmin

joined_at
string

渠道回報的成員加入時間。

format: date-time

extra
object

渠道專屬的成員欄位,例如電話號碼。

next_cursor
string

指向下一頁的不透明游標。請以 cursor 原樣回傳;空字串表示已無更多分頁。

has_more
boolean

當本頁之外仍有更多結果時為 true。

回應

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