End Calls
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 | |
Version | Yes | String | |
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 | / |
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 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. |