Help Center/ SparkRTC/ API Reference/ Examples/ Room management/ Dismisses a room.

Updated on 2022-10-08 GMT+08:00

View PDF

Dismisses a room.

Dismisses a room and removes all users from the room.

POST /v2/apps/{app_id}/rooms/{room_id}/dismiss

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
app_id	Yes	String	Application ID
room_id	Yes	String	Room ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Content type.
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory for AK/SK authentication.
X-Project-Id	No	String	Project ID. This parameter is mandatory when AK/SK-based authentication is used.

Status code: 202

**Table 3** Response header parameters
Parameter	Type	Description
X-request-Id	String	Request ID for task tracing.

Status code: 400

**Table 4** Response header parameters
Parameter	Type	Description
X-request-Id	String	Request ID for task tracing.

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Description.

Status code: 404

**Table 6** Response header parameters
Parameter	Type	Description
X-request-Id	String	Request ID for task tracing.

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Description.

Status code: 500

**Table 8** Response header parameters
Parameter	Type	Description
X-request-Id	String	Request ID for task tracing.

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Description.

POST https://{endpoint}/v2/apps/{app_id}/rooms/{room_id}/dismiss

Status code: 400

The request cannot be understood by the server or parameters are incorrect.

{
  "error_code" : "RTC.00001003",
  "error_msg" : "InvalidParameterValue"
}

Status code: 404

The corresponding room cannot be found.

{
  "error_code" : "RTC.00001003",
  "error_msg" : "InvalidParameterValue"
}

Status code: 500

Request failed due to server error.

{
  "error_code" : "RTC.00002xxx",
  "error_msg" : "InternalError"
}

Status Code	Description
202	The room dismissal request has been delivered.
400	The request cannot be understood by the server or parameters are incorrect.
404	The corresponding room cannot be found.
500	Request failed due to server error.