Set Group Member Push Alias
Set the display name of the sender in group message push notifications.
By default, the push notifications sent by the IM service for group messages will carry the username provided during user registration (/user/register.json) or user information update (/user/refresh.json).
In social scenarios, you might want the sender's name in group message push notifications to display as their nickname or a personalized name within the group. By using the Set Group Member Push Alias feature, you can configure a personalized name (push alias) for a specific user (userId) in a specific group (groupId) in the IM push service.
Once configured, other group members will see the sender's name as the group member push alias in the push notifications.
If the recipient of the push notification has already set a User Push Alias for the sender, the User Push Alias will take precedence in the group message push notification. For more details, see Set User Push Alias.
Request Method
POST: https://Data Center Domain/group/remarks/set.json
Signature Rule: All server API requests require signature verification. For details, see API Request Signature.
Rate Limit: 100 requests per second
Body Parameters
The HTTP request body data format is application/x-www-form-urlencoded, and it supports the following HTTP form parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | String | Yes | The user ID of the group member. |
| groupId | String | Yes | The group ID. |
| remark | String | Yes | The push alias for the group member. |
Request Example
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=备注
Response
The HTTP response body contains a JSON object with the following structure:
| Return Value | Return Type | Description |
|---|---|---|
| code | Number | The return code, 200 indicates success. |
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}