1. API Description

Domain name for API request: asr.intl.tencentcloudapi.com.

The recognition results can be obtained through callback or polling after the recording recognition request API is called.

• ** Note: A task is valid for 24 hours. Do not query the results with tasks that have existed for more than 24 hours or use task ID as the unique business ID because duplicate TaskIds of different dates may exist. **
• For the callback method, the results will be sent by using a POST request to the callback URL specified in the request after the recognition is completed. For more details, see [Callback Description] (https://www.tencentcloud.com/document/product/1093/52632?from_cn_redirect=1).
• For the polling method, you need to actively provide the task ID to poll for recognition results. There are four possible results: success, waiting, in progress, and failure. For detailed information, see the content below.
• The request method is HTTP POST, and Content-Type is "application/json; charset=utf-8".
• For the signature method, see the content related to the signature method v3 in Public Parameters.
• Default request frequency limit: 50 requests/second. If you want to increase the request frequency limit, submit a ticket.

A maximum of 50 requests can be initiated per second for this API.

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.

3. Output Parameters

4. Example

Example1 Performing polling to obtain the result - task failed

Retrieve the recognition result through polling. The task fails. You can check the value of ErrorMsg in the returned result for the failure cause.

Input Example

POST / HTTP/1.1
Host: asr.intl.tencentcloudapi.com
Content-Type: application/json; charset=utf-8
X-TC-Version: 2019-06-14
X-TC-Region: ap-shanghai
X-TC-Action: DescribeTaskStatus
X-TC-Timestamp: 1599142563
Authorization: TC3-HMAC-SHA256 Credential=xxx/2020-09-03/asr/tc3_request, SignedHeaders=content-type;host, Signature=6647fa852c9329ac5aa355c68c838358139c2d941f4ed175dd5858978f5d79c8
Content-Length: 21
<Common request parameters>

{
    "TaskId": 522931820
}

Output Example

{
    "Response": {
        "RequestId": "8824366f-0e8f-4bd4-8924-af5e84127caa",
        "Data": {
            "TaskId": 522931820,
            "Status": 3,
            "StatusStr": "failed",
            "AudioDuration": 0,
            "Result": "",
            "ErrorMsg": "Failed to download audio file!",
            "ResultDetail": []
        }
    }
}

Example2 Performing polling to obtain the result - task successful

Retrieve the recognition result through polling. The task is successful, and the recognition result is returned.

Input Example

POST / HTTP/1.1
Host: asr.intl.tencentcloudapi.com
Content-Type: application/json; charset=utf-8
X-TC-Version: 2019-06-14
X-TC-Region: ap-shanghai
X-TC-Action: DescribeTaskStatus
X-TC-Timestamp: 1599142563
Authorization: TC3-HMAC-SHA256 Credential=xxx/2020-09-03/asr/tc3_request, SignedHeaders=content-type;host, Signature=6647fa852c9329ac5aa355c68c838358139c2d941f4ed175dd5858978f5d79c8
Content-Length: 21
<Common request parameters>

{
    "TaskId": 522931820
}

Output Example

{
    "Response": {
        "RequestId": "a73b14a6-5044-41cb-bf32-e735d5bd69de",
        "Data": {
            "TaskId": 9266418,
            "Status": 2,
            "StatusStr": "success",
            "AudioDuration": 2.38,
            "Result": "[0:0.020,0:2.380] Welcome to Tencent Cloud ASR,\n",
            "ResultDetail": [
                {
                    "FinalSentence": "Welcome to Tencent Cloud ASR,",
                    "SliceSentence": "Welcome to  Tencent Cloud  ASR,",
                    "StartMs": 20,
                    "EndMs": 2380,
                    "SpeechSpeed": 5.9,
                    "WordsNum": 4,
                    "EmotionalEnergy": 0,
                    "SpeakerId": 0,
                    "SilenceTime": 0,
                    "EmotionType": [
                        "happy"
                    ],
                    "Words": [
                        {
                            "OffsetStartMs": 120,
                            "OffsetEndMs": 780,
                            "Word": "Tencent Cloud"
                        },
                        {
                            "OffsetStartMs": 780,
                            "OffsetEndMs": 1530,
                            "Word": "ASR"
                        },
                        {
                            "OffsetStartMs": 1530,
                            "OffsetEndMs": 1860,
                            "Word": "Welcome to"
                        },
                        {
                            "OffsetStartMs": 1860,
                            "OffsetEndMs": 2250,
                            "Word": " "
                        }
                    ],
                }
            ],
            "ErrorMsg": ""
        }
    }
}

Example3 Performing polling to obtain the result - task waiting

Retrieve the recognition result through polling. The task is waiting, which means that the task is still in the queue. You need to wait patiently.

Input Example

POST / HTTP/1.1
Host: asr.intl.tencentcloudapi.com
Content-Type: application/json; charset=utf-8
X-TC-Version: 2019-06-14
X-TC-Region: ap-shanghai
X-TC-Action: DescribeTaskStatus
X-TC-Timestamp: 1599142563
Authorization: TC3-HMAC-SHA256 Credential=xxx/2020-09-03/asr/tc3_request, SignedHeaders=content-type;host, Signature=6647fa852c9329ac5aa355c68c838358139c2d941f4ed175dd5858978f5d79c8
Content-Length: 21
<Common request parameters>

{
    "TaskId": 522931820
}

Output Example

{
    "Response": {
        "RequestId": "8824366f-0e8f-4bd4-8924-af5e84127caa",
        "Data": {
            "TaskId": 522931820,
            "Status": 0,
            "StatusStr": "waiting",
            "AudioDuration": 0,
            "Result": "",
            "ErrorMsg": "",
            "ResultDetail": []
        }
    }
}

Example4 Performing polling to obtain the result - task in progress

Retrieve the recognition result through polling. The task is in progress, which means that recognition has started. You need to wait patiently.

Input Example

POST / HTTP/1.1
Host: asr.intl.tencentcloudapi.com
Content-Type: application/json; charset=utf-8
X-TC-Version: 2019-06-14
X-TC-Region: ap-shanghai
X-TC-Action: DescribeTaskStatus
X-TC-Timestamp: 1599142563
Authorization: TC3-HMAC-SHA256 Credential=xxx/2020-09-03/asr/tc3_request, SignedHeaders=content-type;host, Signature=6647fa852c9329ac5aa355c68c838358139c2d941f4ed175dd5858978f5d79c8
Content-Length: 21
<Common request parameters>

{
    "TaskId": 522931820
}

Output Example

{
    "Response": {
        "RequestId": "8824366f-0e8f-4bd4-8924-af5e84127caa",
        "Data": {
            "TaskId": 522931820,
            "Status": 1,
            "StatusStr": "doing",
            "AudioDuration": 0,
            "Result": "",
            "ErrorMsg": "",
            "ResultDetail": []
        }
    }
}

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

• 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.