Skip to main content

Set User-Level Push Aliases

Set the display name of the sender in push notifications for specified recipient users. You can set up to 100 ​aliases at a time.

By default, push notifications sent by the IM service will carry the username provided when the sender registered (/user/register.json) or updated their user information (/user/refresh.json). In social scenarios where the recipient and sender are friends, the recipient may prefer to see a personalized name (e.g., a friend's ​alias) for the sender in push notifications. The ​Set User-Level Push Aliases feature allows you to configure the personalized names set by the recipient for other users into the IM push service. Once configured, the push notifications will display the custom ​aliases.

Request Method​

POST: https://data center domain/user/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:

ParameterTypeRequiredDescription
userIdStringYesThe user ID.
remarksStringYesThe JSON string of the target user's push alias. See remarks structure.

  • remarks Structure:

    remarks ParameterTypeRequiredDescription
    idStringYesThe target user ID. Up to 100 can be set at once.
    remarkStringYesThe alias displayed when receiving push from the target user.

Request Example​

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"}]

Response​

The HTTP response body contains a JSON object with the following structure:

Return ValueTypeDescription
codeNumberThe return code, 200 for success.

Response Example​

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

{"code":200}
Last updated on