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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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.