logo
ConsoleSign Up
AI Agent
Server
Introduction
Overview
Download SDK and Demo
Release Notes
Quick Start
Quick Start Voice Call
Quick Start Digital Human Video Call
Basic
Configuring LLM
Configuring ASR
Configuring TTS
AI Proactive Speech: Proactively Invoke LLM or TTS
Display Subtitles
Display User And Agent Status
Get AI Agent Status
Interrupt Agent
Advanced
Speech Segmentation Control
AI Short-Term Memory Management
Best Practices
Role-Playing System Prompt
Clone Voice
Interact with AI in IM and make voice calls
Use AI Agent with RAG
API Reference
Overview
Accessing Server APIs
Call API Online
Return Codes
Agent Configuration Management
POST
Register Agent
POST
Unregister Agent
POST
Update Agent
POST
List Agents
POST
Query Agents Details
Agent Instance Management
POST
Create Agent Instance
POST
Create Digital Human Agent Instance
POST
Update Agent Instance
POST
Delete Agent Instance
Agent Instance Control
POST
Trigger LLM
POST
Trigger TTS
POST
Query The Status of An AI Agent Instance
POST
Interrupt Agent Instance
POST
Get Agent Instance Context
POST
Reset Agent Instance Context
Callback
Receiving Callback
Exception Event Codes
FAQ
On this page

SendAgentInstanceTTS

POST

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

This interface can be used to actively call the TTS service to send voice messages as the identity of the AI agent. Please refer to AI proactively speaking: proactive invocation of LLM and TTS for details and examples.

Request

Query Parameters

    Action stringrequired

    Possible values: [SendAgentInstanceTTS]

    API Prototype Parameter

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

    AppId uint32required

    💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.

    SignatureNonce stringrequired

    💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature sample code for how to generate.

    Timestamp int64required

    💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature sample code for how to generate, with a maximum error of 10 minutes.

    Signature stringrequired

    💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡Public parameter. Signature version number.

Body

required
    AgentInstanceId stringrequired

    The unique identifier of the AI agent instance, obtained through the response parameters of the Create AI Agent Instance interface.

    Text stringrequired

    Possible values: <= 300 characters

    The text content used for TTS, with a maximum of 300 characters.

    AddHistory boolean

    Default value: true

    Whether to record the text message in the conversation message history as input to the LLM.

    InterruptMode integerdeprecated

    Default value: 0

    (Deprecated) Please use Priority and SamePriorityOption parameters instead. The mode of interruption when the AI agent is speaking:

    • 0: Interrupt immediately. If the user speaks while the AI is speaking, the AI will be immediately interrupted and stop speaking (default). Please use Priority=Medium and SamePriorityOption=ClearAndInterrupt parameters instead.
    • 1: Do not interrupt. If the user speaks while the AI is speaking, the AI will not be affected until the content is finished. Please use Priority=High and SamePriorityOption=ClearAndInterrupt parameters instead.
    Priority string

    Possible values: [Low, Medium, High]

    Default value: Medium

    Task priority, the default value is Medium.

    SamePriorityOption string

    Possible values: [ClearAndInterrupt, Enqueue]

    Default value: ClearAndInterrupt

    The interruption strategy when the same priority occurs, the default value is ClearAndInterrupt. Optional values:

    1. ClearAndInterrupt：Clear and interrupt
    2. Enqueue：Queue up to wait, the maximum number of queues is 5

Responses​

Success
Schema
    Code integer

    Return code. 0 indicates success, other values indicate failure. For more information on error codes and response handling recommendations, please refer to Return Codes.

    Message string

    Explanation of the request result

    RequestId string

    Request ID

Previous

Trigger LLM

Next

Query The Status of An AI Agent Instance

On this page

Back to top