API 參考
群組POST

設定入群審批模式

開或者關群組嘅入群審批。enabled 係必填布林值——開咗之後新成員必須先過審批先入到群。

https://api.unifyport.ai/v1/accounts/{account_id}/groups/join-approval-mode

請求標頭

X-Api-Key
string必填

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

Content-Type
string必填

發送 JSON 請求內容嘅時候請用 application/json。

路徑參數

account_id
string必填

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

請求內容

group_id
string必填

目標群組識別碼。

enabled
boolean必填

係咪要求管理員審批新成員。

回應內容

ok
boolean

操作成功嗰陣永遠係 true;失敗就唔會回 2xx 狀態碼。

回應

200
200 OK

請求成功,回應內容嘅例子如上。

400
請求錯誤

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

401
未授權

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

404
搵唔到資源

搵唔到請求嘅渠道資源。

409
衝突

目前操作同現有嘅渠道帳號或者資源衝突。

500
伺服器錯誤

服務遇到咗未預期嘅錯誤。

501
渠道未實作

所選渠道未實作呢個操作。

502
上游閘道錯誤

渠道轉接器或者上游渠道未能完成呢個操作。

請求

curl -X POST https://api.unifyport.ai/v1/accounts/{account_id}/groups/join-approval-mode \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "group_id": "group_example",
  "enabled": true
}'

回應

{
  "data": {
    "ok": true
  }
}