會話
列出會話成員
列出 group 類型會話嘅成員。conversation_id 走 query 參數,用 cursor / limit 分頁。每項回傳 peer_id / display_name / avatar_url;role 只會係 member、admin 或 superadmin,其中 superadmin 代表群主或建立者。會話類型唔支援成員查詢嘅時候(例如一對一)會回傳 400。
https://api.unifyport.ai/v1/accounts/{account_id}/conversations/members呼叫前準備
在伺服器端使用資源所屬工作區的 X-Api-Key,執行範例前替換所有預留位置。
參數從哪裡取得
- account_id
- 從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。 攞帳號
- conversation_id
- 想查嘅對話 —— 即係 List conversations 回返嘅 conversation_id 嗰個值。
請求參數
請求標頭
X-Api-Key工作區 API Key,工作區會由呢個標頭解析得出嚟。
路徑參數
account_id用嚟識別嗰條 conversations 路由嘅 ID。
查詢參數
conversation_id想查嘅對話 —— 即係 List conversations 回返嘅 conversation_id 嗰個值。
type對話類型(user、group 或者 channel),用嚟消除查詢嘅歧義。
enum: user, group, channel
cursor上一個回應嘅 next_cursor。唔填或留空由第一頁開始;無效或過期 cursor 嘅處理按渠道而異。
limit單頁數量範圍 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成員嘅渠道側穩定識別碼,請當作不透明字串儲存同使用。
username渠道有提供時回傳嘅成員 username。
display_name成員嘅顯示名稱;冇嘅話就係空字串。
avatar_url成員嘅頭像 URL;冇嘅話就係空字串。
role歸一化群組角色:群主或建立者係 superadmin,管理員係 admin,普通或未知角色係 member。
enum: member, admin, superadmin
joined_at渠道回報嘅成員加入時間。
format: date-time
extra渠道專屬嘅成員欄位,例如電話號碼。
next_cursor下一頁嘅 opaque cursor。攞返佢做 cursor 傳返入嚟;如果係空字串就代表冇下一頁喇。
has_more呢一頁之後仲有結果嗰陣會係 true。
回應
200200 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 與工作區是否有效。