Instructs an AI agent to immediately broadcast a text message and supports interruption settings.
Operation description
You can call this operation to instruct an AI agent to broadcast the content that you specify. You can determine whether this broadcast can immediately interrupt the ongoing speech. The interruption is allowed by default.
Note
- Make sure that the
InstanceId
is valid and corresponds to an existing AI agent. - The content of
Text
must comply with the specifications and does not contain sensitive or inappropriate information. - If you do not want the new broadcast to interrupt the ongoing speech, you must set
EnableInterrupt
tofalse
.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ice:SendAIAgentSpeech | none | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
EnableInterrupt | boolean | No | Specifies whether the broadcast can interrupt the ongoing speech. Default value: true | true |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}
Error codes
For a list of error codes, visit the Service error codes.