通知接口

VCR 提供了通知回调功能,支持用户在创建视频、直播审核时配置通知,便于用户及时收到视频审核完成的消息和直播过程中审核发现的问题。

目前如果用户需要使用通知,需要首先登录管理控制台,配置通知回调地址和通知名称,当创建视频、直播审核时,您只需在请求参数或请求体中配置通知名称即可。

通知格式

如果用户在创建审核时配置了通知名称,那么

  • 在视频审核完成或审核失败时,VCR 会通知视频审核结果;
  • 在直播审核中发现问题,VCR会通知该问题的审核结果。

通过HTTP POST发送给用户创建通知时配置的回调地址。

回调语法

POST <notification_endpoint> HTTP/1.1

回调体

参数 类型 描述
messageId String 通知消息ID
messageBody String 通知消息,JSON串

用户可以使用常用的JSON库对messageBody进行解析,其格式和视频/直播审核结果查询结果一致。

回调示例

示例一:BOS视频回调

POST <notification_endpoint> HTTP/1.1
{
    "messageId": "message_id",
    "messageBody": "{\"source\": \"bos://testbucket/dir/video.mp4\",\"description\": \"desc\",\"status\": \"FINISHED\",\"createTime\": \"2017-03-22T12:00:00Z\",\"finishTime\": \"2017-03-22T12:06:48\",\"label\": \"REVIEW\",\"results\": [{\"type\": \"sexual_porn\",\"items\": [{\"subType\": \"behavior\",\"target\": \"audio\",\"startTimeInSeconds\": 0,\"confidence\": 68,\"label\": \"REVIEW\"}]}]}"
}

示例二:VOD媒资回调

POST <notification_endpoint> HTTP/1.1
{
    "messageId": "message_id",
    "messageBody": "{\"source\": \"vod://mda-fhepatsnpn4rk9z\",\"mediaId\": \"mda-fhepatsnpn4rk9z\",\"description\": \"desc\",\"status\": \"FINISHED\",\"createTime\": \"2017-03-22T12:00:00Z\",\"finishTime\": \"2017-03-22T12:06:48\",\"label\": \"REVIEW\",\"results\": [{\"type\": \"sexual_porn\",\"items\": [{\"subType\": \"behavior\",\"target\": \"audio\",\"startTimeInSeconds\": 0,\"confidence\": 68,\"label\": \"REVIEW\"}]}]}"
}

示例三:URL视频回调

POST <notification_endpoint> HTTP/1.1
{
    "messageId": "message_id",
    "messageBody": "{\"source\": \"http://test.domain.com/dir/video.mp4\",\"description\": \"desc\",\"status\": \"FINISHED\",\"createTime\": \"2017-03-22T12:00:00Z\",\"finishTime\": \"2017-03-22T12:06:48\",\"label\": \"REVIEW\",\"results\": [{\"type\": \"sexual_porn\",\"items\": [{\"subType\": \"behavior\",\"target\": \"audio\",\"startTimeInSeconds\": 0,\"confidence\": 68,\"label\": \"REVIEW\"}]}]}"
}

示例四:直播回调

POST <notification_endpoint> HTTP/1.1
{
    "messageId": "message_id",
    "messageBody": "{\"source\": \"rtmp://domain/app/stream\",\"type\": \"video\",\"status\": \"PROCESSING\",\"createTime\": \"2017-08-01T12:00:00Z\",\"label\": \"REVIEW\",\"results\": [{\"type\": \"sexual_porn\",\"items\": [{\"subType\": \"behavior\",\"target\": \"thumbnail\",\"liveTime\": \"2017-08-01T12:43:00Z\",\"confidence\": 68,\"label\": \"REVIEW\",\"evidence\": {\"thumbnail\": \"http://xx/xx.jpg\"}}]}]}"