ControlAIConversation

1. API Description

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

Provides server-side control of AI Conversation

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: 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-siliconvalley.
TaskId	Yes	String	Unique ID of the task
Command	Yes	String	Control commands, currently supported commands are as follows: - ServerPushText, the server sends text to the AI robot, and the AI robot will play the text
ServerPushText	No	ServerPushText	The server sends a text broadcast command. This is required when Command is ServerPushText.

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 actively broadcast text, you can use this interface

Input Example

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

{
    "TaskId": "your-taskid",
    "Command": "ServerPushText",
    "ServerPushText": {
        "Text": "Hello, I am glad 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 task does not exist.
InvalidParameter.TaskId	TaskId parameter error.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
Example1 Send broadcast text
5. Developer Resources
SDK
Command Line Interface
6. Error Code