跳到主要内容

设置用户级推送备注名

为指定接收者用户设置推送通知中发送者的显示名称，单次可设置最多 100 个备注名。

默认情况下，即时通讯服务端发送的推送通知会携带发送者注册用户（/user/register.json）或修改用户信息（/user/refresh.json）时传入的用户名。在社交等场景下，假设接收者与发送者互为好友，接收者可能希望在推送通知中将发送者名称显示为个性化名称（如好友昵称）。通过设置用户级推送备注名功能，可以将接收者用户为其他用户设置的个性化名称配置到即时通讯的推送服务中。配置成功后，推送通知中将显示自定义的推送备注名。

请求方法​

POST： https://数据中心域名/user/remarks/set.json

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

频率限制： 每秒钟限 100 次

正文参数​

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

参数类型必传说明
userIdString是用户 ID。
remarksString是设置的目标用户推送备注名 JSON 字符串。详见 remarks 结构说明。

  • remarks 结构说明：

    remarks 参数类型必传说明
    idString是目标用户 ID。单次最多设置 100 个。
    remarkString是收到目标用户推送时显示的备注名。

请求示例​

POST /user/remarks/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=uid1&remarks=[{"id":"user11","remark":"remark1"},{"id":"user12","remark":"remark2"}]

返回结果​

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

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

返回结果示例​

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

{"code":200}
最后于 更新