Update User Information

Update the user name (name) and avatar (portraitUri) data stored on the IM service server.

Important Notes

Important

• The user name (name) and avatar (portraitUri) data stored on the IM service server are only used for push notifications. The name field is displayed as the default user name in mobile client push notifications. Note: User profile information modified via the /user/refresh.json interface will not be automatically synchronized to the User Profile Hosting service. If you are using RC's User Profile Hosting service, please use the Set User Profile interface (/user/profile/set.json) to update user information.
• The name and portraitUri fields take effect immediately after refreshing user information. The updated user name will be displayed in Push notifications.
• The user nickname and avatar data displayed in the App need to be implemented by you.

Request Method

POST: https://Data Center Domain/user/refresh.json

Rate Limit: 100 requests per second

Signature Rule: All server API requests require signature verification. For details, see API Request Signature.

Request 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	User ID, supports a combination of uppercase and lowercase letters and numbers, with a maximum length of 64 bytes. userId is the unique identifier of the user within the App and must be ensured to be unique within the same App. Duplicate user IDs will be treated as the same user.
name	String	No	User name, with a maximum length of 64 characters (regardless of symbols, English characters, or Chinese characters, the maximum is uniformly limited to 64 characters). Used to display the user's name in Push notifications. If not provided, no refresh will be performed.
portraitUri	String	No	User avatar URI, with a maximum length of 1024 bytes. Note: Since the IM service server does not provide User Profile Hosting, the client SDK cannot actively retrieve this user avatar data.

Request Example

POST /user/refresh.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=jlk456j5&name=newname&portraitUri=http%3A%2F%2Fabc.com%2Fmynewportrait.jpg

Response

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

Return Value	Type	Description
code	Number	Return code, 200 indicates success.

Response Example

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

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

{"code":200}