跳到主要内容

设置群成员推送备注名

设置群消息推送通知中发送者的显示名称。

默认情况下，即时通讯服务端为群消息发送的推送通知会携带发送者注册用户（/user/register.json）或修改用户信息（/user/refresh.json）传入的用户名。

在社交等场景下，可能希望在群消息的推送通知中将发送者名称显示为群组内的昵称或其他个性化名称。通过设置指定群成员推送备注功能，可以在即时通讯的推送服务中设置指定用户（userId）在指定群组（groupId）的群消息推送通知中显示的个性化名称（推送备注名）。

配置成功后，其他群成员在收到该用户的推送通知时，发送者名称显示为发送者的群成员推送备注名。

提示

如果推送通知的接收者已为发送者用户设置了用户推送备注名，则群消息推送通知中会优先使用用户推送备注名。详见设置用户推送备注名。

请求方法​

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

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

频率限制： 每秒钟限 100 次。该接口支持调整频率（可调频），可在控制台 > IM 服务 > 服务购买 > 调频服务中调整。

正文参数​

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

参数类型必传说明
userIdString是群成员用户 ID。
groupIdString是群 ID。
remarkString是群成员推送备注。

请求示例​

HTTP
POST /group/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=a&groupId=123&remark=备注

返回结果​

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

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

返回结果示例​

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

{"code":200}