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.
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. |
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. |
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAITranscription
<Common request parameters>
{
"TaskId": "abc"
}
{
"Response": {
"StartTime": "abc",
"Status": "abc",
"RequestId": "abc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
문제 해결에 도움이 되었나요?