创建AI对话任务-APIs-Tencent Cloud

1. 接口描述

接口请求域名： trtc.tencentcloudapi.com 。

创建AI对话任务。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateVoiceConversation。
Version	是	String	公共参数，本接口取值：2019-07-22。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。
SdkAppId	是	Integer	TRTC的SdkAppId，和对话的房间所对应的SdkAppId相同。示例值：1400000311
RoomId	是	String	TRTC的RoomId，对话的TRTC房间所对应的RoomId。注：房间号类型默认为整型，若房间号类型为字符串，请通过RoomIdType指定。示例值：99884336
RoomIdType	是	Integer	房间信息RoomType，必须和对话的房间所对应的RoomId类型相同，0为整型房间号，1为字符串房间号。枚举值： 0：数字房间号 1：字符串房间号默认值：0 示例值：0
AgentConfig	是	VoiceConversationConfig	对话机器人相关配置。
ConversationMode	否	String	对话链路模式：`Cascade`（默认，三段式）/ `S2S`（端到端语音大模型）。枚举值： Cascade：默认，三段式 S2S：端到端语音大模型默认值：Cascade 示例值：Cascade
S2SConfig	否	VoiceConversationS2SConfig	端到端语音大模型配置。仅 `S2S` 模式必填；`Cascade` 模式忽略。
STTConfig	否	VoiceConversationSTTConfig	语音识别配置。仅 `Cascade` 模式必填；`S2S` 模式忽略。
LLMConfig	否	VoiceConversationLLMConfig	大模型配置。仅 `Cascade` 模式必填；`S2S` 模式忽略。
TTSConfig	否	VoiceConversationTTSConfig	语音合成配置。仅 `Cascade` 模式必填；`S2S` 模式忽略。
DialogConfig	否	VoiceConversationDialogConfig	对话控制配置，`S2S` 模式不支持填写该参数。
VisionConfig	否	VoiceConversationVisionConfig	视觉理解配置，`S2S` 模式不支持填写该参数。

3. 输出参数

参数名称	类型	描述
TaskId	String	用于唯一标识对话任务，由腾讯云服务端生成，后续查询、控制等请求都需要携带TaskID参数。示例值：-nG0jIFU7iHfG3DHVsI24YFXEn*bRRKvrG-CxBxuPyrGvSr2ZQE.
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 开始对话任务（三段式）

输入示例

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVoiceConversation
<公共请求参数>

{
    "SdkAppId": 1400000311,
    "RoomId": "99884336",
    "RoomIdType": 0,
    "AgentConfig": {
        "UserId": "test2",
        "UserSig": "eJyrVgrxCdYrzkxXslJQyvEsqDTzcyrzyHGNcgoMKsuudEt2D3D1KUwsi8jy8PD3NQnK********************************************************************cmWpRSDrjPQMYKaUZOaCzTA3MzYwMDI2NYOKZ6ak5pVkpmVCNJSkFpcYKdUCAKlEMxg_",
        "TargetUserId": [
            "Jeff"
        ],
        "TTSPushRoomParams": {
            "UserId": "tts-bot-001"
        },
        "MaxIdleTime": 5000,
        "FilterBracketsContent": [
            1
        ],
        "SubtitleMode": 0,
        "TurnDetectionMode": "auto"
    },
    "ConversationMode": "Cascade",
    "STTConfig": {
        "Provider": "trtc",
        "Params": "{\"engine_model_type\":\"bigmodel\", \"max_speak_time\":\"60000\", \"language\":\"zh\"}"
    },
    "LLMConfig": {
        "LLMType": "tencent",
        "Model": "hunyu*****0628",
        "APIUrl": "http://api.taiji.w*****************/chat/completions",
        "APIKey": "n21LYT6WmpE***********mqWKCrQlzJ",
        "SystemPrompt": "你是一个简洁的对话助手。",
        "FailureMessage": "系统繁忙请稍后再试",
        "MaxTokens": 0,
        "ThinkingMode": false,
        "MaxHistory": 50,
        "MaxToolRound": 20,
        "Timeout": 60000,
        "Temperature": 0.5,
        "TopP": 0.9,
        "McpServer": {
            "Name": "weath****ools",
            "Url": "https://m*********e.com/sse",
            "Timeout": 10000,
            "Headers": [
                {
                    "Key": "enable_search",
                    "Value": "true"
                }
            ],
            "ToolList": [
                "get_****her"
            ]
        },
        "CustomHeaders": [
            {
                "Key": "X-Request-Source",
                "Value": "trtc-conversation"
            }
        ],
        "CustomFields": [
            {
                "Key": "enable_search",
                "Value": "true"
            }
        ],
        "HistoryMessages": [
            {
                "Role": "user",
                "Content": "你好"
            }
        ]
    },
    "TTSConfig": {
        "Provider": "trtc",
        "Params": "{\"model\":\"flow_02_turbo\",\"voice_id\":\"v-female-R2s4N9qJ\",\"speed\":1.0,\"volume\":1.0,\"pitch\":0}"
    },
    "DialogConfig": {
        "InterruptMode": 2,
        "InterruptSpeechDuration": 200,
        "InterruptKeywords": [
            "停止"
        ],
        "SilenceFollowUp": 50,
        "SilenceFollowUpText": "你还在吗？有想问的直接告诉我。",
        "WelcomeMessage": "您好，我是你的ai助手，请问有什么可以帮您？"
    },
    "VisionConfig": {
        "Enable": true,
        "StorageType": 0
    }
}

