Release Notes and Announcements

Release Notes

Recent Product Announcement

TRTC Live (TUILiveKit) Product Launch Announcement

TRTC Conference Official Editions Launched

The commercial version of Conference is coming soon

Terms and Conditions Applicable to $9.9 Starter Package

Rules for the "First Subscription $100 Discount" Promotion

Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference

TRTC Call Official Editions Launched

License Required for Video Playback in New Version of LiteAV SDK

TRTC to Offer Monthly Packages

Product Introduction

Overview

Concepts

Features

Strengths

Use Cases

Performance Statistics

Tencent RTC Quickplay: Experience Ultimate Real-Time Audio and Video Interaction!

Purchase Guide

Billing Overview

Free Minutes

Monthly subscription

Pay-as-you-go

TRTC Overdue and Suspension Policy

FAQs

Refund Instructions

User Tutorial

Free Demo

Call

Overview

Activate the Service

Run Demo

Integration

Offline Call Push

Conversational Chat

On-Cloud Recording

AI Noise Reduction

UI Customization

Calls integration to Chat

Additional Features

No UI Integration

Server APIs

Client APIs

Solution

ErrorCode

Release Notes

FAQs

Conference

Overview（TUIRoomKit）

Activate the Service (TUIRoomKit)

Run Demo（TUIRoomKit）

Integration（TUIRoomKit）

Screen Sharing (TUIRoomKit)

Schedule a meeting (TUIRoomKit)

In-meeting Call (TUIRoomKit)

UI Customization（TUIRoomKit）

Virtual Background (TUIRoomKit)

Conference Control (TUIRoomKit)

Cloud Recording (TUIRoomKit)

AI Noise Reduction (TUIRoomKit)

In-Conference Chat (TUIRoomKit)

Robot Streaming (TUIRoomKit)

Enhanced Features (TUIRoomKit)

Client APIs (TUIRoomKit)

Server APIs (TUIRoomKit)

FAQs (TUIRoomKit)

Error Code (TUIRoomKit)

SDK Update Log (TUIRoomKit)

Live

Billing of Video Live Component

Overview

Activating the Service (TUILiveKit)

Run Demo

No UI Integration

UI Customization

Live Broadcast Monitoring

Video Live Streaming

Voice Chat Room

Advanced Features

Client APIs

Server APIs

Error Codes

Release Notes

FAQs

RTC Engine

Activate Service

SDK Download

API Examples

Usage Guidelines

API Reference Manual

Advanced Features

AI Integration

Overview

Configure MCP Server

Install Skills

Integration Guide

FAQ

RTC RESTFUL API

History

Introduction

API Category

Room Management APIs

Stream mixing and relay APIs

On-cloud recording APIs

Data Monitoring APIs

Pull stream Relay Related interface

Web Record APIs

AI Service APIs

Cloud Slicing APIs

Cloud Moderation APIs

Making API Requests

Call Quality Monitoring APIs

Usage Statistics APIs

Data Types

Appendix

Error Codes

Console Guide

Application Management

Package Management

Usage Statistics

Monitoring Dashboard

Development Assistance

Solution

Real-Time Chorus

FAQs

Migration Guide

Billing

Features

UserSig

Firewall Restrictions

How to Downsize Installation Package

Android and iOS

Web

Flutter

Electron

TRTCCalling for Web

Audio and Video Quality

Others

Legacy Documentation

RTC RoomEngine SDK（Old）

Integrating TUIRoom (Web)

Integrating TUIRoom (Android)

Integrating TUIRoom (iOS)

Integrating TUIRoom (Flutter)

Integrating TUIRoom (Electron)

TUIRoom APIs

On-Cloud Recording and Playback (Old)

RTC Analytics Monthly Packages (Previous Version)

Protocols and Policies

Compliance

Security White Paper

Notes on Information Security

Service Level Agreement

Apple Privacy Policy: PrivacyInfo.xcprivacy

TRTC Policy

Data Processing And Security Agreement

Glossary

End Calls

PDF

Focus Mode

Font Size

Last updated: 2024-08-30 13:38:36

