ControlAIConversation

Last updated: 2025-11-11 10:19:43

ControlAIConversation

Last updated: 2025-11-11 10:19:43

1. API Description

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

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

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: 2020-02-10.
Region	No	String	Common Params. This parameter is not required.
SessionId	Yes	String	Specifies the session ID.
SdkAppId	Yes	Integer	App ID (required). can be used to view https://console.tencentcloud.com/ccc.
Command	No	String	Control command. currently supported commands are as follows:. -ServerPushText. specifies the text sent by the server to the AI robot for broadcast. -InvokeLLM. specifies the server sends text to the large model to trigger a dialogue.
ServerPushText	No	ServerPushText	Specifies the 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 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

This example shows you how to use this API when you want the robot to proactively broadcast text.

Input Example

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

{
    "SdkAppId": "1400000000",
    "SessionId": "6bb56a09-2787-40bc-80c5-dc6dab783eff",
    "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.ControlAIConversation	Control ai conversation error information.
FailedOperation.SessionNotExists	Session does not exist.
FailedOperation.SessionNotInControlState	Session not in control status.
InvalidParameterValue.InstanceNotExist	The SDKAppID does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud