DescribeAIConversation

1. API Description

Domain name for API request: trtc.tencentcloudapi.com.

Describe the AI conversation task status

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeAIConversation.
Version	Yes	String	Common Params. The value used for this API: 2019-07-22.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-singapore, ap-tokyo, na-siliconvalley.
SdkAppId	No	Integer	TRTC's SdkAppId is the same as the SdkAppId used by the room that starts the transcription task.
TaskId	No	String	The unique ID of the task.
SessionId	No	String	The SessionId filled in when starting the task.

3. Output Parameters

Parameter Name	Type	Description
StartTime	String	The time when the task starts.
Status	String	Task status. There are 4 values: 1. Idle means the task has not started 2. Preparing means the task is being prepared 3. InProgress means the task is running 4. Stopped means the task has stopped and resources are being cleaned up
TaskId	String	The unique ID of the task, generated when the task is started
SessionId	String	The SessionId filled in when opening the conversation task.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Describe the AI conversation task status

Input Example

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAIConversation
<Common request parameters>

{
    "TaskId": "SV1FR+XTtvzAjRxZZ+aof1DfJF00VSBBNE0zR9W-PEpgCPBmt402BbnqMCdom79LtZO-VbLyV1nhVY1pFauWgrW12BevPvJ5Zn010RnD6vj3hgfbV0."
}

Output Example

{
    "Response": {
        "StartTime": "abc",
        "Status": "abc",
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.TaskNotExist	The task does not exist.
InvalidParameter.TaskId	TaskId parameter error.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
Example1 Describe the AI conversation task status
5. Developer Resources
SDK
Command Line Interface
6. Error Code