Callback Notification Usage Guide

Feature Description

After video-related processing steps (such as upload, transcoding, review) are completed, the system submits the processing results to the configured callback URL to notify users of the progress and status, enabling further business operations.

Callback Configuration

Log in to the Cloud Video on Demand management backend, go to Settings --> Callback Settings to configure the callback URL.

Event Types

The currently supported event notification types are as follows:

1. Video Upload Complete

After the VOD server finishes receiving the uploaded video file, a video upload complete event is generated. HTTP request method: GET.

Event Content

Callback Example

http://demo.ipolyv.cn/callback?sign=b245e3e65aa45b60dc02337b5cd914a7&type=upload&vid=e2e84a738302f20a4f6eb202976f5c63_e

2. Async Upload Processing Failure

This event is generated when the video synchronization feature of the management backend or an asynchronous upload method fails during processing.

Upon receiving this callback, it indicates that the remote video upload failed. Please check the source video's URL address.

HTTP request method: GET.

Event Content

Callback Example

http://demo.ipolyv.cn/callback?sign=c2f168b96d882c1a03f1021c29208916&fileUrl=http://a.mp4&type=async_upload&title=test

3. Video Sync Failure

After a video is successfully uploaded, the system needs to sync the source video file from the edge node back to the central node. This event is generated if the sync fails.

HTTP request method: GET.

Event Content

Callback Example

http://demo.ipolyv.cn/callback?sign=b245e3e65aa45b60dc02337b5cd914a7&type=videoSyncedFail&vid=e2e84a738302f20a4f6eb202976f5c63_e

4. Single Definition Transcoding Complete

This event is generated when transcoding for a specific definition (e.g., HD mp4 format) of a video format is complete.

A video can be played once any definition is transcoded and passes review (the video status will be updated to "Published". If transcoding for other definitions is not yet complete, the player will automatically select the completed definition).

HTTP request method: GET.

Event Content

Callback Example

http://demo.ipolyv.cn/callback?sign=f6a7f9b3dce47c4c8d5bfbc96af79720&type=encode&format=mp4&vid=e2e84a738302f20a4f6eb202976f5c63_e&df=1

5. All Definitions Transcoding Complete

This event is generated when transcoding for all definitions of a video is complete.

Due to the large amount of returned content, the request method for this callback is POST.

Event Content

videoInfos is an array, each video stream's information fields are as follows

Callback Example

Content-Type：application/json
Request URL：http://demo.ipolyv.cn/callback?sign=f6a7f9b3dce47c4c8d5bfbc96af79720
HTTP POST Body：
{
  "eventType": "TranscodeComplete",
  "status": "success"
  "vid": "812a792458101ebf5ff6a1e5e76e1c58_8",
  "videoInfos": [
    {
      "duration": 883,
      "df": 1,
      "size": 15499011,
      "format": "mp4",
      "bitrate": 256,
      "resolution": "480x360",
      "status": "success"
    },
    {
      "duration": 883,
      "df": 2,
      "size": 27574109,
      "format": "mp4",
      "bitrate": 512,
      "resolution": "848x636",
      "status": "success"
    }
  ]
}

6. Video Review Complete

After any definition of a video is transcoded, it must pass intelligent review or manual review. Only videos that pass review can be played. This event is generated when the review is complete.

HTTP request method: GET.

Event Content

Callback Example

http://demo.ipolyv.cn/callback?type=pass&vid=e2e84a738302f20a4f6eb202976f5c63_e&sign=8ebb91d444ce53fafa3256670fb65d84

7. Video Deletion Complete

This event is generated when a video file is moved to the recycle bin or permanently deleted from the recycle bin.

HTTP request method: POST.

Event Content

Callback Example

Content-Type：application/json
Request URL：http://demo.ipolyv.cn/callback?sign=f6a7f9b3dce47c4c8d5bfbc96af79720
HTTP POST Body：
{
  "eventType": "DeleteMediaComplete",
  "operateTime": "2020-01-20 07:49:17",
  "operator": "aaa@polyv.net",
  "status": "success",
  "deleteType": "MoveToTrash",
  "vids": "e2e84a738302f20a4f6eb202976f5c63_e,e2e84a738302f20a4f6eb202976f5c63_f"
}

8. Video Content Security Review Failed

This event is generated when AI intelligent scanning detects confirmed or suspected violating content in a video.

HTTP request method: POST.

Event Content

Scan result information:

Callback Example

Content-Type：application/json
Request URL：http://demo.ipolyv.cn/callback?sign=6c5b14548fb9c06ee1b987debf88f639
HTTP POST Body：
{
  "eventType": "AIContentScanNotPassed",
  "scanSource": "video",
  "vid": "8205ac89d3699e1fc08cd8f9b8486748",
  "scanResults": [
    {
      "imageUrl": "http://img.videocc.net/uimage/8/8205ac89d3/8/8205ac89d3699e1fc08cd8f9b8486748_0_b.jpg",
      "scene": "porn",
      "label": "sexy",
      "suggestion": "block",
      "rate": 93.26
    }
  ]
}

9. Courseware Conversion Complete

This event is generated when the conversion of uploaded courseware (PPT, PDF files) to images is complete.

HTTP request method: POST.

Event Content

Converted image information:

Callback Example

Content-Type：application/json
Request URL：http://demo.ipolyv.cn/callback?sign=de9d5652a5682718c5662499c5e4e5bb
HTTP POST Body：
{
  "eventType": "CoursewareConvertComplete",
  "status": "success",
  "vid": "f13e995735d99df23a7728be335e7a41_f",
  "convertedImages": [
    {
      "pageNo": 1,
      "pageTitle": "第一页的标题",
      "pageImage": "https://doc-oss.polyv.net/images/2020/04/b0a8a0ed3425c117e6552cd027b6eb4b31243c9/b0a8a0e6d3425c117e6552cd027b6eb4b31243c9_0000.jpeg",
      "pageThumbnail": "https://doc-oss.polyv.net/images/2020/04/b0a8a0ed3425c117e6552cd027b6eb4b31243c9/b0a8a0e6d3425c117e6552cd027b6eb4b31243c9_0000_s.jpeg"
    },
    {
      "pageNo": 2,
      "pageTitle": "第二页的标题",
      "pageImage": "https://doc-oss.polyv.net/images/2020/04/b0a8a0ed3425c117e6552cd027b6eb4b31243c9/b0a8a0e6d3425c117e6552cd027b6eb4b31243c9_0001.jpeg",
      "pageThumbnail": "https://doc-oss.polyv.net/images/2020/04/b0a8a0ed3425c117e6552cd027b6eb4b31243c9/b0a8a0e6d3425c117e6552cd027b6eb4b31243c9_0001_s.jpeg"
    }
  ]
}