修改朋友圈设置
1. 接口定位
- 接口名称: 修改朋友圈设置
- 所属域: chat/moments
- 业务目标: 修改当前登录用户的朋友圈个人设置,当前支持背景图
2. 请求定义
- Method:
POST - Path:
/chatx/moments/settings/update - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 必填,请通过 Header
token传入有效登录令牌 - 幂等性: 幂等(重复调用以最后一次为准,upsert 语义)
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 用户登录 token |
Body 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| bgURL | 否 | string | 朋友圈背景图 URL;传空字符串表示清除背景图 |
字段说明
- API 层会在转发前把当前登录用户的
userID注入请求体,客户端无需传入。 - 只能修改自己的设置,无法通过此接口修改他人设置。
- 底层使用 upsert,首次调用自动创建记录。
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | object | 业务数据,固定为空对象 {} |
5. 业务规则
- 路由统一要求
token,API 层从 token 解析当前用户身份写入userID。 - 本接口仅作用于当前登录用户,服务端不允许指定任意
userID。 - 设置记录存储在
moments_user_settings集合,以userID为唯一键 upsert。 updateTime由服务端自动写入,客户端无需关注。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1001 | Header 缺少 operationID | header must have operationID |
| 1001 | Header 缺少 token | token is empty |
| - | 写入数据库失败 | 由数据库层返回 |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10010/chatx/moments/settings/update", {
method: "POST",
headers: {
operationID: "moments-settings-update-001",
token: "user-token",
"Content-Type": "application/json",
},
body: JSON.stringify({
bgURL: "https://cdn.example.com/bg/my-background.jpg",
}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{
"bgURL": "https://cdn.example.com/bg/my-background.jpg"
}响应示例(成功)
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {}
}