Appearance
更新用户信息
通过用户 ID、OpenID、UnionID 或第三方系统唯一标识定位用户,并更新用户昵称或头像。系统会校验用户是否属于当前 API 授权账号。
请求路径
- 请求方式:
POST - 请求头:
Content-Type:application/json - 接口地址:
https://gateway.nuoyunapi.com/Api/User/updateExternalUserInfo/2.0.0 - 频率限制:
10秒1000次
请求参数
| 参数 | 必选 | 类型 | 描述 |
|---|---|---|---|
| wechat_user_space_id | 条件必选 | integer | 用户 ID;与 openid、unionid、uuid 必须且只能提交一个,值必须大于 0 |
| openid | 条件必选 | string | 微信 OpenID;与其他用户标识必须且只能提交一个 |
| unionid | 条件必选 | string | 微信 UnionID;与其他用户标识必须且只能提交一个 |
| uuid | 条件必选 | string | 第三方系统唯一标识;与其他用户标识必须且只能提交一个 |
| nickname | 条件必选 | string | 新昵称;与 photo 至少提交一项,不支持更新为空字符串 |
| photo | 条件必选 | string | 新头像 URL;与 nickname 至少提交一项,不支持更新为空字符串 |
用户标识必须且只能提交一个。
nickname和photo可以同时提交,也可以只提交其中一项。
请求示例
按用户 ID 更新昵称和头像:
json
{
"wechat_user_space_id": 10001,
"nickname": "用户昵称",
"photo": "https://cdn.example.com/avatar/user_10001.png"
}按第三方系统唯一标识更新昵称:
json
{
"uuid": "third_user_10001",
"nickname": "用户昵称"
}使用 OpenID 或 UnionID 时,将上述示例中的用户标识替换为对应字段,并且不要同时提交其他用户标识。
响应参数
| 参数 | 必选 | 类型 | 描述 |
|---|---|---|---|
| code | 是 | integer | 状态码:200 表示成功,400 表示请求失败 |
| msg | 是 | string | 提示信息 |
| data | 是 | object | 响应数据 |
data 参数结构
| 参数 | 必选 | 类型 | 描述 |
|---|---|---|---|
| wechat_user_space_id | 是 | integer | 实际更新的用户 ID |
响应示例
json
{
"code": 200,
"data": {
"wechat_user_space_id": 10001
},
"msg": "Success"
}常见失败提示
| 提示信息 | 说明 |
|---|---|
| 用户ID必须大于0 | 提交的用户 ID 小于或等于 0 |
| 用户标识必须且只能提交一个 | 未提交用户标识,或同时提交了多个用户标识 |
| 昵称和头像至少提交一个 | nickname 和 photo 均未提交或均为空字符串 |
| 用户不存在或不属于当前账号 | 未找到用户,或用户不属于当前 API 授权账号 |