Skip to content

设置群设置

1. 接口定位

  • 接口名称: 设置群设置
  • 所属域: admin/group
  • 业务目标: 写入群组 settings 中的进群开关

2. 请求定义

  • Method: POST
  • Path: /adminx/group/settings/set
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 需要 Header token,且必须是管理员 token
  • 幂等性: 幂等(相同参数可重复提交)

3. 请求参数

Header 参数

字段必填类型说明
operationIDstring链路追踪 ID
tokenstring管理员 token

Body 参数

字段必填类型说明
groupIDstring群组 ID
joinDisabledbool是否禁止进群,true 为禁止

4. 响应结构

通用响应包裹

字段类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简述
errDltstring错误详情
dataobject业务数据

data 字段

字段类型说明
groupIDstring群组 ID
joinDisabledbool当前写入结果

5. 业务规则

  • group_settingsgroupID 唯一 upsert。
  • 每次写入都会覆盖 joinDisabled 并记录最近操作人和更新时间。

6. 错误码与失败场景

错误码场景典型报错
1001Header 缺少 operationIDheader must have operationID
1001groupID 为空groupID is empty
-缺少管理员 token由管理员鉴权链路返回

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10011/adminx/group/settings/set", {
  method: "POST",
  headers: {
    operationID: "group-settings-set-001",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    groupID: "group_001",
    joinDisabled: true,
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "groupID": "group_001",
    "joinDisabled": true
  }
}

8. 变更记录

  • 2026-07-28: 新增群设置写入接口文档。