11. WebSocketによるアラート展開結果のプッシュに関連するインターフェース

11.1 WebSocketでアラート展開の結果をプッシュするためのキーQuery

インターフェースの説明

インターフェースのURL	https://${ip}:${port}/api/json
リクエストメソッド	POST
リクエストパラメーター形式	JSON
インターフェースの説明	WebSocketでアラート展開の結果をプッシュするためのキーをQueryします。

リクエストパラメーター

パラメーター	型	説明	必須	例
msg_id	string	“1286”	Yes

レスポンスパラメーター

パラメーター	型	説明
code	int	結果コード（0：成功）
data	json	戻りデータ
msg	string	結果の説明

フィールド情報(データ)

パラメーター	型	説明
key	string	サブスクリプションキー

リクエストの例

{
    "msg_id":"1286"
}

レスポンスの例

{
    "code": 0,
    "data": {
        "key": "04af251e-91d4-43bd-b8b0-8c8c6b3245bb"
    },
    "msg": ""
}

11.2 アラートの展開結果をWebSocketでプッシュ

インターフェースの説明

インターフェースのURL	ws://${ip}:${port}/ws/
インターフェースの説明	アラートの展開結果をWebSocketでプッシュします。

リクエストパラメーター

パラメーター	型	説明	必須	例
msg_id	string	“776”	Yes
key	string	サブスクリプション・キー	Yes

レスポンスパラメーター

パラメーター	型	説明
code	int	結果コード（0：成功）
data	json	戻りデータ
msg_id	string	777（画像プッシュメッセージの一意の識別子）
msg	string	結果の説明

フィールド情報(データ)

