Event Notification Callback Settings Overview - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries the callback method, callback URL, and event types of event notifications.

Operation description

Note

For more information, see Event notification development guide.

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

vod:GetMessageCallback

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	The application ID. If this parameter is not specified, the ID of the system default application is used. The fixed value is app-1000000.	app-1000000

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	272A222A-F7F7-4A3E-****-F531574F1234
MessageCallback	object	The event notification configuration.
CallbackType	string	The callback method. Valid values: HTTP MNS	HTTP
CallbackURL	string	The callback URL when the callback method is set to HTTP.	http://test.com/test
EventTypeList	string	The callback event types.	FileUploadComplete,StreamTranscodeComplete,TranscodeComplete,SnapshotComplete,AIComplete,AddLiveRecordVideoComplete,CreateAuditComplete,UploadByURLComplete,ProduceMediaComplete,LiveRecordVideoComposeStart,ImageUploadComplete,VideoAnalysisComplete
AppId	string	The application ID.	app-1000000
MnsQueueName	string	The name of the MSMQ when the callback method is set to MNS.	vodcallback
AuthKey	string	The authentication key when the callback method is set to HTTP.	12345678abc
AuthSwitch	string	The callback authentication switch when the callback method is set to HTTP. Valid values: on: enabled. off: disabled.	on
MnsEndpoint	string	The public endpoint of the MSMQ when the callback method is set to MNS.	http://1234567.mns.cn-shanghai-internal.aliyuncs.com/

Examples

Success response

JSON format

{
  "RequestId": "272A222A-F7F7-4A3E-****-F531574F1234",
  "MessageCallback": {
    "CallbackType": "HTTP",
    "CallbackURL": "http://test.com/test",
    "EventTypeList": "FileUploadComplete,StreamTranscodeComplete,TranscodeComplete,SnapshotComplete,AIComplete,AddLiveRecordVideoComplete,CreateAuditComplete,UploadByURLComplete,ProduceMediaComplete,LiveRecordVideoComposeStart,ImageUploadComplete,VideoAnalysisComplete",
    "AppId": "app-1000000",
    "MnsQueueName": "vodcallback",
    "AuthKey": "12345678abc",
    "AuthSwitch": "on",
    "MnsEndpoint": "http://1234567.mns.cn-shanghai-internal.aliyuncs.com/"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.