通知接口
更新时间:2024-03-07
MCA 提供了通知回调功能,支持用户在创建视频分析/直播分析/封面分析/精彩视频分析时配置通知,便于用户及时收到分析完成的消息。
通知使用
- 登录管理控制台,配置通知回调地址和通知名称(注:当前支持创建5个通知地址,如果超过5个,请提交工单咨询);
- 创建视频分析/直播分析/封面分析/精彩视频分析时,请求体参数notification中配置通知名称,或通过MCA console创建视频分析时选择对应的通知名称。创建视频分析请求示例:
PUT /v1/media HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
"source": "https://vca-customer.baidu.com/media.mp4",
"preset": "customer_preset_name",
"notification": "customer_notification_name"
}
- 该任务结束(成功或失败)后,会通过用户配置的回调地址进行回调通知(3h内通知未成功会不断重试),回调内容为任务分析详情。
通知格式
回调语法
POST <notification_endpoint> HTTP/1.1
回调体
类型 | 描述 |
---|---|
String | 通知消息,JSON串 |
用户可以使用常用的JSON库对body进行解析,其格式和视频分析结果查询结果一致。
- 注:如需要在回调时增加鉴权,请发工单进行咨询与配置。
回调示例
示例:BOS视频回调
POST <notification_endpoint> HTTP/1.1
content-type: application/json;charset=UTF-8
{\"taskId\":\"***\",\"source\":\"bos://***\",\"title\":\"\",\"description\":\"14707441\",\"preset\":\"vca\",\"notification\":\"notify\",\"status\":\"FINISHED\",\"percent\":100,\"results\":[{\"type\":\"scenario\",\"result\":[{\"attribute\":\"其他-图片展示\",\"confidence\":24.88,\"source\":\"scenario_classify\",\"time\":[]}]}],\"createTime\":\"2019-08-07T08:26:06Z\",\"startTime\":\"2019-08-07T08:26:06Z\",\"durationInSecond\":16,\"publishTime\":\"2019-08-07T08:26:23Z\"}