GetMessageCallback - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the callback method, callback URL, and event type for event notifications.

Operation description

Note For more information, see Event notification.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- The required resource types are displayed in bold characters.
- 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
vod:GetMessageCallback	get	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	272A222A-F7F7-4A3E-****-F531574F1234
MessageCallback	object	The configuration of the event notification.
CallbackType	string	The callback method. Valid values: HTTP MNS	HTTP
CallbackURL	string	The callback URL. This parameter is returned only for HTTP callbacks.	http://test.com/test
EventTypeList	string	The type of the callback event.	FileUploadComplete,StreamTranscodeComplete,TranscodeComplete,SnapshotComplete,AIComplete,AddLiveRecordVideoComplete,CreateAuditComplete,UploadByURLComplete,ProduceMediaComplete,LiveRecordVideoComposeStart,ImageUploadComplete,VideoAnalysisComplete
AppId	string	The ID of the application.	app-1000000
MnsQueueName	string	The name of the Message Service (MNS) queue. This parameter is returned only for MNS callbacks.	vodcallback
AuthKey	string	The cryptographic key. This parameter is returned only for HTTP callbacks.	12345678abc
AuthSwitch	string	Indicates whether callback authentication is enabled. This parameter is returned only for HTTP callbacks. Valid values: on off	on
MnsEndpoint	string	The public endpoint of MNS. This parameter is returned only for MNS callbacks.	http://1234567.mns.cn-shanghai-internal.aliyuncs.com/

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.