イベントアラーム設定
- 印刷する
- PDF
イベントアラーム設定
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Live Stationで発生する一部のイベントを SMSまたは Eメールを通じて受信できる APIです。提供されるイベントは、イベントリスト照会 APIで確認できます。
参考
イベント通知の設定
- APIを通じて Generalチャンネルの一部のイベントを SMSまたは Eメールを通じて受信できます。
- APIによるイベントアラーム設定は SMS、Eメールのいずれか1つのみサポートします。
- アラーム設定のために、以下の3つの APIをリクエストします。
- 管理者グループリストの照会
- 管理者グループ詳細の照会
- イベント通知の設定
- 管理者グループリストの照会と管理者グループ詳細の照会は、通知対象者照会を通じて照会および修正できます。
- 受信タイプの修正が必要な場合、3) イベントアラーム設定で修正できます。
リクエスト
管理者グループリストの照会
GET https://livestation.apigw.ntruss.com/api/v2/notification/manager-groups
管理者グループ詳細の照会
GET https://livestation.apigw.ntruss.com/api/v2/notification/manager-groups/{manageGroupNo}
イベント通知の設定
POST https://livestation.apigw.ntruss.com/api/v2/notification/{channelId}/for-general-channel
イベントアラーム設定リクエストボディ
| フィールド名 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| alertOn | Yes | Boolean | リクエストチャンネルのアラーム設定 | |
| alertVodUploadFail | Optional | Boolean | 録画ファイルのアップロード失敗時、アラーム送信 | |
| alertChangeStatus | Optional | Boolean | チャンネル状態変更時、アラーム送信 | |
| alertGeneralChannelError | Optional | Boolean | チャンネルエラー発生時、アラーム送信 | |
| alertShortClipFail | Optional | Boolean | ショートクリップ作成に失敗時、アラーム送信 | |
| alertStreamFailOver | Optional | Boolean | メインストリームの移行時、アラーム送信 | |
| notificationManagerList[] | Yes | Object[] | アラーム通知対象の詳細情報 | |
| notificationManagerList[].emailAddress | No | String | notifyTypeが Eメールの場合に入力 | |
| notificationManagerList[].cellPhoneNo | No | Integer | notifyTypeが SMSの場合に入力 | |
| notificationManagerList[].managerNo | Yes | Integer | アラーム通知対象 | |
| notificationManagerList[].notifyType | Yes | String | SMS、Eメール | SMSまたは Eメール |
リクエストヘッダ
| ヘッダ名 | 要否 | 説明 |
|---|---|---|
| x-ncp-apigw-timestamp | YES | - 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表す - API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | YES | NAVERクラウドプラットフォームポータルから発行された Access Key ID値x-ncp-iam-access-key:{Sub Account Access Key} |
| x-ncp-apigw-signature-v2 | YES | Access Key ID値と Secret Keyで暗号化した署名x-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | YES | Request body content typeを application/jsonに指定Content-Type: application/json |
イベントアラーム設定リクエストレスポンス
| フィールド名 | タイプ | 説明 | 備考 |
|---|---|---|---|
| channelId | String | ||
| alertOn | Boolean | ||
| alertChangeStatus | Boolean | ||
| alertVodUploadFail | Boolean | ||
| alertGeneralChannelError | Boolean | ||
| alertShortClipFail | Booelan | ||
| alertStreamFailOver | Booelan | ||
| alertReStreamFail | Boolean | ||
| reStreamFailThreshold | Integer | ||
| updatedTime | Timestamp | epoch time |
例
リクエスト例
POST /api/v2/notification/ls-20220623115623-fHnXy/for-general-channel
HOST: livestation.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
{
"alertOn": true,
"alertShortClipFail": true,
"notificationManagerList": [
{
"emailAddress": "navercloud_livestation@navercorp.com",
"managerNo": 7112,
"notifyType": "EMAIL"
}
]
}
POST /api/v2/notification/ls-20220623115623-fHnXy/for-general-channel
HOST: livestation.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
{
"alertOn": true,
"alertShortClipFail": true,
"notificationManagerList": [
{
"cellPhoneNo": "01012345678",
"managerNo": 7112,
"notifyType": "SMS"
}
]
}
レスポンス例
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 28 Jun 2022 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
{
"content": {
"channelId": "ls-20220623115623-fHnXy",
"alertOn": true,
"alertChangeStatus": false,
"alertVodUploadFail": false,
"alertReStreamFail": false,
"alertShortClipFail": false,
"alertStreamFailOver": true,
"reStreamFailThreshold": 2,
"alertGeneralChannelError": false,
"updatedTime": 1671527899089
}
}
この記事は役に立ちましたか?