群組

管理群組成員

新增或移除一名成員，或升降一名管理員 —— 每次呼叫僅處理單一成員、單一動作。group_id、member_id、action（add | remove | promote | demote）透過 JSON body 傳入。WhatsApp 的 member_id 取自 List conversation members 回傳的 peer_id（即 LID）。

POSThttps://api.unifyport.ai/v1/accounts/{account_id}/groups/members

呼叫前準備

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

參數從哪裡取得

account_id: 從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。取得帳號

請求

curl -X POST "https://api.unifyport.ai/v1/accounts/{account_id}/groups/members" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "group_id": "group_example",
  "action": "add",
  "member_id": "member_example"
}'

請求參數

請求標頭

X-Api-Key

string必填

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

Content-Type

string必填

傳送 JSON 請求內容時請使用 application/json。

路徑參數

account_id

string必填

用於該 groups 路由的識別字。

請求內容

group_id

string必填

目標群組識別字。

action

string必填

渠道支援的成員或審批操作。

enum: add, remove, promote, demote

member_id

string必填

成員的渠道側識別字。

如何理解結果

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

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "ok": true
  }
}

回應內容

ok

boolean

操作成功時恆為 true；失敗時則改回傳非 2xx 狀態碼。

回應

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