Receive IMS Event Notifications via SetEventCallback API - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

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:SetEventCallback

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CallbackType	string	No	The callback method. Valid values: HTTP MNS Valid values: MNS : MNS HTTP : HTTP	HTTP
CallbackQueueName	string	No	The name of the Simple Message Queue (SMQ) queue in the region. The name must start with ice-callback-.	ice-callback-queue
CallbackURL	string	No	The callback URL. This parameter is required if you set CallbackType to HTTP. The callback URL cannot exceed 256 bytes in length. You can specify only one callback URL.	http://xxx.yyy/callback
EventTypeList	string	No	The type of the callback event. You can specify multiple values separated with commas (,). ProduceMediaComplete: indicates that the editing and production task is complete.	ProduceMediaComplete
AuthSwitch	string	No	Specifies whether to enable callback authentication. This parameter takes effect only if you set CallbackType to HTTP. Valid values: on off Valid values: off : off on : on	on
AuthKey	string	No	The authentication key. The key can be up to 32 characters in length and must contain uppercase letters, lowercase letters, and digits. This parameter takes effect only if you set CallbackType to HTTP.	TestKey001

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
Success	boolean	Indicates whether the configuration was successful. Valid values: true and false.	true

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.