Domain name for API request: trtc.tencentcloudapi.com.
This API is used to remove all users from a room and close the room. It works on all platforms. For Android, iOS, Windows, and macOS, you need to update the TRTC SDK to version 6.6 or above.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DismissRoomByStrRoomId. |
Version | Yes | String | Common Params. The value used for this API: 2019-07-22. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-guangzhou, ap-singapore. |
SdkAppId | Yes | Integer | SDKAppId of TRTC |
RoomId | Yes | String | Room ID |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to close room abcd
.
https://trtc.tencentcloudapi.com/?Action=DismissRoomByStrRoomId
&SdkAppId=1400000001
&RoomId=abcd
&<Common request parameters>
{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.RoomNotExist | The room does not exist. |
InternalError | Internal error. |
InternalError.GetRoomCacheIpError | Failed to query the room. |
InvalidParameter.RoomId | RoomId is incorrect. |
InvalidParameter.SdkAppId | SdkAppId is incorrect. |
InvalidParameterValue.RoomId | Invalid RoomId. |
MissingParameter.RoomId | RoomId is missing. |
MissingParameter.SdkAppId | SdkAppId is missing. |
UnauthorizedOperation.SdkAppId | No permission to manipulate SdkAppId . |
本页内容是否解决了您的问题?