DescribeAITranscription

1. API Description

Domain name for API request: trtc.tencentcloudapi.com.

Describe AI transcription task status

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: DescribeAITranscription.
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-singapore, ap-tokyo, na-siliconvalley.
TaskId	Yes	String	Query the task status. If not in use, pass in an empty string. There are two query methods: 1. Fill in only TaskId. This method uses TaskId to query tasks. 2. TaskId is an empty string. Fill in SdkAppId and SessionId. This method does not require TaskId to query tasks.
SdkAppId	No	Integer	TRTC's SdkAppId is used together with SessionId.
SessionId	No	String	The SessionId passed in when starting the transcription task is used together with the SdkAppId.

3. Output Parameters

Parameter Name	Type	Description
StartTime	String	The time when the task starts.
Status	String	Transcription task status. There are 4 values: 1. Idle means the task has not started 2. Preparing means the task is being prepared 3. InProgress means the task is running 4. Stopped means the task has stopped and resources are being cleaned up
TaskId	String	Uniquely identifies a task.
SessionId	String	The SessionId filled in when starting the transcription task. If not filled in, nothing is returned.
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 example

Input Example

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAITranscription
<Common request parameters>

{
    "TaskId": "abc"
}

Output Example

{
    "Response": {
        "StartTime": "abc",
        "Status": "abc",
        "RequestId": "abc"
    }
}

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

Tencent Cloud CLI 3.0

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.TaskNotExist	The task does not exist.
InvalidParameter.TaskId	TaskId parameter error.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
Example1 example
5. Developer Resources
SDK
Command Line Interface
6. Error Code