기능 및 서버 인터페이스
  • 클라우드 녹화
  • CDN로 전환
  • TRTC를 통한 RTMP 통합
  • 이벤트 콜백
    • 이벤트 콜백
    • CDN으로 릴레이 콜백
    • 클라우드 레코딩 콜백
    • 서명 확인 예시
  • 메시지 보내기 및 받기
  • 접근 관리
    • 개요
    • 인가 가능한 자원 및 작업
    • 사전 설정 정책
    • 사용자 정의 정책
  • 고급 권한 제어 활성화
  • OBS WHIP를 통한 TRTC 룸으로의 푸시 방법
  • 서버 API
    • 인터페이스 분류
    • 과거 기록
    • 인터페이스 요청 보내기
      • 요청 구조
      • 범용 매개변수
      • 서명 방법 v3
      • 서명
      • 회신
    • 룸 관리 인터페이스
      • SetUserBlockedByStrRoomId
      • SetUserBlocked
      • RemoveUser
      • DismissRoom
      • RemoveUserByStrRoomId
      • DismissRoomByStrRoomId
    • 통화 품질 모티터링 인터페이스
      • DescribeRoomInfo
      • DescribeUserEvent
      • DescribeCallDetailInfo
      • DescribeUserInfo
      • DescribeScaleInfo
    • 푸시 풀링 관련 인터페이스
      • StartStreamIngest
      • StopStreamIngest
      • DescribeStreamIngest
    • 클라우드 레코딩 인터페이스
      • CreateCloudRecording
      • DescribeCloudRecording
      • ModifyCloudRecording
      • DeleteCloudRecording
    • 혼합 스트림 릴레이 관련 인터페이스
      • UpdatePublishCdnStream
      • StartPublishCdnStream
      • StopPublishCdnStream
    • 사용량 통계 관련 인터페이스
      • DescribeTrtcUsage
      • DescribeRecordingUsage
      • DescribeMixTranscodingUsage
      • DescribeRelayUsage
      • DescribeTrtcRoomUsage
    • 데이터 유형
    • 에러코드
    • 부록
      • 이벤트 ID 매핑표
이 페이지는 현재 영어로만 제공되며 한국어 버전은 곧 제공될 예정입니다. 기다려 주셔서 감사드립니다.

DismissRoomByStrRoomId

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DismissRoomByStrRoomId.
VersionYesStringCommon Params. The value used for this API: 2019-07-22.
RegionYesStringCommon Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-guangzhou, ap-singapore.
SdkAppIdYesIntegerSDKAppId of TRTC
RoomIdYesStringRoom ID

3. Output Parameters

Parameter NameTypeDescription
RequestIdStringThe 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.

4. Example

Example1 Closing a room

This example shows you how to close room abcd.

Input Example

https://trtc.tencentcloudapi.com/?Action=DismissRoomByStrRoomId
&SdkAppId=1400000001
&RoomId=abcd
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error CodeDescription
FailedOperation.RoomNotExistThe room does not exist.
InternalErrorInternal error.
InternalError.GetRoomCacheIpErrorFailed to query the room.
InvalidParameter.RoomIdRoomId is incorrect.
InvalidParameter.SdkAppIdSdkAppId is incorrect.
InvalidParameterValue.RoomIdInvalid RoomId.
MissingParameter.RoomIdRoomId is missing.
MissingParameter.SdkAppIdSdkAppId is missing.
UnauthorizedOperation.SdkAppIdNo permission to manipulate SdkAppId.