1. 接口描述
接口请求域名： ccc.tencentcloudapi.com 。
提供服务端控制机器人的功能
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ControlAIConversation。 |
| Version | 是 | String | 公共参数，本接口取值：2020-02-10。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| SessionId | 是 | String | 会话 ID 示例值：7cb26a84-83b2-42d8-a19b-7dae78e9b78e |
| SdkAppId | 是 | Integer | 应用 ID（必填），可以查看 https://console.cloud.tencent.com/ccc 示例值：1400000000 |
| Command | 否 | String | 控制命令，目前支持命令如下： - ServerPushText，服务端发送文本给AI机器人，AI机器人会播报该文本 - InvokeLLM，服务端发送文本给大模型，触发对话 示例值：ServerPushText |
| ServerPushText | 否 | ServerPushText | 服务端发送播报文本命令，当Command为ServerPushText时必填 |
| InvokeLLM | 否 | InvokeLLM | 服务端发送命令主动请求大模型,当Command为InvokeLLM时会把content请求到大模型,头部增加X-Invoke-LLM="1" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 发送播报文本
当您想让机器人主动播报文本的时候，可以使用该接口
输入示例
POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ControlAIConversation
<公共请求参数>
{
"SdkAppId": "1400000000",
"SessionId": "6bb56a09-2787-40bc-80c5-dc6dab783eff",
"Command": "ServerPushText",
"ServerPushText": {
"Text": "你好很高兴为您服务",
"Interrupt": true
}
}输出示例
{
"Response": {
"RequestId": "xxx-xxx"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ControlAIConversation | ControlAIConversation错误信息 |
| FailedOperation.SessionNotExists | 会话不存在 |
| FailedOperation.SessionNotInControlState | 会话不在可控制状态 |
| InvalidParameterValue.InstanceNotExist | 实例不存在。 |
