设置客户端配置

1. 接口定位

• 接口名称: 设置客户端配置
• 所属域: admin/client-config
• 业务目标: 批量新增或更新客户端初始化配置项

2. 请求定义

• Method: POST
• Path: /client_config/set
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 需要 Header token，且必须是管理员 token
• 幂等性: 对同一组键值对重复提交可视为幂等；现有键会被覆盖更新

3. 请求参数

Header 参数

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

Body 参数

字段	必填	类型	说明
config	是	object	配置键值对，键和值均为字符串

字段约束

• 协议校验要求 config 不能为 null。
• RPC 层还要求 config 至少包含 1 个键值对；空对象会返回 update config empty。

4. 响应结构

通用响应包裹

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

data 字段

• 本接口成功时返回空对象（无业务字段）。

5. 业务规则

• 仅管理员可以调用。
• 数据库层会对 config 中的每个键逐条执行 upsert：
  • 键不存在时插入
  • 键已存在时更新 value
• 每个配置项独立写入，当前实现不是单事务批量提交。

6. 错误码与失败场景

错误码	场景	典型报错
1001	config 为 null	config is empty
1001	config 为空对象	update config empty
-	数据库写入失败	由数据库层返回原始错误

7. 示例

fetch 请求示例

fetch("http://localhost:10009/client_config/set", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440505",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    config: {
      registerWelcomeText: "Welcome to OpenIM",
      defaultLanguage: "en-US",
    },
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例（JSON）

{
  "config": {
    "registerWelcomeText": "Welcome to OpenIM",
    "defaultLanguage": "en-US"
  }
}

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {}
}

失败响应示例

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "update config empty"
}

8. 时序流程

1. 中间件校验管理员 token。
2. 校验 config 是否为空。
3. 遍历每个配置项，按 key 执行 upsert。
4. 全部写入完成后返回成功响应。

9. 变更记录

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