录音文件识别结果查询

最近更新时间:2020-11-18 08:00:48

1. 接口描述

接口请求域名: asr.tencentcloudapi.com 。

在调用录音文件识别请求接口后,有回调和轮询两种方式获取识别结果。
• 当采用回调方式时,识别完成后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL,具体请参见 录音识别结果回调
• 当采用轮询方式时,需要主动提交任务ID来轮询识别结果,共有任务成功、等待、执行中和失败四种结果,具体信息请参见下文说明。
• 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8"
• 签名方法参考 公共参数 中签名方法v3。

默认接口请求频率限制:50次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTaskStatus。
Version String 公共参数,本接口取值:2019-06-14。
Region String 公共参数,本接口不需要传递此参数。
TaskId Integer 从CreateRecTask接口获取的TaskId,用于获取任务状态与结果。

3. 输出参数

参数名称 类型 描述
Data TaskStatus 录音文件识别的请求返回结果。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 轮询结果——任务成功

用户通过轮询方式获取识别结果,任务成功,并返回识别结果。

输入示例

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=AKIDYu6A16GdCxUlnbTSVItxvhOr6Bxxxxx2/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": 2,
      "StatusStr": "success",
      "Result": "[0:0.000,0:2.260,0]  腾讯云语音识别欢迎您。\n",
      "ErrorMsg": ""
    }
  }
}

示例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=AKIDYu6A16GdCxUlnbTSVItxvhOr6Bxxxxx2/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",
      "Result": "",
      "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=AKIDYu6A16GdCxUlnbTSVItxvhOr6Bxxxxx2/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",
      "Result": "",
      "ErrorMsg": ""
    }
  }
}

示例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=AKIDYu6A16GdCxUlnbTSVItxvhOr6Bxxxxx2/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",
      "Result": "",
      "ErrorMsg": "Failed to download audio file!"
    }
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.ErrorDownFile 下载音频文件失败。
FailedOperation.ErrorRecognize 识别失败。
FailedOperation.NoSuchTask 错误的TaskId。
FailedOperation.ServiceIsolate 账号因为欠费停止服务,请在腾讯云账户充值。
FailedOperation.UserHasNoFreeAmount 账号本月免费额度已用完。
InternalError.FailAccessDatabase 访问数据库失败。
InternalError.FailAccessRedis 访问Redis失败。
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。
UnknownParameter 未知参数错误。
目录