Skip to content

获取群设置 ​

1. 接口定位 ​

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

2. 请求定义 ​

  • Method: POST
  • Path: /adminx/group/settings/get
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 需要 Header token,且必须是管理员 token
  • 幂等性: 幂等(只读操作)

3. 请求参数 ​

Header 参数 ​

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

Body 参数 ​

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

4. 响应结构 ​

通用响应包裹 ​

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

data 字段 ​

字段类型说明
groupIDstring群组 ID
joinDisabledbool是否禁止进群,默认 false(无记录时按 false)

5. 业务规则 ​

  • group_settings 与群组是 1:1 关系。
  • 未写入过该群设置时,默认返回 joinDisabled=false。

6. 错误码与失败场景 ​

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

7. 示例 ​

fetch 请求示例 ​

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

成功响应示例 ​

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

8. 变更记录 ​

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