チャンネルの作成

Prev Next

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

同時配信チャンネルを作成します。

リクエスト

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

メソッド URI
POST /api/v2/re-stream/channels

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
channelName String Required チャンネル名
  • 英数字、記号の「_」を使用して3~20文字以内で入力
planType String Required 料金プランタイプ
  • STANDARD | PROFESSIONAL
    • STANDARD: 最大3つのプラットフォームに同時配信
    • PROFESSIONAL: 最大5つのプラットフォームに同時配信
envType String Optional チャンネルタイプ
  • REAL (デフォルト) | DEV | STAGE
  • 適用するサービス環境に応じた区切り文字
restream Array Required 同時配信プラットフォームリスト: restream

restream

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

フィールド タイプ 必須の有無 説明
targetName String Required 同時配信プラットフォーム名
  • YOUTUBE | CHZZK | STEAM | YOUNOW | USTREAM | AFREECATV | PRISM | CUSTOM
rtmpUrl String Required 同時配信プラットフォーム RTMP URL
streamKey String Required 同時配信プラットフォームのストリームキー
id String Optional RTMP認証 ID
  • 認証設定が必要な場合、表示
password String Optional RTMP認証パスワード
  • 認証設定が必要な場合、表示

リクエスト例

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

curl --location --request POST 'https://livestation.apigw.ntruss.com/api/v2/re-stream/channels' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR' \
--data '{
    "channelName": "channel001",
    "planType": "STANDARD",
    "envType": "REAL",
    "restream": [
        {
            "targetName": "YOUTUBE",
            "rtmpUrl": "rtmp://rtmp-test.youtube.com",
            "streamKey": "****-****-****-****-****",
            "id": "user000",
            "password": "dbwj@@@123"
        },
        {
            "targetName": "PRISM",
            "rtmpUrl": "rtmp://abc.com",
            "streamKey": "****-****-****-****-****",
            "id": "user001",
            "password": "dbwj@@!456"
        }
    ]
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
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.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.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-20250819******-Ik1QU",
        "channelName": "channel001",
        "instanceNo": 1082*****,
        "channelStatus": "READY",
        "streamKey": "zg******************************",
        "publishUrl": "rtmp://***********.video.media.ntruss.com:8080/relay",
        "planType": "STANDARD",
        "createdTime": 1755571786244,
        "restream": [
            {
                "id": "user000",
                "rtmpUrl": "rtmp://rtmp-test.youtube.com",
                "streamKey": "****-****-****-****-****",
                "password": "dbwj@@@123",
                "targetName": "YOUTUBE"
            },
            {
                "id": "user001",
                "rtmpUrl": "rtmp://abc.prism.com",
                "streamKey": "****-****-****-****-****",
                "password": "dbwj@@!456",
                "targetName": "PRISM"
            }
        ],
        "platformCount": 2,
        "totalPublishSeconds": 0,
        "alertOn": false,
        "isPublishing": false,
        "envType": "REAL"
    }
}