イベントアラームの設定

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

一般のライブチャンネルでイベント発生時、管理者に SMSまたはメールアラームが送信されるように設定します。

参考

イベントアラームの設定時、次の内容をご確認ください。

NAVERクラウドプラットフォームコンソールではなく、APIでイベントアラームを設定する場合、SMSまたはメールのいずれかの受信タイプにのみ設定できます。
受信タイプを変更するには、改めて APIを呼び出してください。

リクエスト

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

メソッド	URI
POST	/api/v2/notification/{channelId}/for-general-channel

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`channelId`	String	Required	チャンネル ID チャンネルリストの照会を参照

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`alertOn`	Boolean	Required	イベントアラームを設定するか `true` \| `false` `true`: 設定 `false`: 設定しない
`alertChangeStatus`	Boolean	Optional	チャンネル状態変更アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`alertVodUploadFail`	Boolean	Optional	録画ファイルアップロード失敗アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`alertReStreamFail`	Boolean	Optional	同時配信リレー失敗アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`alertShortClipFail`	Boolean	Optional	ショートクリップ作成失敗アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`alertStreamFailOver`	Boolean	Optional	メインストリーム切り替えアラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`alertGeneralChannelError`	Boolean	Optional	配信失敗エラーアラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`notificationManagerList`	Array	Required	通知対象リスト: notificationManagerList

`notificationManagerList`

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

フィールド	タイプ	必須の有無	説明
`emailAddress`	String	Conditional	管理者のメールアドレス `notifyType`が`EMAIL`の場合、必ず入力
`cellPhoneNo`	String	Conditional	管理者の携帯電話番号 `notifyType`が`SMS`の場合、必ず入力
`managerNo`	Integer	Required	管理者番号管理者の照会を参照
`notifyType`	String	Required	受信タイプ `EMAIL` \| `SMS`

リクエスト例

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

curl --location --request POST 'https://livestation.apigw.ntruss.com/api/v2/notification/ls-20250814******-zTwK2/for-general-channel' \
--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-raw '{
    "alertOn": true,
    "alertChangeStatus": true,
    "alertVodUploadFail": true,
    "alertReStreamFail": false,
    "alertShortClipFail": true,
    "alertStreamFailOver": true,
    "alertGeneralChannelError": true,
    "notificationManagerList": [
        {
        "emailAddress": "ghdrlfehd@navercloud.com",
        "cellPhoneNo": "01012345678",
        "managerNo": ******,
        "notifyType": "SMS"
        }
    ]
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`content`	Object	-	レスポンス結果
`content.channelId`	String	-	チャンネル ID
`content.alertOn`	Boolean	-	イベントアラームを設定するか `true` \| `false` `true`: 設定 `false`: 設定しない
`content.alertChangeStatus`	Boolean	-	チャンネル状態変更アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`content.alertVodUploadFail`	Boolean	-	録画ファイルアップロード失敗アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`content.alertReStreamFail`	Boolean	-	同時配信リレー失敗アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`content.alertShortClipFail`	Boolean	-	ショートクリップ作成失敗アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`content.alertStreamFailOver`	Boolean	-	メインストリーム切り替えアラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`content.reStreamFailThreshold`	Integer	-	アラーム発生条件(基準回数)
`content.alertGeneralChannelError`	Boolean	-	配信失敗エラーアラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`content.updatedTime`	Integer	-	更新日時(ミリ秒) Unix Timestamp形式

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

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

レスポンス例

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

{
    "content": {
        "channelId": "ls-20250814******-zTwK2",
        "alertOn": true,
        "alertChangeStatus": true,
        "alertVodUploadFail": true,
        "alertReStreamFail": false,
        "alertShortClipFail": true,
        "alertStreamFailOver": true,
        "reStreamFailThreshold": 2,
        "alertGeneralChannelError": true,
        "updatedTime": 1755762842073
    }
}