1. API Description
Domain name for API request: trtc.tencentcloudapi.com.
This API is used to stop On-Cloud MixTranscoding.
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.
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 parameter. The value used for this API: StopMCUMixTranscodeByStrRoomId. |
| Version |
Yes |
String |
Common parameter. The value used for this API: 2019-07-22. |
| Region |
Yes |
String |
Common parameter. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-guangzhou |
| SdkAppId |
Yes |
Integer |
SDKAppId of TRTC |
| StrRoomId |
Yes |
String |
Room ID in string type |
3. Output Parameters
| Parameter Name |
Type |
Description |
| RequestId |
String |
The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Stopping On-Cloud MixTranscoding
This example shows you how to stop On-Cloud MixTranscoding for room Room_3560.
https:
&SdkAppId=1400188366
&StrRoomId=Room_3560
&<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 Code |
Description |
| FailedOperation.MixSessionNotExist |
No On-Cloud MixTranscoding template is set for this room. |
| FailedOperation.RequestRejection |
The TencentCloud API On-Cloud MixTranscoding template conflicts with On-Cloud MixTranscoding settings in the SDK. |
| FailedOperation.RoomNotExist |
The room does not exist. |
| FailedOperation.SdkAppIdNotExist |
Application ID does not exist. |
| InternalError |
Internal error. |
| InvalidParameter.BodyParamsError |
Failed to parse the body parameter. |
| 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. |