NotifyAgent-阿里云帮助中心

NotifyAgent

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rtc:NotifyAgent

none

*App

acs:rtc::{#accountId}:app/{#AppId}

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	The application ID. Create and query it in the console. Only a single ID is supported.	aec****
ChannelId	string	No	The channel to join. Only a single ID is supported.	yourChannelId
TaskId	string	No	The task ID.	yourTaskId
Message	string	No	The text content to announce.	您好，现在是2025年4月16日，请问需要什么帮助
Priority	integer	No	The priority level for inserting the announcement: 1 — Interrupt the current interaction and announce immediately. 2 — Announce after the current interaction ends. 3 — Announce only if no interaction is active.	1
Interruptable	boolean	No	Indicates whether the announcement can be interrupted. If false, the message cannot be interrupted by voice input, key presses, or other methods.	true
CustomAttribute	string	No	Custom parameters passed through to the client.	{\"color\":\"blue\"}
BackgroundMusic	object	No	Background audio.
format	string	No	The audio format. wav	wav
url	string	No	The resource URL.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	760bad53276431c499e30dc36f6b26be

Examples

Success response

JSON format

{
  "RequestId": "760bad53276431c499e30dc36f6b26be"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.