MENU
      Use category callback

        Use category callback


        Article summary

        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 nameTypeDescription
        categoryIdIntegerEncoding category ID
        categoryNameStringEncoding category name
        encodingOptionIdIntegerEncoding option ID
        fileIdIntegerInput file ID
        filePathStringInput file path
        outputTypeStringOutput encoding option name
        statusStringInput 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"
        }
        Plain text

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.