Leave a Group
Remove a user from a group so that they no longer receive messages from that group.
Basic Process:
- The user initiates the leave group operation in the app, and this operation request is sent to the app server.
- The app server calls the IM service's server API to remove the user from the group. After removal, the user will no longer receive messages from that group.
Sequence Diagram for Leaving a Group
Request Method
POST: https://Data Center Domain/group/quit.json
Rate Limit: 100 requests per second
Signature Rule: All server API requests must be validated according to the rules. See API Request Signature for details.
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 | The user ID(s) to be removed from the group. Multiple user IDs can be submitted, with a maximum of 1000. |
| groupId | String | Yes | The group ID from which the user(s) will be removed. |
Request Example
POST /group/quit.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=1&userId=2&groupId=123
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
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}
Frequently Asked Questions
-
The IM service does not maintain basic group information (avatar, name, group member profiles, etc.). This must be managed by the developer's app server.
-
Calling the leave group API does not automatically send a notification message to the SDK. If you wish to notify the user about leaving the group, you can send a system message for notification.