Dismiss a Group
Dismissing a group means that all users will no longer receive messages from that group.
Impact on Local Historical Message Records:
- After the group is dismissed, clients can still view the group's historical messages that have been saved locally.
Impact on Remote Historical Message Records (Only applicable if the Cloud Storage for One-to-One and Group Messages service is enabled):
- Dismissing a group does not delete the group's historical messages on the server. If you need to clear them, you can use the IM service's API to delete messages.
- Once the group relationship is dismissed, the App client no longer has the right to pull the group's historical messages from the cloud storage service.
If the historical messages in the Cloud Storage for One-to-One and Group Messages service are not cleared, as long as a group with the same ID is created, the client can still pull the previous historical messages.
Basic Process for Dismissing a Group:
- The user performs the group dismissal operation in the App and initiates a group dismissal request to the App server.
- The App backend calls the IM service's API to dismiss the group.
Sequence Diagram for Dismissing a Group:
Request Method
POST: https://Data Center Domain/group/dismiss.json
Rate Limit: 100 requests per second
Signature Rule: All server API requests require signature verification. For details, see API Request Signature.
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 operator dismissing the group. It can be any user ID; the group creator is not required to dismiss the group. |
| groupId | String | Yes | The group ID of the group to be dismissed. |
Request Example
POST /group/dismiss.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&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
- Calling the group dismissal API does not automatically send a notification message to the SDK. If you wish to notify users about the group dismissal, you can send a system message.