All Products
Search
Document Center

ApsaraVideo VOD:GetMessageCallback

Last Updated:May 11, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vod:GetMessageCallbackRead
  • All Resources
    *
    none
none

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 Message Service (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
  • off
on
MnsEndpointstring

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.