アラーム連携

コアプラットフォーム
alarm_integrations_connections_write外部連携

施設を監視パートナーのテンプレートに接続し、その接続を管理します。保存(テンプレート、アカウント番号、ゾーンマップ、イベント、施設フィールド)、削除、承認のリクエスト、テスト信号の送信、テスト成功後の有効化、ステージングされた変更の破棄を行えます。

稼働中の接続(active または failing)は applyMode を指定した場合にのみ変更されます。staged はステージングしたテストが成功して有効化するまでアラームを現在の設定のままにし、immediate はすぐに適用します。シークレットフィールドは受け付けますが、返されることはありません。施設での External Integrations の権限が必要です。まず alarm_integrations_read の connections で確認してください。

アクション:

  • save: 接続を保存します。新しい接続には templateId が必要です。fields はキーごとに施設フィールドを設定します(null で解除、シークレットは封印されます)。稼働中の接続では applyMode を渡してください。渡さないと apply-mode-required で失敗します。partnerId が必要です。確認を求めます。
  • remove: 接続を削除します。施設とパートナーの接続を、ステージングされた変更も含めて削除します。以降、この施設からのアラームはその監視センターに送られなくなります。partnerId が必要です。確認を求めます。
  • request_approval: 承認をリクエストします。監視センターに接続の承認またはアカウント番号の割り当てを依頼します(パートナー承認テンプレート)。partnerId が必要です。
  • send_test_signal: テスト信号を送信します。監視センターへの実際のテスト信号をキューに入れます。test_signal_status をポーリングしてください。staged: true の場合は、現在の設定ではなくステージングされた変更をテストします。partnerId が必要です。確認を求めます。
  • activate: 接続または変更を有効化します。保留中の接続を稼働させる、ステージングされた変更を昇格させる、または未テストの変更を確定します。有効化には、最後の変更以降に成功したテストの requestId が必要です。ステージングしたテスト(staged: true)はステージングされた変更を昇格させ、稼働中のテストは未テストの変更を確定します。partnerId、requestId が必要です。確認を求めます。
  • discard_pending_change: ステージングされた変更を破棄します。ステージングされた変更を取り消します。現在の設定は変更されません。何もステージングされていなかった場合、discarded は false です。partnerId が必要です。確認を求めます。

パラメーター

