同時配信プラットフォームの更新

Prev Next

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

同時配信チャンネルに設定されたプラットフォームの情報を更新します。

参考

配信中は、同時配信プラットフォーム情報を更新できません。配信を完了してから更新してください。

リクエスト

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

メソッド URI
PUT /api/v2/re-stream/channels/{channelId}/platforms/{platformId}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
channelId String Required チャンネル ID
platformId Integer Required 同時配信プラットフォーム ID

リクエストボディ

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

フィールド タイプ 必須の有無 説明
rtmpUrl String Required 同時配信プラットフォーム RTMP URL
  • 更新しない場合は、既存の値を入力
streamKey String Required 同時配信プラットフォームのストリームキー
  • 更新しない場合は、既存の値を入力
streamId String Optional RTMP認証 ID
  • 認証設定が必要な場合、表示
streamPassword String Optional RTMP認証パスワード
  • 認証設定が必要な場合、表示

リクエスト例

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

curl --location --request PUT 'https://livestation.apigw.ntruss.com/api/v2/re-stream/channels/ls-20250819******-Ik1QU/platforms/3699' \
--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 '{
    "rtmpUrl": "rtmp://rtmp-test1234.youtube.com",
    "streamKey": "****-****-****-****-****",
    "streamId": "user002",
    "streamPassword": "dbwj@@@789"
}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "content": {
        "targetName": "YOUTUBE",
        "rtmpUrl": "rtmp://rtmp-test1234.youtube.com",
        "id": "user002",
        "password": "d*****",
        "streamKey": "****-****-****-****-****",
        "platId": 3699
    }
}