GetMessageCallback - 查询事件通知配置

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

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppIdstring

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

app-1000000

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

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

事件通知配置。

CallbackTypestring

回调方式,取值:

  • HTTP
  • MNS
HTTP
CallbackURLstring

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

http://test.com/test
EventTypeListstring

回调事件类型。

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

应用ID。

app-1000000
MnsQueueNamestring

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

vodcallback
AuthKeystring

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

12345678abc
AuthSwitchstring

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

  • on(启用)
  • off(不启用)
on
MnsEndpointstring

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

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

示例

请求示例

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

正常返回示例

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

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>

错误码

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

阿里云首页 视频点播 相关技术圈