All Products
Search
Document Center

ApsaraVideo VOD:GetMessageCallback

Last Updated:Nov 09, 2022

Queries the callback method, callback URL, and event type of an event notification.

Operation Description

NoteFor more information, see Overview.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
vod:GetMessageCallbackRead
  • VOD
    acs:vod:*:{#accountId}:*/*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringNo

The ID of the application. If you do not set this parameter, the default value app-1000000 is used.

app-1000000

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

272A222A-F7F7-4A3E-****-F531574F1234
MessageCallbackobject

The configuration of the event notification.

CallbackTypestring

The callback method. Valid values:

  • HTTP
  • MNS
HTTP
CallbackURLstring

The callback URL. This parameter is returned only for HTTP callbacks.

http://test.com/test
EventTypeListstring

The type of the callback event.

FileUploadComplete,StreamTranscodeComplete,TranscodeComplete,SnapshotComplete,AIComplete,AddLiveRecordVideoComplete,CreateAuditComplete,UploadByURLComplete,ProduceMediaComplete,LiveRecordVideoComposeStart,ImageUploadComplete,VideoAnalysisComplete
AppIdstring

The ID of the application.

app-1000000
MnsQueueNamestring

The name of the MNS queue. This parameter is returned only for MNS callbacks.

vodcallback
AuthKeystring

The cryptographic key. This parameter is returned only for HTTP callbacks.

12345678abc
AuthSwitchstring

Indicates whether callback authentication is enabled. This parameter is returned only for HTTP callbacks. Valid values:

  • on: indicates that authentication is enabled.
  • off: indicates that authentication is disabled.
on
MnsEndpointstring

The public endpoint of Message Service (MNS). This parameter is returned only for MNS callbacks.

http://1234567.mns.cn-shanghai-internal.aliyuncs.com/

Example

Normal return example

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 API error center.