Feedback

查询AI对话任务

1. 接口描述

接口请求域名: trtc.intl.tencentcloudapi.com 。

成功开启对话后,可以使用此接口来查询对话状态。仅在对话任务进行时有效,对话退出后查询将会返回错误。

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

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

2. 输入参数

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

参数名称必选类型描述
Action是String公共参数,本接口取值:DescribeVoiceConversation。
Version是String公共参数,本接口取值:2019-07-22。
Region是String公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-hongkong, ap-singapore 。
SdkAppId是Integer

TRTC的SdkAppId,和对话的房间所对应的SdkAppId相同。

TaskId是String

对话任务的唯一Id,在启动对话成功后会返回。

DescribeType否Integer

查询任务状态

枚举值:

  • 0: 不查询对话上下文历史
  • 1: 查询对话上下文历史

默认值:0

3. 输出参数

参数名称类型描述
StartTimeInteger

任务启动时间

单位:毫秒

StatusString

转录任务状态。

枚举值:

  • Idle: 表示当前转录任务空闲中
  • InProgress: 表示当前转录任务正在进行中
  • Exited: 表示当前转录任务正在退出的过程中
TaskIdString

转录任务的唯一Id。

HistoryContentsArray of VoiceConversationHistoryContent

历史对话信息。

RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询对话任务

输入示例

POST / HTTP/1.1
Host: trtc.intl.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. 开发者资源

SDK

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

命令行工具

6. 错误码

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

错误码描述
AuthFailureCAM签名/鉴权错误。
AuthFailure.UnauthorizedOperationCAM鉴权失败。
AuthFailure.UnsupportedOperation不支持该操作。
FailedOperation操作失败。
InternalError内部错误。
InvalidParameter参数错误。
InvalidParameter.SdkAppIdSdkAppId参数错误。
MissingParameter缺少参数错误。
MissingParameter.RoomId缺少RoomId参数。
MissingParameter.SdkAppId缺少SdkAppId参数。
MissingParameter.TaskId缺少TaskId参数。
MissingParameter.UserId缺少UserId参数。
ResourceNotFound资源不存在。