文档中心>声音复刻>API 文档>声音复刻相关接口>声音复刻任务结果查询接口

声音复刻任务结果查询接口

最近更新时间:2024-03-12 02:04:18

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVRSTaskStatus。
Version String 公共参数,本接口取值:2020-08-24。
Region String 公共参数,此参数为可选参数。
TaskId String 任务ID

3. 输出参数

参数名称 类型 描述
Data DescribeVRSTaskStatusRespData 声音复刻任务结果
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 声音复刻任务结果查询

声音复刻任务结果查询

输入示例

POST / HTTP/1.1
Host: vrs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVrsTaskStatus
<公共请求参数>

{
    "TaskId": "ed461a019355c5cd1ce31ab4dfb8cb12"
}

输出示例

{
    "Response": {
        "Data": {
            "TaskId": "ed461a019355c5cd1ce31ab4dfb8cb12",
            "Status": 2,
            "StatusStr": "waiting in queue",
            "VoiceType": 100000,
            "ErrorMsg": ""
        },
        "RequestId": "63f43c3d6e30af6bd63735b0"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.NoSuchTask 任务不存在。