切换禁止进群

1. 接口定位

• 接口名称: 切换禁止进群
• 所属域: admin/group
• 业务目标: 一次调用切换 joinDisabled 状态

2. 请求定义

• Method: POST
• Path: /adminx/group/settings/toggle_join_disabled
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 需要 Header token，且必须是管理员 token
• 幂等性: 非幂等（每次调用都会反转状态）

3. 请求参数

Header 参数

字段	必填	类型	说明
operationID	是	string	链路追踪 ID
token	是	string	管理员 token

Body 参数

字段	必填	类型	说明
groupID	是	string	群组 ID

4. 响应结构

通用响应包裹

字段	类型	说明
errCode	int	错误码，0 表示成功
errMsg	string	错误简述
errDlt	string	错误详情
data	object	业务数据

data 字段

字段	类型	说明
groupID	string	群组 ID
joinDisabled	bool	切换后的状态

5. 业务规则

• 若该群无 settings 记录，初始按 joinDisabled=false 处理，再切换为 true。
• 该接口主要用于后台快速开关，不替代审计流程。

6. 错误码与失败场景

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

7. 示例

fetch 请求示例

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

成功响应示例

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

8. 变更记录

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