文档

GetMessageCallback - 查询事件通知配置

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

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:GetMessageCallbackRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
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/

示例

正常返回示例

JSON格式

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

错误码

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