调用GetMessageCallback查询事件通知的回调方式、回调地址、事件类型。

说明 详细使用说明,请参见事件通知开发指南

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetMessageCallback

系统规定参数。取值:GetMessageCallback

AppId String app-1000000

应用ID。不传时为系统默认应用的ID,取固定值:app-1000000

返回数据

名称 类型 示例值 描述
RequestId String 272A222A-F7F7-4A3E-****-F531574F1234

请求ID。

MessageCallback Object

事件通知配置。

CallbackType String HTTP

回调方式,取值:

  • HTTP
  • MNS
CallbackURL String http://test.com/test

回调方式选择HTTP时,回调地址。

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

回调事件类型。

AppId String app-1000000

应用ID。

MnsQueueName String vodcallback

回调方式选择MNS时,消息队列名称。

AuthKey String 12345678abc

回调方式选择HTTP时,鉴权Key。

AuthSwitch String on

回调方式选择HTTP时,回调鉴权开关,取值:

  • on(启用)
  • off(不启用)
MnsEndpoint String http://1234567.mns.cn-shanghai-internal.aliyuncs.com/

回调方式选择MNS时,消息队列公网Endpoint。

示例

请求示例

https://vod.{ApiRegion}.aliyuncs.com/?Action=GetMessageCallback
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

访问错误中心查看更多错误码。