Skip to main content

Callback Integration

Notice

This document is a machine-translated draft and is currently undergoing review. Some content may be inaccurate or differ from the original Korean version. For the most precise information, refer to the Korean documentation.

Kollus VOD supports Callback integration for automation between systems throughout the workflow. When a specific event occurs, an HTTP request is sent to a designated URL, allowing real-time data synchronization with external systems (LMS, CMS, etc.).

Caution

The callback receiving server must be in a stable environment capable of handling large volumes of traffic.


Callback types

The callback types provided by Kollus VOD are as follows.

  • Platform callback: Called when customer Kollus VOD console operations (upload, transcoding, content management) are completed
  • Player callback: Called when user actions occur (playback, download, playback progress rate, next episode transition)

platform callback

The platform callback sends the results of operations performed in the Kollus VOD console to the server.

Network settings

You must ensure that the firewall is configured to allow requests from Kollus servers on the port of the callback server URL you entered.

  • Configuration path
    Callback typeDescription and configuration path
    Upload callbackSends a notification when content upload is complete
    • Configuration path: Kollus VOD console > [Service account] > [Callback] > [Upload callback URL]
    • Note: Only one URL can be set per service account.
    Transcoding callbackSends a notification when transcoding is complete
    • Configuration path: Kollus VOD console > [Service account] > [Callback] > [Transcoding callback URL]
    • Note: Only one URL can be set per service account.
    Content update callbackCalled when metadata is modified, content is deleted, or content is moved to another channel
    • Configuration path: Kollus VOD console > [Service account] > [Callback] > [Content update callback URL]
    • Note: Only one URL can be set per service account.
    Content channel addition callbackCalled when content is registered to a channel
    • Configuration path: Kollus VOD console > [Channel] > Left channel list or channel card [More options] > [Callback settings] > [Content registration] tab > [Content channel addition callback URL]
    • Note: Can be configured per channel.
    Content channel deletion callbackCalled when content is removed from a channel
    • Configuration path: Kollus VOD console > [Channel] > Left channel list or channel card [More options] > [Callback settings] > [Content registration] tab > [Content channel deletion callback URL]
    • Note: Can be configured per channel.
  • Developer guide: Platform callback

�phrase0�back

The player callback sends events occurring in the viewing environment in real time, and can be configured independently per channel.

Network settings

You must ensure that the firewall is configured to allow requests from Kollus servers on the port of the callback server URL you entered.

playback callback

Called when a user attempts to play content.

  • Configuration path: Kollus VOD console > [Channel] > Left channel list or channel card [More options] > [Callback settings] > [Play/Download] tab > [Playback callback]
  • Notes: The playback callback only works in the Kollus secure player environment.
  • Developer guide: Playback callback

DRM download callback

Called when a user requests a download for offline viewing.

  • Configuration path: Kollus VOD console > [Channel] > Left channel list or channel card [More options] > [Callback settings] > [Play/Download] tab > [DRM download callback]
  • Notes: The DRM download callback only works in the Kollus secure player environment.
  • Developer guide: DRM download callback

LMS callback

Periodically transmits playback information to precisely measure the user's playback progress rate.

  • Configuration path: Kollus VOD console > [Channel] > Left channel list or channel card [More options] > [Callback settings] > [LMS] tab
  • Configuration items
    ItemDescription
    Number of blocksNumber of logical sections into which the video is divided
    Example: If the number of blocks for a 300-second video is set to 10, each block will be 30 seconds long.
    Transfer intervalTime interval for sending data to the server (sec)
    Block information includedWhether to include block information
    Session information includedWhether to include session information (start time, playback duration, etc.)
    Callback URLThe customer's server address to receive LMS data
    Plugin optionsInformation to include in the callback (parameter keys can be modified; refer to LMS Callback - Callback Configuration)
    LMS callback dataAutomatically generated when the above items are configured
  • Developer guide: LMS callback

next episode callback

Pre-fetches information about the next episode during series content playback to provide a seamless viewing experience.

  • Prerequisites
    • Console settings: Register the display timing of the [Next Episode] button and the callback URL in Kollus VOD console > [Channel] > Left channel list or channel card [More options] > [Callback settings] > [Next episode] tab
    • Token settings: Include the "next_episode": true parameter in the player call token (JWT) (See Also: Unified JWT Specifications - Basic Options)
  • Configuration items
    ItemDescription
    Use next episodeWhether to enable the continuous playback feature
    [Next Episode] button displayed N seconds before the content endsThe time before the video ends to display the [Next Episode] button (if set longer than the video length, the button is displayed from the beginning of the video)
    Callback URLThe customer's server address to receive the callback
    Plugin optionsInformation to include in the callback (parameter keys can be modified; refer to Next Episode Callback - Callback Configuration)
    Next episode callback dataAutomatically generated when the above items are configured
  • Developer guide: Next episode callback