获取客户端配置

1. 接口定位

• 接口名称: 获取客户端配置
• 所属域: admin/client-config
• 业务目标: 读取当前客户端初始化配置键值对集合

2. 请求定义

• Method: POST
• Path: /client_config/get
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 路由层要求管理员 token
• 幂等性: 幂等

3. 请求参数

Header 参数

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

Body 参数

• 无业务参数，请传空对象 {}。

4. 响应结构

通用响应包裹

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

data 字段

字段	类型	说明
config	object	客户端配置键值对，键和值均为字符串

5. 业务规则

• 路由层要求管理员权限。
• RPC 实现本身不再次校验管理员身份，权限控制依赖 API 路由中间件。
• 数据来源是 client_config 集合中的全量 key -> value 映射。
• 如果当前没有任何配置，返回空对象。

6. 错误码与失败场景

错误码	场景	典型报错
-	数据库读取失败	由数据库层返回原始错误
-	token 无效	由路由鉴权中间件返回

7. 示例

fetch 请求示例

fetch("http://localhost:10009/client_config/get", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440504",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例（JSON）

{}

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "config": {
      "registerWelcomeText": "Welcome to OpenIM",
      "defaultLanguage": "en-US"
    }
  }
}

8. 时序流程

1. 中间件校验管理员 token。
2. 读取 client_config 集合中的全部配置项。
3. 将结果组装成 config 键值对对象返回。

9. 变更记录

• 2026-03-31: 首版发布，基于客户端配置全量读取逻辑补全文档。