logo
In-app Chat
ZIMAudio
On this page

DestroyRoom

GET

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

By calling this API, developers can destroy a room.

The client will receive a notification that the room has been destroyed through the following ZIM SDK callback:

iOSAndroidmacOSWindows
roomStateChangedonRoomStateChangedroomStateChangedonRoomStateChanged
WebMini ProgramFlutterReact Native
roomStateChangedroomStateChangedonRoomStateChangedOnRoomStateChanged
Unity3Duni-app | uni-app xHarmonyOS
OnRoomStateChangedroomStateChangedroomStateChanged
Note
The parameter RoomId only supports numbers, English characters, and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', ' ', ',', '{', '}'.
QPS Limit
20 times/s

Request

Query Parameters

    Action stringrequired

    Possible values: [DestroyRoom]

    API prototype parameter

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

    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.

    RoomId stringrequired

    Possible values: <= 32 characters

    Room ID.

Responses

OK
Schema
    Code integer

    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 codeDescription
    660300001Room does not exist.
    Message string

    Description of the request result.

    RequestId string

    Request ID.

Previous

Update room attributes

Next

Obtain information about users in a room

On this page

Back to top