SetMessageCallback - 设置事件通知配置

调用SetMessageCallback设置事件通知的回调方式、回调地址、事件类型。

接口说明

使用说明

支持HTTP回调和MNS回调。详细使用说明,请参见事件通知

QPS限制

本接口的单用户QPS限制为15次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

调试

授权信息

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

请求参数

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

回调方式,取值:

  • HTTP
  • MNS
HTTP
CallbackURLstring

回调地址。回调方式为HTTP时,需设置此参数。 回调地址URL的长度不能超过256个字节,不支持设置多个回调地址。

http://developer.aliyundoc.com
EventTypeListstring

回调事件类型,取值为空时关闭所有消息通知,取值为ALL时开启全部消息通知。也可指定开启某些消息通知,多个事件类型之间使用半角逗号(,)分隔。可设置的事件类型取值范围请参见:事件类型

说明所有AI相关事件即AIMediaAuditComplete、AIMediaDNAComplete等取值都为AIComplete
FileUploadComplete
AuthSwitchstring

HTTP回调的鉴权开关,回调方式设置为HTTP时,此参数有效。取值:

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

鉴权Key,最长32位,必须同时包含大小写字母和数字。回调方式为HTTP时,可设置此参数。

dsf346dvet
MnsEndpointstring

消息队列公网Endpoint,回调方式为MNS时,需设置此参数。可登录消息服务控制台,单击右上角的获取Endpoint按钮获取。更多信息,请参见Endpoint

http://****.mns.cn-shanghai.aliyuncs.com/
MnsQueueNamestring

消息队列名称,可登录消息服务控制台,在队列列表中查看。回调方式为MNS时,需设置此参数。

quene_name
AppIdstring

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

app-1000000

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求ID。

25818875-5F78-4AF6-D7393642CA58****

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=SetMessageCallback
&CallbackType=HTTP
&CallbackURL=http://developer.aliyundoc.com
&EventTypeList=FileUploadComplete
&AuthSwitch=on
&AuthKey=dsf346dvet
&AppId=app-1000000
&<公共请求参数>

正常返回示例

JSON格式

{
    "RequestId": "25818875-5F78-4AF6-D7393642CA58****"
}

XML格式

<SetMessageCallbackResponse>
    <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>
</SetMessageCallbackResponse>

错误码

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

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