Skip to main content

End room

Endpoint: /room/endRoom

This endpoint allows you to forcefully terminate a live room session. When you call this API with a room_id, the session is immediately closed, and all participants are disconnected.

This is a server-side administrative action, typically used to moderate sessions or to ensure that a meeting has definitively concluded. For example, you might integrate this into a "End Meeting for All" button in your application's administrative dashboard. Once a room is ended, its data is cleared, and it can be recreated for a new session.

FieldTypePositionRequiredDescription
room_idstringrootYesRoom Id

Example:

{
"room_id": "room01"
}

Response

FieldTypePositionDescription
statusbooleanrootThe status of the request
msgstringrootResponse message
status_codestringrootResponse status code.