logo
In-app Chat
ZIMAudio
On this page

DismissGroup

GET

https://zim-api.zego.im/

By calling this API, you can disband a group.

After successfully disbanding the group, all group members will receive the following ZIM callback notification:

iOSAndroidmacOSWindows
groupStateChangedonGroupStateChangedgroupStateChangedonGroupStateChanged
WebMini ProgramFlutterReact Native
groupStateChangedgroupStateChangedonGroupStateChangedgroupStateChanged
Unity3Duni-app | uni-app xHarmonyOS
OnGroupStateChangedgroupStateChangedgroupStateChanged
Note
The parameters FromUserId and GroupID only support numbers, English characters, and '!','#','$','%','&','(',')','+','\'',':',';','<','=','.','>','?', '@','[',']','^','_','{','}','|','~'.
QPS Limit
1 time/s, group-level limit. If you need to adjust this limit, please contact ZEGOCLOUD Technical Support.

Request

Query Parameters

    Action stringrequired

    Possible values: [DismissGroup]

    API prototype parameter

    https://zim-api.zego.im/?Action=DismissGroup

    AppId uint32required

    💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.

    SignatureNonce stringrequired

    💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.

    Timestamp int64required

    💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡Public parameter. Signature version number.

    Signature stringrequired

    💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.

    FromUserId stringrequired

    Possible values: <= 32 characters

    Operator user ID (who has logged in to the ZIM service by calling the login method on the client, or has completed registration by calling the server-side API). Can be any user, does not need to be in the group, and does not need to be the group owner.

    GroupId stringrequired

    Possible values: <= 32 characters

    Group ID.

Responses

OK
Schema
    Code number

    Return code.

    The following only lists the return codes related to the API business logic. For the complete return codes, please refer to Return codes.

    Return codeDescriptionSuggested Solution
    660000002Input parameter error.Please check the input parameters.
    660300006Frequency limit.Please try again later or learn about the relevant frequency limits.
    660500002Operator user is not registered.Please have the operator register with the ZIM service first.
    660600001Group does not exist.Please confirm if the input GroupID is correct.
    Message string

    Description of the operation result.

    RequestId string

    Request ID.

Previous

Fetch the list of groups that are muted in the app

Next

Send a one-to-one message

On this page

Back to top