Destroy a room

Description

By this API, you can destroy a room.

The client will receive the notification through the following callbacks when the room is destroyed.

Platform	Callback
iOS/macOS	zim:roomStateChanged:event:extendedData:
Android	onRoomStateChanged
Windows	onRoomStateChanged
Web	roomStateChanged

Request method and endpoint

Request method: GET
Request URL: https://zim-api.zego.im/?Action=DestroyRoom
Transmission protocol: HTTPS
QPS limit: 20 requests/second

Request parameters

Listed below are the parameters specific to this request and part of the common request parameters. For the complete list of common request parameters, see Accessing Server APIs - Common parameters.

Parameter	Type	Required	Description
RoomId	String	Yes	Room ID.

Note

The RoomId can only contain numbers, letters, and the following special characters: !#$%&()+-:;<=.>?@[]^_{}|~.

Sample request

Untitled

https://zim-api.zego.im/?Action=DestroyRoom
&RoomId=123
&<Common parameters>

Copied!

Response parameters

Parameter	Type	Description
Code	Number	Return code.
Message	String	Description of the request execution result.
RequestId	String	Request ID.

Sample response

Untitled

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

Copied!

Return codes

Listed below are the return codes related to this API. For the complete list of return codes, see Return codes.

return code	Description
660300001	The room does not exist.