DescribeNotifyConfig-阿里云帮助中心

Operation description

Retrieves the event callback configuration for a specified AIAgent.

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

ice:DescribeNotifyConfig

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AIAgentId	string	Yes	The ID of the AIAgent.	39f8e0bc005e4f309379701645f4****

Response elements

Element	Type	Description	Example
	object	The response body.
CallbackUrl	string	The URL where event callbacks are sent.	http://customer.com/callback
EnableNotify	boolean	Indicates whether notifications are enabled.	true
EventTypes	string	The event types. If you do not specify this parameter, all event types are selected by default. `agent_start`: The agent is ready. `agent_stop`: The agent is stopped. `error`: The task encountered an error. Valid values: agent_start : agent_start error : error agent_stop : agent_stop	agent_start,agent_stop,error
Token	string	The authentication token used to verify the callback. This token is included in the `Authorization` field of the request header for each event callback.	eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx
AudioOssPath	string
EnableAudioRecording	boolean
RequestId	string	The unique identifier for the request.	7B117AF5-2A16-412C-B127-FA6175ED1AD0

Examples

Success response

JSON format

{
  "CallbackUrl": "http://customer.com/callback",
  "EnableNotify": true,
  "EventTypes": "agent_start,agent_stop,error",
  "Token": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
  "AudioOssPath": "",
  "EnableAudioRecording": false,
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.