Callback Endpointの登録(VOD2LIVE)

Prev Next

Classic/VPC環境で利用できます。

VOD2LIVEチャンネルのイベントを受信するコールバックエンドポイントを登録します。

参考

コールバック送信データと送信動作の詳細は、Callback Enpointの登録をご参照ください。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v2/vod/channels/{channelId}/callbackEndpoint

リクエストヘッダ

Live Station APIで共通して使用されるヘッダの詳細は、Live Stationのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
channelId String Required チャンネル ID

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
callbackEndpoint String Required コールバックエンドポイント URL

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://livestation.apigw.ntruss.com/api/v2/vod/channels/ls-20250820******-FdJkJ/callbackEndpoint' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json' \
--data '{
    "callbackEndpoint": "https://www.callback-endpoint.com"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
content Object - チャンネル情報
content.channelId String - チャンネル ID
content.channelName String - チャンネル名
content.instanceNo Integer - チャンネルインスタンス番号
content.qualitySetId Integer - 画質設定 ID
content.qualitySetName String - 画質設定名
content.outputProtocol String - Output Protocol
content.channelStatus String - チャンネルの状態
  • CREATING | READY | PUBLISHING | DELETED | BLOCK | RESERVED | FORCE_BLOCK | FORCE_DELETED
    • CREATING: 作成中
    • READY: 準備完了
    • PUBLISHING: 配信中
    • DELETED: 返却
    • BLOCK: 停止
    • RESERVED: 配信予約
    • FORCE_BLOCK: 強制停止
    • FORCE_DELETED: 使用不可
content.cdn Object - CDNの設定
content.cdn.instanceNo String - CDNインスタンス ID
content.cdn.serviceName String - CDNサービス名
content.cdn.statusName String - CDNの状態
  • RUNNING | PUBLISHING | STOPPING | STOPPED | CREATING | CHANGING | CDN_NOT_FOUND
content.cdn.cdnType String - CDNタイプ
  • GLOBAL_CDN | GLOBAL_EDGE
content.cdn.cdnDomain String - CDNサービスドメイン
content.cdn.profileId Integer - Global Edgeのプロファイル ID
content.cdn.regionType String - Global Edgeのサービス地域
content.totalPublishSeconds Integer - チャンネルの使用時間(秒)
content.createdTime Integer - チャンネル作成日時(ミリ秒)
  • Unix Timestamp形式
content.updatedTime Integer - チャンネル更新日時(ミリ秒)
  • Unix Timestamp形式
content.alertOn Boolean - イベントアラームを設定するか
  • true | false
    • true: 設定
    • false: 設定しない
content.recentPublishTime Integer - 直近の配信開始日時(ミリ秒)
  • Unix Timestamp形式
  • 初回配信前の場合、表示しない
content.alertOptions Object - イベントアラームを設定
content.alertOptions.alertChangeStatus Boolean - チャンネル状態変更アラームを適用するか
  • true | false
    • true: 適用
    • false: 適用しない
content.callbackEndpoint String - コールバックエンドポイント URL
content.envType String - チャンネルタイプ
  • DEV | STAGE | REAL
content.type String - チャンネルの種類
  • VOD
content.scheduleList Array - スケジュールリスト: scheduleList
content.drmEnabledYn Boolean - Multi DRMの使用
  • true | false
    • true: 使用
    • false: 使用しない
content.drm Object - Multi DRM設定
  • content.drmEnabledYnがtrueの場合、配下の情報を表示
content.drm.siteId String - サイト ID
content.drm.contentId String - コンテンツ ID

scheduleList

scheduleListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
scheduleId Integer - スケジュール ID
status String - スケジュールの状態

レスポンスステータスコード

Live Station APIで共通して使用されるレスポンスステータスコードの詳細は、Live Stationのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "content": {
        "channelId": "ls-20250820******-FdJkJ",
        "channelName": "vl2_mychannel2",
        "instanceNo": 10******1,
        "qualitySetId": 4,
        "qualitySetName": "720p-set",
        "outputProtocol": "HLS",
        "channelStatus": "RESERVED",
        "cdn": {
            "instanceNo": "11577",
            "serviceName": "edge-ls-20250814*******-PZohi",
            "statusName": "RUNNING",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "*************.edge.naverncp.com",
            "profileId": 4207,
            "regionType": "KOREA"
        },
        "totalPublishSeconds": 0,
        "createdTime": 1755664159000,
        "updatedTime": 1755752406000,
        "alertOn": false,
        "alertOptions": {
            "alertChangeStatus": false
        },
        "callbackEndpoint": "https://www.callback-endpoint.com",
        "envType": "REAL",
        "type": "VOD",
        "scheduleList": [
            {
                "scheduleId": 1296,
                "status": "READY"
            }
        ],
        "drmEnabledYn": false
    }
}