1. 接口描述
接口请求域名: trtc.tencentcloudapi.com 。
成功开启对话后,可以使用此接口来查询对话状态。仅在对话任务进行时有效,对话退出后查询将会返回错误。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeVoiceConversation。 |
| Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。 |
| SdkAppId | 是 | Integer | TRTC的SdkAppId,和对话的房间所对应的SdkAppId相同。 示例值:1400000311 |
| TaskId | 是 | String | 对话任务的唯一Id,在启动对话成功后会返回。 示例值:-nG0jIFU7rPr0tFW0cg282rOxP*bUA9JbOXgp3tnRyVJAzlBFAE. |
| DescribeType | 否 | Integer | 查询任务状态 枚举值:
默认值:0 示例值:1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| StartTime | Integer | 任务启动时间 单位:毫秒 示例值:1790081311564 |
| Status | String | 转录任务状态。 枚举值:
示例值:InProgress |
| TaskId | String | 转录任务的唯一Id。 示例值:-nG0jIFU7rPr0tFW0cg282rOxP*bUA9JbOXgp3tnRyVJAzlBFAE. |
| HistoryContents | Array of VoiceConversationHistoryContent | 历史对话信息。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询对话任务
输入示例
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVoiceConversation
<公共请求参数>
{
"SdkAppId": 1400000311,
"TaskId": "-nG0jIFU7rPr0tFW0cg282rOxP*************************bUA9JbOXgp3tnRyVJAzlBFAE.",
"DescribeType": 1
}
输出示例
{
"Response": {
"HistoryContents": [
{
"Role": "user",
"Content": "最近上海天气怎么样"
},
{
"Role": "assistant",
"Content": "我无法获取实时天气数据,所以没法告诉你上海当前的具体天气情况。建议你打开手机自带的天气应用,或访问中国天气网等平台查询最新预报。\n\n如果你告诉我具体日期,我也可以帮你说明上海这个季节通常的气候特点(比如气温范围、降水情况),供你参考。"
}
],
"StartTime": 1790081311564,
"Status": "InProgress",
"TaskId": "-nG0jIFU7rPr0tFW0cg282rOxP*************************bUA9JbOXgp3tnRyVJAzlBFAE.",
"RequestId": "ebb2213e-7322-4f9b-8fcd-60c08a5168b7"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | CAM鉴权失败。 |
| AuthFailure.UnsupportedOperation | 不支持该操作。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.SdkAppId | SdkAppId参数错误。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.RoomId | 缺少RoomId参数。 |
| MissingParameter.SdkAppId | 缺少SdkAppId参数。 |
| MissingParameter.TaskId | 缺少TaskId参数。 |
| MissingParameter.UserId | 缺少UserId参数。 |
| ResourceNotFound | 资源不存在。 |