End a room | RelayRTC Docs

Requirements

A secret API key with rooms:end. Resources are restricted to the key's project and environment.

Path parameters

Name	Type	Required / default	Description
roomId	string	Required	ID of a room in the key's environment.

Example

Set RELAYRTC_API_URL to your API base including /v1, such as http://localhost:8082/v1.

curl -X DELETE "$RELAYRTC_API_URL/rooms/room_example" \
  -H "Authorization: Bearer $RELAYRTC_SECRET_KEY"

Response

204 when cleanup is complete, with no body. 202 when cleanup remains pending, with a runtime operation.

{
  "id": "operation_example",
  "kind": "room.end",
  "status": "pending",
  "attempts": 0,
  "lastError": null,
  "completedAt": null
}

Notes

This ends the call for everyone

Ending a room disconnects its participants and removes its live media resources. To leave only one browser participant, use the browser SDK’s leave method.

Poll the room runtime operation when the response is 202.

Errors

Invalid fields return 400. Invalid credentials return 401; a missing scope returns 403. A missing resource returns 404. See error responses.