1. 接口描述
接口请求域名： asr.tencentcloudapi.com 。
调用录音文件识别请求接口后，有回调和轮询两种方式获取识别结果。
• 注意任务有效期为24小时，超过24小时的任务请不要再查询，且不要依赖TaskId作为业务唯一ID，不同日期可能出现重复TaskId。
• 当采用回调方式时，识别完成后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL，具体请参见 录音识别结果回调 。
• 当采用轮询方式时，需要主动提交任务ID来轮询识别结果，共有任务成功、等待、执行中和失败四种结果，具体信息请参见下文说明。
• 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8"
• 签名方法参考 公共参数 中签名方法v3。
• 默认接口请求频率限制：50次/秒，如您有提高请求频率限制的需求，请提工单进行咨询。
默认接口请求频率限制：50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTaskStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2019-06-14。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| TaskId | 是 | Integer | 从CreateRecTask接口获取的TaskId，用于获取任务状态与结果。 注意：TaskId有效期为24小时，超过24小时的TaskId请不要再查询。 示例值：4500055927 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | TaskStatus | 录音文件识别的请求返回结果。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 轮询结果——任务失败
用户通过轮询方式获取识别结果，任务失败，具体原因请用户查看返回中ErrorMsg提示。
输入示例
POST / HTTP/1.1
Host: asr.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=************************************************************/2020-09-03/asr/tc3_request, SignedHeaders=content-type;host, Signature=6647fa852c9329ac5aa355c68c838358139c2d941f4ed175dd5858978f5d79c8
Content-Length: 21
<公共请求参数>
{
"TaskId": 522931820
}输出示例
{
"Response": {
"RequestId": "8824366f-0e8f-4bd4-8924-af5e84127caa",
"Data": {
"TaskId": 522931820,
"Status": 3,
"StatusStr": "failed",
"AudioDuration": 0,
"Result": "",
"ErrorMsg": "Failed to download audio file!",
"ResultDetail": []
}
}
}示例2 轮询结果——任务成功
用户通过轮询方式获取识别结果，任务成功，并返回识别结果。
输入示例
POST / HTTP/1.1
Host: asr.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=************************************************************/2020-09-03/asr/tc3_request, SignedHeaders=content-type;host, Signature=6647fa852c9329ac5aa355c68c838358139c2d941f4ed175dd5858978f5d79c8
Content-Length: 21
<公共请求参数>
{
"TaskId": 522931820
}输出示例
{
"Response": {
"RequestId": "a73b14a6-5044-41cb-bf32-e735d5bd69de",
"Data": {
"TaskId": 9266418,
"Status": 2,
"StatusStr": "success",
"AudioDuration": 2.38,
"Result": "[0:0.020,0:2.380] 腾讯云语音识别欢迎您。\n",
"ResultDetail": [
{
"FinalSentence": "腾讯云语音识别欢迎您。",
"SliceSentence": "腾讯云 语音识别 欢迎 您",
"StartMs": 20,
"EndMs": 2380,
"SpeechSpeed": 5.9,
"WordsNum": 4,
"EmotionalEnergy": 0,
"SpeakerId": 0,
"SilenceTime": 0,
"EmotionType": [
"happy"
],
"Words": [
{
"OffsetStartMs": 120,
"OffsetEndMs": 780,
"Word": "腾讯云"
},
{
"OffsetStartMs": 780,
"OffsetEndMs": 1530,
"Word": "语音识别"
},
{
"OffsetStartMs": 1530,
"OffsetEndMs": 1860,
"Word": "欢迎"
},
{
"OffsetStartMs": 1860,
"OffsetEndMs": 2250,
"Word": "您"
}
]
}
],
"ErrorMsg": ""
}
}
}示例3 轮询结果——任务等待
用户通过轮询方式获取识别结果，任务等待，说明任务还在识别队列中，请用户耐心等候。
输入示例
POST / HTTP/1.1
Host: asr.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=************************************************************/2020-09-03/asr/tc3_request, SignedHeaders=content-type;host, Signature=6647fa852c9329ac5aa355c68c838358139c2d941f4ed175dd5858978f5d79c8
Content-Length: 21
<公共请求参数>
{
"TaskId": 522931820
}输出示例
{
"Response": {
"RequestId": "8824366f-0e8f-4bd4-8924-af5e84127caa",
"Data": {
"TaskId": 522931820,
"Status": 0,
"StatusStr": "waiting",
"AudioDuration": 0,
"Result": "",
"ErrorMsg": "",
"ResultDetail": []
}
}
}示例4 轮询结果——任务执行中
用户通过轮询方式获取识别结果，任务执行中，说明任务已经开始识别，请用户耐心等候。
输入示例
POST / HTTP/1.1
Host: asr.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=************************************************************/2020-09-03/asr/tc3_request, SignedHeaders=content-type;host, Signature=6647fa852c9329ac5aa355c68c838358139c2d941f4ed175dd5858978f5d79c8
Content-Length: 21
<公共请求参数>
{
"TaskId": 522931820
}输出示例
{
"Response": {
"RequestId": "8824366f-0e8f-4bd4-8924-af5e84127caa",
"Data": {
"TaskId": 522931820,
"Status": 1,
"StatusStr": "doing",
"AudioDuration": 0,
"Result": "",
"ErrorMsg": "",
"ResultDetail": []
}
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ErrorDownFile | 下载音频文件失败。 |
| FailedOperation.ErrorRecognize | 识别失败。 |
| FailedOperation.NoSuchTask | 错误的TaskId。 |
| FailedOperation.ServiceIsolate | 账号因为欠费停止服务，请在腾讯云账户充值。 |
| FailedOperation.UserHasNoFreeAmount | 资源包耗尽，请开通后付费或者购买资源包 |
| InternalError.FailAccessDatabase | 访问数据库失败。 |
| InternalError.FailAccessRedis | 访问Redis失败。 |
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| UnknownParameter | 未知参数错误。 |