输出示例

{
    "Response": {
        "TaskId": "-nG0jIFU7iHfG3DHVsI24YFXEn*************************bRRKvrG-CxBxuPyrGvSr2ZQE.",
        "RequestId": "45192e66-a49e-4ea4-92f0-519955e3c903"
    }
}

示例2 开始对话任务（端到端语音大模型）

输入示例

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVoiceConversation
<公共请求参数>

{
    "SdkAppId": 1400704311,
    "RoomId": "9988123",
    "RoomIdType": 0,
    "AgentConfig": {
        "UserId": "test2",
        "UserSig": "eJyrVgrxCdYrzkxXslJQyvEsqDTzcyrzyHGNcgoMKsuudEt2D3D1KUwsi8jy8PD3NQnK********************************************************************cmWpRSDrjPQMYKaUZOaCzTA3MzYwMDI2NYOKZ6ak5pVkpmVCNJSkFpcYKdUCAKlEMxg_",
        "TargetUserId": [
            "Jeff"
        ],
        "TTSPushRoomParams": {
            "UserId": "tts-bot-001"
        },
        "MaxIdleTime": 50
    },
    "ConversationMode": "S2S",
    "S2SConfig": {
        "Provider": "doubao",
        "Params": "{\"api_key\":\"xxxxxx\",\"type\":\"session.create\",\"session\":{\"id\":\"\",\"model\":\"1.2.6.1\",\"instructions\":\"你是一位生活小助手，擅长回答菜谱、旅游、育儿、健康、购物、法律等日常问题，请用中文简洁清晰地回答。\",\"type\":\"realtime\",\"audio\":{\"input\":{\"format\":{\"type\":\"pcm\",\"rate\":16000}},\"output\":{\"format\":{\"type\":\"pcm_s16le\",\"rate\":24000},\"voice\":\"zh_female_vv_jupiter_bigtts\"}}},\"extension\":{\"asr\":{\"extra\":{}},\"dialog\":{\"bot_name\":\"豆包\"},\"tts\":{\"speaker\":\"zh_female_vv_jupiter_bigtts\",\"audio_config\":{\"channel\":1,\"format\":\"pcm_s16le\",\"sample_rate\":24000}}}}"
    }
}

输出示例

{
    "Response": {
        "TaskId": "-nG0jIFU7g8UyQOwf8uvyfe1ph*************************bAp-C8HdhuD+Acd+5Tavn6AE.",
        "RequestId": "32151e30-fd9f-47d4-b59d-72a372eb61f0"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation	CAM鉴权失败。
AuthFailure.UnsupportedOperation	不支持该操作。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.OutOfRange	参数超出范围。
InvalidParameter.SdkAppId	SdkAppId参数错误。
MissingParameter	缺少参数错误。
MissingParameter.Region	缺少Region参数。
MissingParameter.RoomId	缺少RoomId参数。
MissingParameter.SdkAppId	缺少SdkAppId参数。
MissingParameter.UserId	缺少UserId参数。
MissingParameter.UserSig	缺少UserSig参数。
UnsupportedOperation	操作不支持。

创建AI对话任务

On this page:

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 开始对话任务（三段式）

输入示例

输出示例

示例2 开始对话任务（端到端语音大模型）

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码