Use category callback

English

Use category callback

Article summary

Did you find this summary helpful?

Thank you for your feedback

VOD Station provides a callback feature to check the status of encoding requests.
You can use the callback feature by entering the callback endpoint in the notificationUrl field for Create category or Add category file.

Callback delivery data

If you register notificationUrl, the following type of data is sent to the set notificationUrl whenever a status change event occurs during encoding in VOD Station. (HTTP POST request)

Callbacks are sent separately for each encodingOptionId.
(E.g., If 3 encodingOptions are set in a category, callbacks are sent for each encodingOption status change.)

Note

For the input file path based on encoding status, the value of the filaPath field is sent as an empty string when the value of the status field is WAITING.

Field name	Type	Description
categoryId	Integer	Encoding category ID
categoryName	String	Encoding category name
encodingOptionId	Integer	Encoding option ID
fileId	Integer	Input file ID
filePath	String	Input file path
outputType	String	Output encoding option name
status	String	Input file encoding status

Callback delivery HTTP body example

{
  "categoryId":10268,
  "categoryName":"callback-test",
  "encodingOptionId":3,
  "fileId":10808,
  "filePath":"/.../Guide720_AVC_HD_1Pass_30fps.mp4",
  "outputType":"AVC_HD_1Pass_30fps",
  "status":"RUNNING"
}

Was this article helpful?

What's Next

Adding category file

Table of contents

Callback delivery data