logologo
售前咨询
点播云
服务端API
回调配置
文档中心
服务端API回调配置查询消息回调配置

查询消息回调配置


1. 请求参数

字段

类型

是否必填

示例

描述

Action

String

GetMessageCallbackList

公共参数,创建空间回调配置信息,取值:GetMessageCallbackList

SpaceName

String

setljfselfa

空间名称。不传值查询默认空间

2. 返回参数

参数名称

类型

描述

MessageCallbackList

Array of MessageCallback

空间对应的回调配置

MessageCallback

参数名称

类型

描述

CallbackSetType

String

回调设置类型,取值:

  • Global(全局回调设置)
  • Single(单事件回调设置)

默认为Global

CallbackEventSet

Array of String

开启回调的事件列表,当CallbackSetType为Global时:

  • 不传该字段时保持原设置,只做增量更新;
  • 传值为空字符串""时关闭所有消息通知;
  • 传值为"*"时开启全部消息通知;
  • 也可指定开启部分事件的消息通知,多个事件类型使用半角逗号(,)分隔。

当CallbackSetType为Single时,则只能传入一个事件类型

当前支持的事件类型包括:

  • FetchUploadEvent:拉取上传完成事件
  • VideoTranscodeEvent:转码完成事件
  • SnapshotByTimeOffsetEvent:指定时间点截图事件
  • ImageSpriteEvent:雪碧图事件
  • VideoMetaEvent:解析视频元信息事件
  • ProcessingFlowEvent:任务流完成事件
  • SegmentBodyEvent:人像分割事件

CallbackSecret

String

回调鉴权密钥

CallbackType

String

回调类型,支持类型:

http:http回调

CallbackURL

String

回调地址

3. API示例

3.1 请求示例

curl -X POST 'https://vod.streamlakeapi.com/?Action=GetMessageCallbackList' \
-H 'Content-Type: application/json' \
-d '{"SpaceName": "23rjewofjsf"}'
-H <公共请求参数>

3.2 返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
"ResponseMeta": {
"RequestId": "rB0zK2IQhEgAAAAAAAUWkw",
"ErrorCode": "",
"ErrorMessage": ""
}, "ResponseData": {
"MessageCallbackList": [
"SpaceName": "sdfsdw3r32",
"CallbackSecret": "",
"CallbackURL": "test.callback.com/callback",
"CallbackType": "Global",
"CallbackEventSet": ""
]
}
}

4. 错误码

ErrorCode

ErrorMessage

说明

状态码

ResourceNotFound

Space does not exist

空间不存在

404

上一篇:设置消息回调配置下一篇:删除消息回调配置
该篇文档内容是否对您有帮助?
有帮助没帮助