调用SetMessageCallback设置事件通知的回调方式、回调地址、事件类型。
使用说明
支持HTTP回调和MNS回调。详细使用说明,请参见事件通知。
QPS限制
本接口的单用户QPS限制为15次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | SetMessageCallback |
系统规定参数。取值:SetMessageCallback。 |
CallbackType | String | 否 | HTTP |
回调方式,取值:
|
CallbackURL | String | 是 | http://developer.aliyundoc.com |
回调地址。回调方式为HTTP时,需设置此参数。 回调地址URL的长度不能超过256个字节,不支持设置多个回调地址。 |
EventTypeList | String | 否 | FileUploadComplete |
回调事件类型,取值为空时关闭所有消息通知,取值为ALL时开启全部消息通知。也可指定开启某些消息通知,多个事件类型之间使用半角逗号(,)分隔。可设置的事件类型取值范围请参见:事件类型。 说明 所有AI相关事件即AIMediaAuditComplete、AIMediaDNAComplete等取值都为AIComplete。
|
AuthSwitch | String | 否 | on |
HTTP回调的鉴权开关,回调方式设置为HTTP时,此参数有效。取值:
|
AuthKey | String | 否 | dsf346dvet |
鉴权Key,最长32位,必须同时包含大小写字母和数字。回调方式为HTTP时,可设置此参数。 |
MnsEndpoint | String | 否 | http://****.mns.cn-shanghai.aliyuncs.com/ |
消息队列公网Endpoint,回调方式为MNS时,需设置此参数。可登录消息服务控制台,单击右上角的获取Endpoint按钮获取。更多信息,请参见Endpoint。 |
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
&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****"
}
错误码
访问错误中心查看更多错误码。