名前種類説明
action*"save" | "remove" | "request_approval" | "send_test_signal" | "activate" | "discard_pending_change"実行する操作です。各操作はツールの説明に記載されています。
facilityIdstring施設 ID。接続中の施設が対象の場合は省略できます。
partnerIdstring監視パートナー。alarm_integrations_read の connections から取得します(組織独自のテンプレートの場合は org#<id>)
templateIdstringこの施設に提供されている公開済みテンプレート(save)
linkingIdentifierstringnull監視センターがこの施設を識別するアカウント番号(save)
zoneMapobjectnullボタンのシリアル番号からゾーンへの対応。例: { "DS-0001": "001" }(save)
eventsarraynullパートナーに送信するイベントタイプ(null: テンプレートの設定)(save)
fieldsobjectキーごとの施設フィールドの値。null で解除します。返されることはありません。(save)
applyMode"staged" | "immediate"稼働中の接続の場合: staged(テストしてから有効化)または immediate(save)
stagedbooleanステージングされた変更をテストします(有効化の前に必要)(send_test_signal)
requestIdstringsend_test_signal から取得したテスト信号のリクエスト ID(tsr_...)(activate)
confirmboolean最初の呼び出しで返されたプレビューをユーザーが確認した後にのみ設定します
alarm_integrations_destinations_write外部連携Duress Configuration

施設(既定)、ブランド、組織単位でカスタムのアラーム送信先を追加、変更、削除し、テスト送信します。送信先には独自の監視受信機、リレーボード、SMS、音声、メール、Webhook、チームチャット、オンコール呼び出しサービス(チャネル一覧)があります。

シークレット以外の設定は config に、シークレット(パスワード、Webhook URL、キー)は設定パスごとに fields に入れます。シークレットは封印され、返されることはありません。有効な送信先には完全な config が必要です。施設の送信先にはその施設での External Integrations または Duress Configuration の権限が、ブランドと組織の送信先には組織全体へのアクセス権が必要です。まず alarm_integrations_read の destinations で確認してください。

アクション:

  • save: 送信先を保存します。connectionId がなければ追加し(channel と name が必要)、あれば変更します(channel は変わりません)。config を送信すると、シークレット以外の設定が置き換えられます。fields で省略したシークレットは保持されます。確認を求めます。
  • remove: 送信先を削除します。施設のリレーの場合は、アラームリレーの駆動も停止します。connectionId が必要です。確認を求めます。
  • send_test_signal: 送信先にテストを送信します。送信先への実際のテストメッセージをキューに入れます。施設を指定して alarm_integrations_read の test_signal_status をポーリングしてください。ブランドと組織の送信先は facilityId からテストされます。connectionId が必要です。確認を求めます。

パラメーター

名前種類説明
action*"save" | "remove" | "send_test_signal"実行する操作です。各操作はツールの説明に記載されています。
facilityIdstring施設 ID。接続中の施設が対象の場合は省略できます。
ownerScopestringfacility#<id>、brand#<id>、org#<id> のいずれか(既定: 施設)
connectionIdstring変更する送信先。追加する場合は省略します
channel"cid-csvip" | "sentinel-http" | "relay" | "sms" | "voice" | "email" | "webhook" | "slack" | "teams" | "google-chat" | "pagerduty" | "opsgenie"送信先の種類。作成後は変更できません(save)
namestring設定と配信ログに表示されます(save)
enabledboolean新しい送信先の既定値は true(save)
eventsarraynull受信するイベントタイプ(null: チャネルの既定値)(save)
guestLink"shared" | "none" | "null"SMS、メール、チームチャットのチャネルのみ: shared(閲覧専用のアラームページ1つ、既定)または none(save)
configobjectチャネルのシークレット以外の設定(save)
fieldsobjectパスごとのシークレット設定。例: { "webhookUrl": "https://..." }。null で解除します(save)
confirmboolean最初の呼び出しで返されたプレビューをユーザーが確認した後にのみ設定します
alarm_integrations_read外部連携Duress Configuration

施設の緊急アラームが Performance Hub の外部のどこに送られるかを読み取ります。監視センターとの接続(パートナー、テンプレート、アカウント番号、ゾーンマップ、ステータス、稼働準備の不足、ステージングされた変更)、施設・ブランド・組織のカスタム送信先(監視受信機、リレー、SMS、音声、メール、Webhook、チャット、呼び出し)、ルーティングのプレビュー、配信ログ、テスト信号の結果を確認できます。

施設での External Integrations または Duress Configuration の権限が必要です。シークレットと封印された値は表示されず、{ key, secret, hasValue } のみが表示されます。個人の電話番号とアドレスはルーティングと配信から伏せられます。時刻は ISO 形式です。変更は alarm_integrations_connections_write と alarm_integrations_destinations_write で行います。

アクション:

  • connections: 監視センターとの接続。施設のパートナー接続: テンプレート、アカウント番号(linkingIdentifier)、ゾーンマップ、イベント、connectionStatus、missing(稼働を妨げている項目)、pendingChange(ステージング済みで未稼働)、untestedChange。canEdit: この施設での External Integrations の権限。
  • destinations: カスタム送信先。施設に対して送信される可能性のある送信先(施設自身、そのブランド、組織のもの。それぞれ canEdit 付き)、または ownerScope を指定した場合はそのスコープのもの。設定は config に、シークレットは fields { key, secret, hasValue } として表示されます。
  • routing: ルーティングのプレビュー。universal-api が解決するとおりに、現時点でアラームがどこに送られるか(現在の設定のみ)を示します: lane、イベント、シークレットを除いた config を含む送信先、除外された理由を説明する problems、まだルーティングされていない pendingChanges。eventType を指定すると、そのイベントを受信するものだけが残ります。
  • deliveries: 配信ログ。アラームの配信を新しい順に表示します(ステータス、チャネル、受信者、遅延、公開用のエラー文言)。フィルターしたページは件数が少なくても nextCursor を持つことがあります。デバイスアラートは kind alert として表示されます。
  • test_signal_status: テスト信号の結果。universal-api が試行を記録するまでは queued、その後は配信行とともに succeeded(受信者が確認応答した、または送信された)または failed になります。テストを送信した施設を使用してください。requestId が必要です。

パラメーター

名前種類説明
action*"connections" | "destinations" | "routing" | "deliveries" | "test_signal_status"実行する操作です。各操作はツールの説明に記載されています。
facilityIdstring施設 ID。接続中の施設が対象の場合は省略できます。
limitinteger1ページあたりの件数(既定 25、最大 100)(connections、destinations、deliveries)
cursorstring前のページの nextCursor(connections、destinations、deliveries)
ownerScopestringこのスコープのみ: brand#<id> または org#<id>(destinations)
eventTypestring例: ph.duress.incident.created(routing、deliveries)
fromstringISO 形式の日時。この日時を含みます(deliveries)
tostringISO 形式の日時。この日時を含みません(deliveries)
statusarraysent、acknowledged、failed、shadow のいずれか(deliveries)
channelstring完全一致するチャネル。例: cid-csvip、sms(deliveries)
destinationIdstring完全一致する送信先 ID(deliveries)
incidentIdstring1つのアラームの配信(deliveries)
requestIdstring1つのテスト信号の配信(deliveries、test_signal_status)
searchstringID、チャネル、エラーのいずれかに含まれるテキスト(deliveries)