SendAgentInstanceTTS

POST

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

本接口可用于主动调用 TTS 服务，以智能体身份向用户发送语音消息。详情及示例请参考AI主动说话：主动调用 LLM 或 TTS。

Request

Query Parameters

Action string必填

可选值: [SendAgentInstanceTTS]

接口原型参数

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

AppId uint32必填

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

SignatureNonce string必填

随机字符串。

Timestamp int64必填

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

Signature string必填

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

SignatureVersion string必填

可选值: [2.0]

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

application/json

Body

required

AgentInstanceId string必填

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

Text string必填

可选值: <= 300 characters

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

AddHistory boolean

默认值: true

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

InterruptMode integer已废弃

默认值: 0

（已弃用）请使用 Priority 和 SamePriorityOption 参数替代。智能体说话时被用户语音打断的模式：

0: 立即打断。如果在 AI 说话时用户说话，那么 AI 将被立刻打断，停止说话。请改为 Priority=Medium 和 SamePriorityOption=ClearAndInterrupt 参数替代。
1: 不打断。如果在 AI 说话时用户说话，那么 AI 不会被影响直到内容说完。请改为 Priority=High 和 SamePriorityOption=ClearAndInterrupt 参数替代。

Priority string

可选值: [Low, Medium, High]

默认值: Medium

任务优先级，默认为 Medium。可选值：

Low：低优先级
Medium：中等优先级
High：高优先级

SamePriorityOption string

可选值: [ClearAndInterrupt, Enqueue]

默认值: ClearAndInterrupt

相同优先级时的打断策略，默认为 ClearAndInterrupt。可选值：

ClearAndInterrupt：清空并打断
Enqueue：排队等待，队列最大数量为 5

Responses

发送成功

application/json

数据结构
按数据结构生成的示例

Schema

Code integer

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

Message string

请求结果说明

RequestId string

请求 ID

{
  "Code": 0,
  "Message": "Succeed",
  "RequestId": "1843985617336143872"
}

{
  "Code": 0,
  "Message": "Succeed",
  "RequestId": "1843985617336143872"
}

CURL

RESPONSE清除

点击上方 “发送” 按钮，在此处查看响应。