更新时间: 2021-03-08
# 功能描述
当用户昵称和头像变更时,App Server 需要调用此接口刷新在融云侧保存的用户信息,以便融云发送推送消息的时候,能够使用正确的用户信息发送。
# 实现方法
# 功能接口
请求地址: https://数据中心域名/user/refresh.json
请求方法: POST
调用频率: 无限制
签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详细请参考 通用 API 接口签名规则
# 参数说明
输入参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 用户 Id,支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式,最大长度 64 字节。是用户在 App 中的唯一标识,必须保证在同一个 App 内不重复,重复的用户 Id 将被当作是同一用户。 |
name | String | 否 | 用户名称,最大长度 128 字节。用来在 Push 推送时,显示用户的名称,刷新用户名称后 5 分钟内生效,不提供则不进行刷新。 |
portraitUri | String | 否 | 用户头像 URI,最大长度 1024 字节。用来在 Push 推送时显示,不提供则不进行刷新。 |
返回结果:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Int | 返回码,200 为正常。 |
# 代码示例
Request:
POST /user/refresh.json HTTP/1.1 Host: api-cn.ronghub.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
已复制
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Response:
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 {"code":200}
已复制
1
2
3
4
2
3
4
# 注意事项
此功能不会更新客户端的用户信息,在客户端 Android 应该使用 UserInfoProvider / iOS 应该使用 UserInfoDataSource 来提供用户信息。
刷新用户信息后 5 分钟内生效,Push 推送时将显示刷新后的用户名称。