This document introduces how to end calls on the server side during audio and video calls for better management of call duration and enhanced service experience in various scenarios like medical consultations and 1V1 social interactions.
API description
API request domain: trtc.tencentcloudapi.com.
API description: Remove all users from the audio and video room to end the call.
Default API request frequency limit: 20 times/sec.
Sample request
https://trtc.tencentcloudapi.com/?Action=DismissRoom
&SdkAppId=1400000001
&RoomId=1234
&<Common request parameters>
The following table only describes the modified parameters when this API is called. For more details, see: TRTC API Request.
Parameter
Required
Type
Description
trtc.tencentcloudapi.com
Yes
String
Request API
Action
Yes
String
﻿Common Parameters. For this API, the value is `DismissRoom`.
Version
Yes
String
﻿Common Parameters, the value for this API is: 2019-07-22.
Region
Yes
String
﻿Common Parameters. See the supported Region List. This API supports only: ap-beijing, ap-guangzhou, ap-mumbai.
SdkAppId
Yes
Integer
The SDKAppId for the call.
Example value: 1400188366
RoomId
Yes
Integer
Audio and Video Room Number.
Common request parameters
Yes
/
For details, see: Common Parameters﻿
Note:
To dissolve a room with a string Room Number, set Action to: DismissRoomByStrRoomId, with RoomId of type: String.
Sample response
{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"    
    }
}
Parameter name
Type
Description
RequestId
String
Unique Request ID, generated by the server-side, is returned with each request (if a request fails to reach the server-side for other reasons, it will not receive a RequestId). Provide the RequestId of the request when troubleshooting.
Debug API
API Explorer :  API Explorer.
API Explorer makes it easy to make online API calls, verify signatures, generate SDK code, search for APIs, etc. You can also use it to query the content of each request as well as its response.
Error code
The error codes listed below are only relevant to the API business logic. For more error codes, refer to Common Error Codes.
Error code
Description
FailedOperation.RoomNotExist
Room does not exist.
InternalError
An internal error occurs.
InternalError.GetRoomCacheIpError
Failed to inquire room.
InvalidParameter.RoomId
RoomId parameter error.
InvalidParameter.SdkAppId
SdkAppId parameter error.
InvalidParameterValue.RoomId
Incorrect RoomId value.
MissingParameter.RoomId
Missing RoomId parameter.
MissingParameter.SdkAppId
Missing SdkAppId parameter.
UnauthorizedOperation.SdkAppId
No permissions to operate SdkAppId.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Tencent Real-Time Communication

End Calls

API description

Sample request

Sample response

Debug API

Error code

Help and Support

Parameter	Required	Type	Description
trtc.tencentcloudapi.com	Yes	String	Request API
Action	Yes	String	Common Parameters. For this API, the value is `DismissRoom`.
Version	Yes	String	Common Parameters, the value for this API is: 2019-07-22.
Region	Yes	String	Common Parameters. See the supported Region List. This API supports only: ap-beijing, ap-guangzhou, ap-mumbai.
SdkAppId	Yes	Integer	The SDKAppId for the call. Example value: 1400188366
RoomId	Yes	Integer	Audio and Video Room Number.
Common request parameters	Yes	/	For details, see: Common Parameters

Parameter name	Type	Description
RequestId	String	Unique Request ID, generated by the server-side, is returned with each request (if a request fails to reach the server-side for other reasons, it will not receive a RequestId). Provide the RequestId of the request when troubleshooting.

Error code	Description
FailedOperation.RoomNotExist	Room does not exist.
InternalError	An internal error occurs.
InternalError.GetRoomCacheIpError	Failed to inquire room.
InvalidParameter.RoomId	RoomId parameter error.
InvalidParameter.SdkAppId	SdkAppId parameter error.
InvalidParameterValue.RoomId	Incorrect RoomId value.
MissingParameter.RoomId	Missing RoomId parameter.
MissingParameter.SdkAppId	Missing SdkAppId parameter.
UnauthorizedOperation.SdkAppId	No permissions to operate SdkAppId.