修改用户信息
修改在即时通讯服务端保存的用户名称(name
)和 头像(portraitUri
)数据。
注意事项
重要
- 即时通讯服务端保存的用户名称(
name
)和 头像(portraitUri
)数据仅用于推送服务。name
字段在移动客户端推送通知中作为默认显示的用户名称。因为即时通讯服务端不提供用户信息托管服务,所以客户端 SDK 不提供主动获取该用户名称数据的方法。- 刷新用户信息后
name
字段和portraitUri
字段实时生效,Push 推送时将显示刷新后的用户名称。- App 中展示的用户昵称、头像数据需要您自行实现。如果客户端使用 IMKit SDK,可使用「用户信息提供者」类将 App 层的数据提供给 SDK,用于展示。
请求方法
POST: https://数据中心域名/user/refresh.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 用户 ID,支持大小写英文字母与数字的组合,最大长度 64 字节。 userId 是用户在 App 中的唯一标识,必须保证在同一个 App 内不重复,重复的用户 ID 将被当作是同一用户。 |
name | String | 否 | 用户名称,最大长度 64 个字符(不区分符号、英文字符、中文字符,统一限制最多 64 个字符)。用来在 Push 推送时,显示用户的名称,不提供则不进行刷新。 |
portraitUri | String | 否 | 用户头像 URI,最大长度 1024 字节。注意:因为即时通讯服务端不提供用户信息托管服务,所以不支持客户端 SDK 主动获取该用户头像数据。 |
请求示例
POST /user/refresh.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
userId=jlk456j5&name=newname&portraitUri=http%3A%2F%2Fabc.com%2Fmynewportrait.jpg
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 为正常。 |
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}