DeleteCloudTranscription
1. API Description
Domain name for API request: trtc.intl.tencentcloudapi.com.
This API is used to terminate the transcription task after successful activation.
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 Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DeleteCloudTranscription. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-hongkong, ap-singapore. |
| SdkAppId | Yes | Integer | SDKAppId of TRTC, which is the same as the SDKAppId of the room being transcribed. |
| TaskId | Yes | String | The unique Id of the task will be returned upon success. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Task ID of the service allocation for transcribing. The task ID is the unique identifier for a transcription lifecycle process and loses its meaning once the transcription is complete. |
| RequestId | String | The 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 Stop transcription task
Input Example
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteCloudTranscription
<Common request parameters>
{
"SdkAppId": 14000000,
"TaskId": "-nE5Nd9U7pfwyEzu+8LN******j-r1AI7H3plkD1p8pHX71AE."
}
Output Example
{
"Response": {
"TaskId": "-nE5Nd9U7pfwyEzu+8LNXe******ndibj-r1AI7H3plkD1p8pHX71AE.",
"RequestId": "768c7bde-70******c-e81f21cb1599"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| AuthFailure.UnRealNameAuthenticated | Identity verification has not been completed, so this operation is not allowed. |
| AuthFailure.UnauthorizedOperation | CAM authentication failed. |
| AuthFailure.UnsupportedOperation | Unsupported operation. |
| FailedOperation.CTUnsupportMethod | The cloud transcription method does not support this. |
| InternalError | Internal error. |
| InternalError.CTInternalError | Internal errors. |
| InvalidParameter | Parameter error. |
| InvalidParameter.OutOfRange | Parameter value is out of range. |
| InvalidParameter.SdkAppId | SdkAppId is incorrect. |
| MissingParameter.RoomId | RoomId is missing. |
| MissingParameter.SdkAppId | SdkAppId is missing. |
| MissingParameter.TaskId | TaskId parameter is missing. |
| MissingParameter.UserId | Missing UserId parameter. |
| ResourceNotFound | The resource does not exist. |