Synchronize User's Group Membership
Synchronize all groups that a specified user has joined with the IM server to prevent inconsistencies between the user's group information in the application and the user's group information on the IM server.
If there is existing group data on the App Server before integrating the IM service, you can use this interface to synchronize the existing user-group relationships with the IM server when connecting to the IM service for the first time.
Request Method
POST: https://data center domain/group/sync.json
Rate Limit: 100 requests per second
Signature Rule: All server API requests require signature validation. For details, see API Request Signature.
Body Parameters
The HTTP request body data format is application/x-www-form-urlencoded, and the following HTTP form parameters are supported:
| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | String | Yes | The ID of the user whose group information is being synchronized. |
| group[id]=name | String | No | The group information the user belongs to. If the group ID already exists, the corresponding group name will also be updated. This parameter can be passed multiple times. See the example below. |
When the group[id]=name parameter is not submitted, it means that the binding relationship of the userId with the corresponding group is removed.
Request Example
POST /group/sync.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
userId=2014&group[10001]=TestGroup1&group[10002]=TestGroup2&group[10003]=TestGroup3
Response
The HTTP response body contains a JSON object with the following structure:
| Return Value | Type | Description |
|---|---|---|
| code | Int | Return code, 200 indicates success. |
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}