Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

Use channel callback

Prev Next

Available in Classic and VPC

VOD Station provides a callback feature to check the channel status. When using callback, VOD Station automatically sends a callback message to the set notificationUrl whenever a channel status change event occurs. When requesting the following APIs, set the callback by entering the callback URL in notificationUrl.

Callback message

The following describes the callback message.
| Field | Type | Required | Description |
|--- |--- |--- |--- |
| id | String | - | Channel ID |
| name | String | - | Channel name |
| channelStatus | String | - | Channel status

  • READY | STARTING | STOPPING | STOPPED | FORCE_STOPPING | FORCE_STOPPED | TERMINATING | TERMINATED | FORCE_TERMINATING | FORCE_TERMINATED
    • READY: Running
    • STARTING: Starting
    • STOPPING: Stopping
    • STOPPED: Stopped
    • TERMINATING: Deleting
    • TERMINATED: Deleted
    • FORCE_STOPPING: Force stopping
    • FORCE_STOPPED: Force stopped
    • FORCE_TERMINATING: Force deleting
    • FORCE_TERMINATED: Force deleted
|

Callback message example

The example of a callback message is as follows:

// Channel running (READY)
{
  "id": "vs-20260414133728-*******",
  "name": “ch-callback”,
  "channelStatus": "READY"
}

// Channel stopped (STOPPED)
{
  "id": "vs-20260414133728-*******",
  "name": "ch-callback",
  "channelStatus": "STOPPED"
}

// Channel deleted (TERMINATED)
{
  "id": "vs-20260414133728-*******",
  "name": "ch-callback",
  "channelStatus": "TERMINATED"
}