获取配置

1. 接口定位

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

2. 请求定义

• Method: POST
• Path: /client_config/get
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 无
• 幂等性: 幂等（只读操作）

3. 请求参数

Header 参数

字段	必填	类型	说明
operationID	是	string	链路追踪 ID
token	否	string	本接口无需 token

Body 参数

• 无请求字段；当前协议 GetClientConfigReq 为空对象。

4. 响应结构

通用响应包裹

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

data 字段

字段	类型	说明
config	map<string, string>	客户端配置键值对集合

5. 业务规则

• 实际数据来源于 admin 服务的 client_config 集合。
• 当前实现不区分登录态，任何客户端都可读取全部配置。
• 返回的是完整配置 map，不支持按 key 过滤。
• 若数据库中没有配置项，返回空 map。

6. 错误码与失败场景

错误码	场景	典型报错
1001	Header 缺少 operationID	header must have operationID
-	数据库查询失败	由 MongoDB 查询链路返回

7. 示例

fetch 请求示例

fetch("http://localhost:10008/client_config/get", {
  method: "POST",
  headers: {
    operationID: "client-config-get-001",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "config": {
      "register.allow": "true",
      "app.welcome": "欢迎使用 OpenIM Chat",
      "livekit.serverUrl": "wss://rtc.example.com"
    }
  }
}

8. 时序流程

1. 校验 operationID。
2. 调用 admin 服务读取全部客户端配置。
3. 将配置列表组装为 map 返回。

9. 变更记录

• 2026-03-31: 首版发布，基于 client API 路由与 admin 客户端配置实现整理。