主动调用 TTS
描述
本接口可用于主动调用 TTS 服务,以智能体身份向用户发送语音消息。
- 当调用此接口时,若会话中的智能体正在说话,则该智能体的说话进程会被打断;
- 调用本接口传入的文本消息,会被记录在会话消息历史之中,作为上下文输入给 LLM,同时该消息还会通过 RTC 房间消息下发。
接口原型
- 请求方法:POST
- 请求地址:
https://aigc-aiagent-api.zegotech.cn?Action=SendAgentInstanceTTS
- 传输协议:HTTPS
- 调用频率限制:10 次/秒
请求参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
AgentInstanceId | String | 是 | 智能体实例的唯一标识,通过 创建智能体实例 接口的响应参数获取。 |
Text | String | 是 | 用于 TTS 的文本内容,最大不超过 300 个字符。 |
请求示例
-
请求地址 URL:
Untitledhttps://aigc-aiagent-api.zegotech.cn?Action=SendAgentInstanceTTS &<公共请求参数>
1 -
请求消息体:
Untitled{ "AgentInstanceId": "1907780504753553408", "Text": "尊敬的开发者你好,欢迎使用 ZEGO RTC 共建实时互动世界。" }
1
响应参数
参数 | 类型 | 描述 |
---|---|---|
Code | Int | 返回码。0 表示成功,其他值表示失败。如需了解错误码及响应处理建议,请参考 返回码。 |
Message | String | 请求结果的说明信息。 |
RequestId | String | 请求 ID。 |
Data | Object | 此请求结果为 null 。 |
响应示例
Untitled
{
"Code": 0,
"Message": "success",
"RequestId": "1843985617336143872",
"Data": null
}
1