通知接口
更新时间：2022-07-01
MMS 提供了通知回调功能，支持用户在“视频入库"、“视频检索”时配置通知，便于用户及时收到视频入库/检索完成的消息。
通知使用
- 配置通知：请提交工单，在工单中提供“回调地址”，由百度智能云客服帮您配置通知名。
- 发起视频入库或视频搜索时，在请求体参数notification中，传入通知名称。
视频入库请求示例：
PUT /v{version}/videolib/{libName}
host: mms.bj.baidubce.com
Authorization: <bce-authorization-string>
{
"source": videoUrl,
"description": desc,
"notification": notificationName
}视频搜索请求示例：
POST /v{version}/videolib/{libName}?searchByVideo
host: mms.bj.baidubce.com
Authorization: <bce-authorization-string>
{
"source": videoUrl,
"description": desc,
"notification": notificationName
}- 该视频入库或搜索结束后，会通过用户配置的回调地址进行回调通知，回调内容为视频入库或视频搜索详情。如果3h内通知未成功，会不断重试。
通知格式
回调语法
POST <notification_endpoint> HTTP/1.1回调体
| 字段名 | 类型 | 描述 |
|---|---|---|
| messageId | String | 通知消息ID |
| messageBody | String | 通知消息内容，JSON串 |
用户可以使用常用的JSON库对body进行解析，其格式和视频入库或视频搜索结果查询结果一致。
回调示例
示例1：视频入库完成回调
POST <notification_endpoint> HTTP/1.1
content-type: application/json;charset=UTF-8
{
"messageId": "a114f8e1-0de0-473f-9f6c-d47e33df5d7d",
"messageBody": "{\"taskId\":\"n7CCcHIBTmikKXpp-AS8\",\"status\":\"success\",\"source\":\"http://bj.bcebos.com/v1/bucket/test.mp4\",\"duration\":6.5,\"description\":\"\",\"createTime\":\"2020-06-01T15:32:11Z\",\"startTime\":\"2020-06-01T15:32:11Z\",\"updateTime\":\"2020-06-01T15:32:13Z\",\"finishTime\":\"2020-06-01T15:32:13Z\"}"
}示例2：视频搜索完成回调
POST <notification_endpoint> HTTP/1.1
content-type: application/json;charset=UTF-8
{
"messageId": "360d15ea-14ae-440e-9be1-f1f431beae19",
"messageBody": "{\"taskId\":\"ybjMcnIBFaqg3FXUVQrA\",\"status\":\"success\",\"lib\":\"video_lib\",\"source\":\"https://bj.bcebos.com/v1/bucket/test.mp4\",\"duration\":6.5,\"description\":\"\",\"createTime\":\"2020-06-02T02:11:33Z\",\"startTime\":\"2020-06-02T02:12:05Z\",\"updateTime\":\"2020-06-02T02:12:08Z\",\"finishTime\":\"2020-06-02T02:12:08Z\",\"results\":[{\"id\":\"n7CCcHIBTmikKXpp-AS8\",\"name\":\"search_hit.mp4\",\"source\":\"http://bj.bcebos.com/v1/bucket/search_hit.mp4\",\"duration\":6.5,\"description\":\"\",\"type\":\"SEARCH_VIDEO_BY_VIDEO\",\"score\":100,\"clips\":[{\"inputStartTime\":0.0,\"inputEndTime\":6.5,\"outputStartTime\":0.0,\"outputEndTime\":6.5}]}]}"
}