logo
当前页

SendAgentInstanceTTS

POST

https://aigc-aiagent-api.zegotech.cn/

本接口可用于主动调用 TTS 服务,以智能体身份向用户发送语音消息。(1. 当调用此接口时,若会话中的智能体正在说话,则该智能体的说话进程会被打断;2. 调用本接口传入的文本消息,会根据 AddHistory 参数决定是否被记录在会话消息历史之中,作为上下文输入给 LLM,同时该消息还会通过 RTC 房间消息下发。)

Request

Query Parameters

    Action stringrequired

    Possible values: [SendAgentInstanceTTS]

    接口原型参数

    https://aigc-aiagent-api.zegotech.cn?Action=SendAgentInstanceTTS

    AppId uint32required

    AppId,ZEGO 分配的用户唯一凭证。

    SignatureNonce stringrequired

    随机字符串。

    Timestamp int64required

    Unix 时间戳,单位为秒。最多允许 10 分钟的误差。

    Signature stringrequired

    签名,用于验证请求的合法性。

    SignatureVersion stringrequired

    Possible values: [2.0]

    签名版本号,默认值为 2.0。

Body

required
    AgentInstanceId stringrequired

    智能体实例的唯一标识,通过 创建智能体实例 接口的响应参数获取。

    Text stringrequired

    Possible values: <= 300 characters

    用于 TTS 的文本内容,最大不超过 300 个字符。

    AddHistory boolean

    Default value: true

    是否将文本消息记录在会话消息历史之中,作为上下文输入给 LLM。

    InterruptMode integer

    Default value: 0

    智能体说话时被用户语音打断的模式:

    • 0: 立即打断。如果在 AI 说话时用户说话,那么 AI 将被立刻打断,停止说话(默认)。
    • 1: 不打断。如果在 AI 说话时用户说话,那么 AI 不会被影响直到内容说完。

Responses

发送成功
Schema
    Code integer

    返回码,0 表示成功,其他值表示失败。详情请参考 返回码 说明。

    Message string

    请求结果说明

    RequestId string

    请求 ID


1
Copied!
Request
Collapse all
Base URL
https://aigc-aiagent-api.zegotech.cn
统一接入地址(不区分区域)
Parameters
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
Bodyrequired
{
"AgentInstanceId": "1907755175297171456",
"Text": "尊敬的开发者你好,欢迎使用 ZEGO RTC 共建实时互动世界。",
"AddHistory": true,
"InterruptMode": 0
}
RESPONSEClear

Click the "Send" button above and see the response here!

Previous

主动调用 LLM

Next

查询智能体实例状态

当前页

返回到顶部