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

使用说明

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

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值:SetMessageCallback

CallbackType String HTTP

回调方式,取值:

  • HTTP
  • MNS
CallbackURL String http://developer.aliyundoc.com

回调地址。回调方式为HTTP时,需设置此参数。

EventTypeList String FileUploadComplete

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

说明 所有AI相关事件即AIMediaAuditComplete、AIMediaDNAComplete等取值都为AIComplete
AuthSwitch String on

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

  • on(启用)
  • off(不启用)
AuthKey String dsf346dvet

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

MnsEndpoint String http://****.mns.cn-shanghai-internal.aliyuncs.com/

消息队列公网Endpoint,回调方式为MNS时,需设置此参数。

MnsQueueName String quene_name

消息队列名称,回调方式为MNS时,需设置此参数。

AppId String app-1000000

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

返回数据

名称 类型 示例值 描述
RequestId String 25818875-5F78-4AF6-D7393642CA58****

请求ID。

示例

请求示例

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

正常返回示例

XML格式

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

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

JSON格式

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

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

错误码

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