Callback Endpointの登録(Re-Stream)

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

同時配信(Re-Stream)チャンネルのイベントを受信するコールバックエンドポイントを登録します。

参考

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

リクエスト

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

メソッド	URI
POST	/api/v2/re-stream/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/re-stream/channels/ls-20250826******-172v4/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.channelStatus`	String	-	チャンネルの状態 `CREATING` \| `READY` \| `PUBLISHING` \| `DELETED` \| `BLOCK` \| `FORCE_BLOCK` \| `FORCE_DELETED` `CREATING`: 作成中 `READY`: 準備完了 `PUBLISHING`: 配信中 `DELETED`: 返却 `BLOCK`: 停止 `FORCE_BLOCK`: 強制停止 `FORCE_DELETED`: 使用不可
`content.streamKey`	String	-	ストリームキー
`content.publishUrl`	String	-	基本配信 URL
`content.globalPublishUrl`	String	-	海外配信 URL
`content.planType`	String	-	料金プランタイプ `STANDARD` \| `PROFESSIONAL` `STANDARD`: 最大3つのプラットフォームに同時配信 `PROFESSIONAL`: 最大5つのプラットフォームに同時配信
`content.createdTime`	Integer	-	チャンネル作成日時(ミリ秒) Unix Timestamp形式
`content.restream`	Array	-	同時配信プラットフォーム情報: restream
`content.platformCount`	Integer	-	同時配信プラットフォーム数
`content.totalPublishSeconds`	Integer	-	チャンネルの使用時間(秒)
`content.alertOn`	Boolean	-	イベントアラームを設定するか `true` \| `false` `true`: 設定 `false`: 設定しない
`content.isPublishing`	Boolean	-	配信中か `true` \| `false` `true`: 配信中 `false`: 配信中ではない
`content.alertOptions`	Object	-	イベントアラームを設定
`content.alertOptions.alertChangeStatus`	Boolean	-	同時配信用チャンネル状態変更アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`content.alertOptions.alertVodUploadFail`	Boolean	-	録画ファイルアップロード失敗アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`content.alertOptions.alertReStreamFail`	Boolean	-	同時配信リレー失敗アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`content.alertOptions.reStreamFailThreshold`	Integer	-	アラーム発生条件(基準の回数) アラーム初回設定前の場合、表示しない
`content.alertOptions.alertStreamFailOver`	Boolean	-	メインストリーム切り替えアラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`content.callbackEndpoint`	String	-	コールバックエンドポイント URL
`content.envType`	String	-	チャンネルタイプ `REAL` \| `DEV` \| `STAGE`

`restream`

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

フィールド	タイプ	必須の有無	説明
`id`	String	-	RTMP認証 ID 認証情報設定時に表示
`rtmpUrl`	String	-	同時配信プラットフォーム RTMP URL
`streamKey`	String	-	同時配信プラットフォームのストリームキー
`password`	String	-	RTMP認証のパスワード認証情報設定時に表示先頭文字を除く文字列はマスキング処理
`targetName`	String	-	同時配信プラットフォーム名

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

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

レスポンス例

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

{
    "content": {
        "channelId": "ls-20250826******-172v4",
        "channelName": "nat",
        "instanceNo": 10*****75,
        "channelStatus": "READY",
        "streamKey": "tkhimahll***********************",
        "publishUrl": "rtmp://***********.video.media.ntruss.com:8080/relay",
        "globalPublishUrl": "rtmp://***************.video.media.ntruss.com:8080/relay",
        "planType": "STANDARD",
        "createdTime": 1756175988000,
        "restream": [
            {
                "id": "user002",
                "rtmpUrl": "rtmp://rtmp-test1234.youtube.com",
                "streamKey": "*************",
                "password": "q*****",
                "targetName": "YOUTUBE"
            }
        ],
        "platformCount": 1,
        "totalPublishSeconds": 0,
        "alertOn": false,
        "isPublishing": false,
        "alertOptions": {
            "alertChangeStatus": false,
            "alertVodUploadFail": false,
            "alertReStreamFail": false,
            "alertStreamFailOver": false
        },
        "callbackEndpoint": "https://www.callback-endpoint.com",
        "envType": "REAL"
    }
}