Documentation
In-app Chat
Server APIs
Group related
Disband a group chat

Disband a group chat

Last updated：2024-04-12 15:12

Overview

You can call this operation to disband a group chat.

After a group chat is successfully disbanded, all group members receive the disbandment notification in the following ZIM SDK callbacks.

iOS	Android	macOS	Windows	Web
groupStateChanged	onGroupStateChanged	groupStateChanged	onGroupStateChanged	groupStateChanged
Flutter	Unity3D	React Native
onGroupStateChanged	OnGroupStateChanged	groupStateChanged

Operation prototype

Request method: GET
Request URL: https://zim-api.zego.im/?Action=DismissGroup
Protocol: HTTPS
QPS limit: 1 call per second, applicable to group chats only. If you need a higher limit, contact ZEGOCLOUD technical support.

Request parameters

The following table describes only the operation-specific request parameters and some common request parameters. For the complete list of common request parameters, see the Public request parameters section of the Accessing Server APIs topic.

Parameter	Type	Required	Description
FromUserId	String	Yes	The ID of the operator. The operator can be any user and does not need to be in the group chat or be the group owner.
GroupId	String	Yes	The group chat ID.

The FromUserId and GroupID parameters can contain only digits, letters, and the following characters: '!', '#', '$', '%', '&', '(', ')', '+', '', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.

Sample request

https://zim-api.zego.im/?Action=DismissGroup
&FromUserId=zego_user&GroupId=groupid
&<Common request parameters>

Response parameters

Parameter	Type	Description
Code	Number	The return code.
Message	String	The description of the operation result.
RequestId	String	The request ID.

Sample response

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
}

Return codes

The following table describes only the return codes related to the business logic of the operation. For the complete list of return codes, see Return codes.

Return Code	Description	Solution
660000002	Invalid parameter.	Check the input parameter.
660300006	The QPS limit is exceeded.	Please try again later, or check the QPS limit.
660500002	The operator is not registered.	Register the operator.
660600001	The group chat does not exist.	Check whether the value of the `GroupID` parameter is valid.

ZEGO UIKits

Cloud Communications Products

Low-Code Products

AIGC

Supporting Services