当前内容仅提供英语版本，中文版我们将尽快补充，感谢您的理解。

ControlAIConversation

1. API Description

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

This API is used to provide service for server-side robot control.

A maximum of 50 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: ControlAIConversation.
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-ashburn, na-siliconvalley.
TaskId	Yes	String	Task unique identifier.
Command	Yes	String	Control command. currently supports the following commands: - ServerPushText: server sends text to the AI robot, and the AI robot will broadcast the text. - InvokeLLM: server sends text to the large model to trigger dialogue.
ServerPushText	No	ServerPushText	Server-Sent broadcast text Command. required when Command is ServerPushText.
InvokeLLM	No	InvokeLLM	The server sends a Command to proactively request the large model. when Command is InvokeLLM, it sends the content request to the large model and adds X-Invoke-LLM="1" to the header.

3. Output Parameters

Parameter Name	Type	Description
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 Send Broadcast Text

When you want the robot to proactively broadcast text, use this API

Input Example

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

{
    "TaskId": "your-taskid",
    "Command": "ServerPushText",
    "ServerPushText": {
Hello, happy to serve you.
        "Interrupt": true
    }
}

Output Example

{
    "Response": {
        "RequestId": "xxx-xxx"
    }
}

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 run does not exist or is stopped.
InvalidParameter.TaskId	TaskId parameter error.