Callback Integration
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.
- PlanEnterprise
Kollus VOD supports callback integration for cross-system automation across the entire workflow. When a specific event occurs, an HTTP request is sent to a designated URL, enabling real-time data synchronization with external systems (LMS, CMS, etc.).
When integrating a callback receiving server, you must verify the following two requirements.
- Traffic handling performance: The callback receiving server must be capable of reliably handling large volumes of request traffic without delay.
- Firewall allow settings: The network firewall must be configured to allow the Kollus server to properly access the specified callback server URL and its corresponding port.
Callback types
The callback types provided by Kollus VOD are as follows.
- Platform callback: Called upon completion of customer Kollus VOD console tasks (upload, transcoding, content management)
- Player callback: Called upon user actions (playback, download, playback progress rate, next episode transition)
Platform callback
The platform callback sends the results of tasks performed in the Kollus VOD console to a server.
- Developer guide: Platform Callback
- Configuration path
Callback type Description and configuration path Upload callback Sends a notification when content upload is complete - Configuration path: Kollus VOD console > [Settings] > [Callback] > [Upload callback URL]
- Note: Only one URL can be configured per workspace.
Transcoding callback Sends a notification when transcoding is complete - Configuration path: Kollus VOD console > [Settings] > [Callback] > [Transcoding callback URL]
- Note: Only one URL can be configured per workspace.
Content update callback Called when metadata is edited, content is deleted, or content is moved to another channel - Configuration path: Kollus VOD console > [Settings] > [Callback] > [Content update callback URL]
- Note: Only one URL can be configured per workspace.
Content channel addition callback Called when content is registered to a channel - Configuration path: Kollus VOD console > [Channel] > [More options] on the left channel list > [Callback settings] > [Content registration] tab > [Content channel addition callback URL]
- Note: Can be configured per channel.
Content channel deletion callback Called when content is removed from a channel - Configuration path: Kollus VOD console > [Channel] > [More options] on the left channel list > [Callback settings] > [Content registration] tab > [Content channel deletion callback URL]
- Note: Can be configured per channel.
Player callback
The player callback sends events occurring in the viewing environment in real time, and can be configured independently on a per-channel basis.
Playback callback
Called when a user attempts to play content.
- Developer guide: Playback Callback
- Configuration path: Kollus VOD console > [Channel] > [More options] on the left channel list > [Callback settings] > [Play/Download] tab > [Playback callback]
- Caution: The playback callback only works in a Kollus secure player environment.
DRM download callback
Called when a user requests a download for offline viewing.
- Developer guide: DRM Download Callback
- Configuration path: Kollus VOD console > [Channel] > [More options] on the left channel list > [Callback settings] > [Play/Download] tab > [DRM download callback]
- Caution: The DRM download callback only works in a Kollus secure player environment.
LMS callback
Periodically sends playback information to precisely measure a user's playback progress rate.
- Developer guide: LMS Callback
- Configuration path: Kollus VOD console > [Channel] > [More options] on the left channel list > [Callback settings] > [LMS] tab
- Configuration items
Item Description Number of blocks Number of logical segments 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 interval Time interval (in seconds) for sending data to the server Block information included Whether to include block information Session information included Whether to include session information (start point, playback time, etc.) Callback URL Customer server address to receive LMS data Plugin options Information to include in the callback (parameter keys can be edited, refer to Callback configuration information) LMS callback data Automatically generated when the above items are configured
Next episode callback
Preemptively retrieves information about the next episode during playback of series content to provide a seamless viewing experience.
- Developer guide: Next Episode Callback
- Prerequisites
- Console configuration: In Kollus VOD console > [Channel] > [More options] on the left channel list > [Callback settings] > [Next episode] tab, register the [Next Episode] button display timing and the callback URL
- Token configuration: Include the
"next_episode": trueparameter in the player call token (JWT) (see Basic options)
- Configuration items
Item Description Use next episode Whether to enable the continuous playback feature [Next Episode] button displayed {input}seconds before the content endsTime before the content ends to display the [Next Episode] button (if set longer than the content length, the button is displayed from the beginning of the content) Callback URL Customer server address to receive the callback Plugin options Information to include in the callback (parameter keys can be edited, refer to Callback configuration details) Next episode callback data Automatically generated when the above items are configured