跳到主要内容

设置好友自定义属性

设置好友自定义属性。

开通服务

调用此接口前,您须在控制台开通信息托管服务。

请求方法

POST: https://数据中心域名/friend/profile/set.json

频率限制: 每秒钟限 100 次

签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名

正文参数

HTTP 请求正文数据格式为 application/x-www-form-urlencoded,支持以下 HTTP 表单参数:

参数类型必传说明
userIdString操作用户id
targetIdString目标好友id
remarkNameString好友备注名,最多为64字符; 不传则将备注名清空
friendExtProfileString自定义属性:开发者可根据自身业务需求添加自定义扩展属性(Key、Value), 默认最多可设置 10 个扩展信息。key限制 32 个字符, 大小写+数字 + '_', 格式固定 ext_xxxxx; value限制256字符; 示例:{"ext_key1":"value1","ext_key2":"value2"}

请求示例

POST /friend/profile/set.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=id1&targetId=id2&remarkName=zhangsan&friendExtProfile={\"ext_key1\":\"value1\",\"ext_key2\":\"value2\"}

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

返回值返回类型说明
codeNumber返回码,200 为正常。

返回结果示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"code": 200,
}