HTTP一般イベント

HTTP一般イベントとは

SK VMS サーバーAPIは、第三者システムの標準API呼び出しセットを提供します。第三者システムはHTTP文字列の形式で標準API呼び出しを使用してSK VMSサーバーへイベントを送信できます。イベントが受信されると、さまざまなアクション(アラームレイアウトの起動、ブックマークの作成、PTZカメラの移動など)を動作させることができます。

HTTP一般イベントのパラメータ

HTTP一般イベントの発生はcreateEvent APIをHTTPリクエストすることで可能です。追加できるパラメータは下記のようになります。source,caption,descriptionのいずれかを指定すればリクエストは送信できます。

timestamp

イベントの日時を指定します。UTCミリ秒またはISO 8601フォーマットの人間が読むことのできる日時を指定します。timestampがない場合、現在のサーバーの日時が使用されます。

source

イベントのトリガーになったデバイス名を指定します。デバイス名ごとに異なるアクションをイベントルールに設定することで、デバイス名に応じたアクションを動作させることができます。

caption

短いイベントの説明を指定します。captionで指定した文字列ごとに異なるアクションをイベントルールに設定することで、captionに応じたアクションを動作させることができます。

description

長いイベントの説明を指定します。descriptionで指定した文字列ごとに異なるアクションをイベントルールに設定することで、descriptionに応じたアクションを動作させることができます。

metadata

追加情報を設定するパラメータです。例としてcameraRefsを指定すると、「通知を表示」のアクション動作時に、通知表示に対してカメラ表示のリンクが付きます。

※指定フォーマットの例:リンクさせるカメラのIDを指定します。
{“cameraRefs”:[“3A4AD4EA-9269-4B1F-A7AA-2CEC537D0248″,”3A4AD4EA-9269-4B1F-A7AA-2CEC537D0240”]}

state

録画のような長期的なアクションを使用する場合に、このパラメーターを指定する必要があります。Active/Inactiveを指定します。