パラメーター	型	説明
camera_name	string	カメラ名
device_id	string	デバイスID
channel	int	チャンネル 値の範囲：SenseNebula Basicでは[1,16]、SenseNebula Professionalでは[1,32]
threshold	int	比較の閾値（カメラバウンド） 値の範囲：[0,100］.
img_id	string	データベースに登録されている一致した顔情報のID
img	string	ソースデータベース内の画像（base64トランスコード）
img_path	string	ソースデータベース内の画像のパス 画像をダウンロードする際には、以下のようにURLを連結してください： https://${ip}:${port}/ws/img_path
lib_id	int	データベースID
lib_name	string	データベース名
lib_type	int	データベースの種類 1：要注意リストデータベース、2：登録者リストデータベース
person_addr	string	住所
person_age	string	年齢
person_gender	string	性別 0：女性 1：男性
person_idcard	string	属性コード
person_name	string	氏名
position	string	カメラ位置
ranking	int	一致度ランキング
similarity	int	一致度スコア 値の範囲：[0,100］ 初期値は-1
quality	int	品質スコア 値の範囲：[0,100］
pos_top	int	左上に位置する顔情報のY座標
pos_bottom	int	右下に位置する顔情報のY座標
pos_left	int	左上に位置する顔情報のX座標
pos_right	int	右下に位置する顔情報のX座標
snap_id	string	キャプチャーID
snap_buf	string	顔／全身のキャプチャ画像（base64トランスコード）
snap_feat	string	キャプチャーの特徴
snap_path	string	キャプチャーパス 画像をダウンロードする際のURLを、以下のように連結してください。 https://${ip}:${port}/ws/snap_path
snap_frame	string	顔/全身の画像に対応した大きなシーン（base64トランスコード）
trigger	string	トリガー時間
obj_label	int	ラベル 1：顔情報 2：全身
alive_type	int	Aliveタイプ 0：不明 1：非Alive 2：Alive
biometric_attr	json	Obj_label=1の顔属性 詳細は付録B参照
body_attr	json	Obj_label=2の全身属性 詳細は付録C参照
alarm_type	int	顔認識アラートの種類 0：アラートなし 1：要注意リスト/登録者リストアラート 2：未登録者アラート 3：未登録者DBヒットアラート
appear_count	int	現在の発生件数
event_type	int	イベントアラートの種類 0：アラートなし 1：徘徊アラート 2：ステイイングアラート
wander_channels	string	徘徊アラート用に設定された徘徊の場所
wander_thresHold	int	発生数の閾値
wander_deviceID	string	徘徊アラートのトリガー箇所
wander_trigger	string	徘徊アラートの徘徊時間
stranger_appear_channel	int	キャプチャーされた徘徊未登録者のカメラチャンネル

プッシュ結果では、img、snap、snap_frameはbase64トランスコードされています。ソースデータベースの画像をダウンロードするには、img_pathに基づいてダウンロードURLを連結します。キャプチャーをダウンロードするには、snap_pathに基づいてダウンロードURLを連結します。

リクエストの例

{
    "key":"7410342e-e4e8-47de-a92f-2fd918eb3d6a",
    "msg_id":"776"
}

レスポンスの例

{
    "code": 0,
    "msg": ""
}
{
    "code": 0,
    "data": {
        "camera_name": "test",
        "device_id": "123",
        "channel": 1,
        "img_id": "3c370627-d082-4c53-b156-e9380163d22f",
        "img_path": "img/12_3c370627-d082-4c53-b156-e9380163d22f.jpg",
        "lib_id": 12,
        "lib_name": "Marry",
        "lib_type": 1,
        "person_addr": "SH",
        "person_age": "",
        "person_gender": "",
        "person_idcard": "123",
        "person_name": "1201020000000589932",
        "position": "",
        "ranking": 1,
        "similarity": 38,
        "quality":1,
        "pos_top":1000,
        "pos_bottom":100,
        "pos_left":100,
        "pos_right":1000,
        "snap_buf": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/==",
        "snap_feat": "315.000000,32.000000,",
        "snap_id": "5672fb61-74ab-4037-8a37-a3c0abf417a3",
        "snap_path": "record/5672fb61-74ab-4037-8a37-a3c0abf417a3.jpg",
        "threshold": 60,
        "trigger": "2019-01-24 14:09:21",
        "snap_frame":"data:image/jpeg;base64,/8b/6BBAZXUYTRABAQAAAQABAAD/==",
        "obj_label":1,
        "alive_type": 2,
        "biometric_attr": {
            "cap_style": "hat_style_type_none",
            "gender_code": "female",
            "glass_style": "glasses_style_type_none",
            "mustache_style": "mustache_style_type_none",
            "st_respirator": "st_respirator_mouth",
            "respirator_color": "color_type_none",
            "st_age": "st_adult",
            "st_age_value": "26.000000",
            "st_expression": "st_angry"
        },
    },
    "msg": "",
    "msg_id": "777"
}

11.3 WebSocketによる車両メッセージ送信のインターフェース

インターフェースの説明

インターフェースのURL	ws://${ip}:${port}/ws/
インターフェースの説明	WebSocketによる車両メッセージ送信のインターフェース

リクエストパラメーター

パラメーター	型	説明	必須	例
msg_id	string	“776”	Yes
key	string	subscribe key	Yes

レスポンスパラメーター

パラメーター	型	説明
code	int	エラーコード（0：成功）
data	json	結果データ
msg_id	string	“777”（メッセージUUID）
msg	string	結果の説明

フィールド情報(データ)

パラメーター	型	説明
camera_name	string	カメラ名
device_id	string	デバイスID
channel	int	チャンネル SenseNebula Basic： [1,12], SenseNebula Professional： [1,24]
position	string	カメラ位置
threshold	int	予約済み 類似度の閾値：[0,100]
notify	int	アラートメッセージか？ 0：No 1：Yes
img_id	string	データベースに登録されているナンバープレートのうち、キャプチャされたナンバープレートと同じ番号を持つナンバープレートのUUID
img_path	string	予約済み
img	string	予約済み
lib_id	int	データベースID
lib_name	string	データベース名
owner_age	string	オーナーの年齢
owner_gender	string	オーナーの性別 0：女性 1：男性
owner_idcard	string	オーナーのIDカード
owner_name	string	オーナー名
is_vip	int	VIPか？ 0：No 1：Yes
quality	int	品質スコア 値の範囲：[0,100］
pos_top	int	境界ボックスの上部
pos_bottom	int	境界ボックスの下部
pos_left	int	境界ボックスの左側
pos_right	int	境界ボックスの右側
vehicle_num_left	int	車両画像内のナンバープレートの座標
vehicle_num_top	int	車両画像内のナンバープレートの座標
vehicle_num_right	int	車両画像内のナンバープレートの座標
vehicle_num_bottom	int	車両画像内のナンバープレートの座標
snap_id	string	キャプチャーID
snap_path	string	キャプチャ画像のパス
snap_buf	string	車両画像（Base64エンコード）
snap_frame	string	フレーム（Base64エンコード）
vehicle_num_img	string	ナンバープレートの画像（Base64エンコード）
vehicle_number	string	ライセンス番号
trigger	string	キャプチャのトリガー時間
obj_label	int	3：自動車以外の車両 4：自動車
vehicle_attr	json	車両属性 付録Dを参照のこと

このメッセージでは、img、snap、snap_frameがbase64でエンコードされており、snap_path、img_pathに応じて、キャプチャ画像やデータベース画像をダウンロードすることができます。

リクエストの例

{
    "key":"7410342e-e4e8-47de-a92f-2fd918eb3d6a",
    "msg_id":"776"
}

レスポンスの例

{
    "code": 0,
    "data": {
            "vehicle_attr": {
                "Brand":"Toyota",
                "CarDirection":"Front",
                "CarFilter":"Easy",
                "SubType":"Toyota-Camry ",
                "Type":"Car",
                "vehicle_class": "suv",
                "vehicle_color": "black"
            },
            "camera_name": "test",
            "device_id": "13",
            "channel": 19,
            "img_id": "fa48b56f-9aed-43bc-ad20-9ee164873473",
            "img_path": "img_pic",
            "lib_id": 3,
            "lib_name": "Car Database",
            "obj_label":3,
            "owner_age": "",
            "owner_gender": "",
            "owner_idcard": "",
            "owner_name": "Mike_000000000000000000_1",
            "position": "",
            "quality":85,
            "pos_top":1000,
            "pos_bottom":100,
            "pos_left":100,
            "pos_right":1000,"snap_id": "92ed1a18-2aaf-4362-b5b4-1fd6750e1dd9",
            "snap_path": "snap_pic",
            "verhicle_number":"YNLV880",
            "threshold": 80,
            "trigger": "2020-01-24 13:43:32"
    },
    "msg": "",
    "msg_id": "777"
}

11.4 WebSocketによる統計結果のプッシュ

インターフェースの説明

インターフェースのURL	ws://${ip}:${port}/ws/
インターフェースの説明	WebSocketにより統計結果をプッシュします。

リクエストパラメーター

パラメーター	型	説明	必須	例
msg_id	string	“778”	Yes
key	string	サブスクリプション・キー	Yes

レスポンスパラメーター

パラメーター	型	説明
code	int	結果コード（0：成功）
data	json	戻りデータ
msg_id	string	“778”（画像プッシュメッセージの一意の識別子）
msg	string	結果の説明

フィールド情報(データ)

パラメーター	型	説明
key_person_cnt	int	キーパーソンカウント
white_list_cnt	int	登録者リストの人数
stranger_cnt	int	未登録者の人数

Note: count results.

リクエストの例

{
    "key":"7410342e-e4e8-47de-a92f-2fd918eb3d6a",
    "msg_id":"778"
}

レスポンスの例

{
    "code": 0,
    "msg": ""
}
{
    "code": 0,
    "data": {
        "key_person_cnt": 0,
        "white_list_cnt": 0,
        "stranger_cnt": 0,
    },
    "msg": "recvive websocket msg"
    "msg_id": "778"
}