音视频通话 SDK 结束通话-服务端 API-文档中心-腾讯云

本文主要介绍音视频通话过程中，如何在服务端主动结束通话，以便于更好的管理通话时长，增强在医疗问诊、1V1社交等不同场景下的服务体验。
接口说明
接口请求域名： trtc.tencentcloudapi.com 。
接口说明：把房间所有用户从音视频房间移出，结束通话。
默认接口请求频率限制：20次/秒。
请求示例
https://trtc.tencentcloudapi.com/?Action=DismissRoom
&SdkAppId=1400000001
&RoomId=1234
&<Common request parameters>
下表仅列出调用本接口时涉及修改的参数及其说明，更多详情见：实时音视频 API 请求。
参数
必选
类型
说明
trtc.tencentcloudapi.com
是
String
请求接口
Action
是
String
﻿公共参数，本接口取值：DismissRoom。
Version
是
String
﻿公共参数，本接口取值：2019-07-22。
Region
是
String
﻿公共参数，详见产品支持的 地域列表，本接口仅支持其中的：ap-beijing、ap-guangzhou、ap-mumbai 。
SdkAppId
是
Integer
通话的 SDKAppId。
示例值：1400188366
RoomId
是
Integer
音视频房间号。
Common request parameters
是
/
详情见：公共参数﻿
说明：
如需解散字符串房间号，Action 取值为：DismissRoomByStrRoomId， RoomId 类型为：String。
应答示例
{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"    
    }
}
参数名称
类型
描述
RequestId
String
唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
调试接口
API Explorer ：点击调试﻿
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
错误码
描述
FailedOperation.RoomNotExist
房间不存在。
InternalError
内部错误。
InternalError.GetRoomCacheIpError
查询房间失败。
InvalidParameter.RoomId
RoomId 参数错误。
InvalidParameter.SdkAppId
SdkAppId 参数错误。
InvalidParameterValue.RoomId
RoomId 值错误。
MissingParameter.RoomId
缺少 RoomId 参数。
MissingParameter.SdkAppId
缺少 SdkAppId 参数。
UnauthorizedOperation.SdkAppId
没有操作 SdkAppId 的权限。

参数	必选	类型	说明
trtc.tencentcloudapi.com	是	String	请求接口
Action	是	String	公共参数，本接口取值：DismissRoom。
Version	是	String	公共参数，本接口取值：2019-07-22。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的：ap-beijing、ap-guangzhou、ap-mumbai 。
SdkAppId	是	Integer	通话的 SDKAppId。示例值：1400188366
RoomId	是	Integer	音视频房间号。
Common request parameters	是	/	详情见：公共参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

错误码	描述
FailedOperation.RoomNotExist	房间不存在。
InternalError	内部错误。
InternalError.GetRoomCacheIpError	查询房间失败。
InvalidParameter.RoomId	RoomId 参数错误。
InvalidParameter.SdkAppId	SdkAppId 参数错误。
InvalidParameterValue.RoomId	RoomId 值错误。
MissingParameter.RoomId	缺少 RoomId 参数。
MissingParameter.SdkAppId	缺少 SdkAppId 参数。
UnauthorizedOperation.SdkAppId	没有操作 SdkAppId 的权限。

结束通话

本页目录：

接口说明

请求示例

应答示例

调试接口

错误码