更新昵称和头像
更新时间： 2024/11/04 15:22:15
本文介绍如何对 NERoom 账号进行修改昵称和修改头像。
接口请求地址
- 请求方法：PUT
- URL：https://roomkit.netease.im/apps/{appKey}/v1/users/{userUuid}/update
- Content-Type：application/json
前提条件
请求参数
- PUT 请求中 Header 的设置请参见调用方式中的请求结构。
- PUT 请求中 Url和Body 的设置如下：
| 参数名称 | 类型 | 是否必选 | 示例 | 描述 |
|---|---|---|---|---|
| appKey | String | 必选 | 46499***09cce5 | 网易云信控制台为应用分配的 App Key。 |
| userUuid | String | 必选 | user01 | 用户账号（建议设置为 imAccid对应的值），必须保证唯一性。由小写英文、数字、下划线(_)、@、英文句号（.）和短横线（-）组成，最大长度32个字符。 |
| userName | String | 可选 | 用户01 | 更新后的用户昵称。最大长度64个字符。如果不设置，则默认设置为 userUuid 的值。 |
| icon | String | 可选 | https://tupian.jpg | 更新后的用户头像的图片 URL。URL 地址的最大长度为 1000 个字符。 |
返回结果
| 参数名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| code | int | 0 | 状态码，0表示成功，具体请参见错误码。 |
| msg | String | Operation succeeded. | 业务结果描述 |
| ts | Long | 1648021056815 | NERoom 服务器处理该请求的完成时间。 该时间为 Unix 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数。 |
| requestId | String | 7c4b***e3a4d995 | 请求的唯一标识。 |
| cost | String | 48ms | 处理该请求所消耗的时间。 |
| data | Object | - | 具体数据。 |
| data.userUuid | String | user_uuid_00001 | 用户账号。 |
| data.userToken | String | 0ZNLD4***2N251D1 | 用户的 Token。 |
| data.imToken | String | 0ZNLD4***2N251D1 | IM 的 Token。 |
| data.userName | String | 用户01 | 用户昵称。如果没有设置参数，则不会返回。 |
| data.icon | String | https://tupian.jpg | 用户的头像。如果没有设置参数，则不会返回。 |
| data.imKey | String | 46499***09cce5 | IM 的 App Key。 |
| data.rtcKey | String | 46499***09cce5 | RTC 的 App Key。 |
示例
请求示例
PUT https://roomkit.netease.im/apps/46499***09cce5/v1/users/user_uuid_00001/update
json{
"userName":"我是昵称1",
"icon":"https://tupian.jpg"
}
返回示例
json{
"code": 0,
"msg": "Operation succeeded.",
"ts": 1657079917019,
"cost": "146ms",
"requestId": "prod_8e04a8ed7879***b6a30557279a1b",
"data": {
"userUuid": "user_uuid_00001",
"userToken": "0ZNLD4***2N251D1",
"imToken": "0ZNLD4***2N251D1",
"userName":"我是昵称1",
"icon":"https://tupian.jpg",
"imKey": "46499***09cce5",
"rtcKey": "46499***09cce5"
}
}
此文档是否对你有帮助？
