이 페이지 내용
웹훅 메시지
다양한 웹훅 주제에 대한 메시지 형식 및 페이로드를 숙지합니다.
메시지 형식
각 웹후크 주제는 형식이 약간 다를 수 있습니다.
대부분의 웹훅은 다음과 같은 페이로드 events, 인 다음과 같은 구조를 event_details 가지고 있습니다.
{
"topic": "webhook-topic",
"events": [
{"EVENT DETAILS": "...."},
{"EVENT DETAILS": "....",
...
]
}
페이로드 구조
모든 웹훅 메시지는 JSON(JavaScript Object Notation) 형식이며 메시지 자체의 구성을 설명하는 헤더에 다음 정보를 포함합니다. 헤더 정보는 메시지의 페이로드 앞에 나타납니다. 웹훅 구성에서 사용자 지정 헤더를 구성하면 여기에도 표시됩니다.
POST /uri/... HTTP/1.1 Host: hooks.abc.com:443 User-Agent: Mist-webhook Content-Type: application/json Content-Length: 382 X-Mist-Signature: ce3af7760f1289d02bf6a7ad19f3xxxxxxxxxx
인프라 페이로드 예시
웹훅 샘플의 전체 목록은 API 샘플 웹훅을 참조하세요. 그러면 주어진 각 웹훅 주제에 대해 Mist Cloud가 보내는 샘플 웹훅 메시지가 표시됩니다.
다음은 인프라 웹후크로 시작하는 웹후크 샘플 중 일부입니다.
경고
이 경고(경보) 예는 탐지된 비인가 AP, 탐지 횟수(탐지 횟수), AP 및 탐지Juniper Mist 기본 서비스 집합 식별자(BSSID)를 표시합니다.
{
"topic": "alarms",
"events": [
{
"aps": [
"5c5b35xxxxxx"
],
"bssids": [
"00024axxxxxx",
"5c5b3xxxxxx",
"000f2xxxxxx",
"c03f0exxxxxx",
"e091f5xxxxxx",
"e894f6xxxxxx",
"40169fxxxxxx",
"40169fxxxxxx",
"c03f0exxxxxx",
"5c5b35xxxxxx"
],
"count": 16,
"id": "95193bda-1fef-4ea6-xxxx-xxxxxxxxxxxx",
"last_seen": 1549068720,
"ssids": [
"qwerty",
"A-Dot",
"xfinity",
"alpha"
],
"timestamp": 1549068202,
"type": "rogue-ap-detected",
"update": true,
"org_id": "2818e386-8dec-2562-xxxx-xxxxxxxxxxxx",
"site_id": "4ac1dcf4-9d8b-7211-xxxx-xxxxxxxxxxxx"
}
]
}
감사
이 예는 John Doe가 디바이스를 업데이트했음을 나타내는 감사 경고입니다. 디바이스가 속한 조직(org_id) 및 사이트(site_id)가 표시됩니다.
{
"topic": "audits",
"events": [
{
"admin_name": "john doe john.doe@juniper.net",
"device_id": "00000000-0000-0000-1000-5c5b35xxxxxx",
"id": "8e00dd48-b918-4d9b-xxxx-xxxxxxxxxxxx",
"message": "Update Device \"Reception\"",
"org_id": "2818e386-8dec-2562-xxxx-xxxxxxxxxxx",
"site_id": "4ac1dcf4-9d8b-7211-xxxx-xxxxxxxxxxxx",
"src_ip": "xx.xx.xx.xx",
"timestamp": 1549047906.201053
}
]
}
클라이언트 가입
이 클라이언트 참가 메시지는 참가한 클라이언트의 MAC 주소 표시. 또한 클라이언트가 무선 네트워크에 연결하는 순간 연결된 연결 세부 정보도 표시됩니다.
{
"topic": "client-join",
"events": [
{
"ap": “5c5b35d0xxxx",
"ap_name": “AP43 Test",
"band": "5",
"bssid": "5c5b35dfxxxx",
"connect": 1592333828,
"connect_float": 1592333828.324,
"mac": "70ef0071xxxx",
"org_id": "6748cfa6-4e12-11e6-xxxx-xxxxxxxxxxx",
"rssi": -54,
"site_id": "d761985e-49b1-4506-xxxx-xxxxxxxxxxx",
"site_name": "Test",
"ssid": "Mist",
"timestamp": 1592333828,
"version": 2
"wlan_id": "6c0c0b07-0d77-44d1-xxxx-xxxxxxxxxxxx",
}
]
}
클라이언트 세션
클라이언트 세션 페이로드는 클라이언트에서 단일 AP로의 전체 세션에 대한 자세한 정보를 표시합니다.
{
"topic": "client-sessions",
"events": [
{
"ap": “5c5b352fxxxx",
"ap_name": “AP43 Test",
"band": "5",
"bssid": "5c5b352bxxxx",
"client_family": "iPhone",
"client_manufacture": "Apple",
"client_model": "8+",
"client_os": "13.4.1",
"connect": 1592333548,
"connect_float": 1592333548.117,
"disconnect": 1592333828,
"disconnect_float": 1592333828.589,
"duration": 279.835049793,
"mac": "70ef00xxxxxx",
"next_ap": "5c5b35d0xxxx",
"org_id": "6748cfa6-4e12-11e6-xxxx-xxxxxxxxxxxx",
"rssi": -87,
"site_id": "d761985e-49b1-4506-xxxx-xxxxxxxxxxx",
"site_name": "Test",
"ssid": "Mist",
"termination_reason": 3,
"timestamp": 1592333828,
"version": 2
"wlan_id": "6c0c0b07-0d77-44d1-xxxx-xxxxxxxxxxxx",
}
]
}
장치 이벤트
device-events 페이로드는 이유와 함께 이벤트가 발생한 디바이스에 대한 세부 정보를 표시합니다.
{
"topic": "device-events",
"events": [
{
"audit_id": "a8ec4d8a-4da6-4ead-xxxx-xxxxxxxxxxx",
"ap": "5c5b35xxxxxx",
"ap_name": "AP41 Near Lab",
"device_name": "AP41 Near Lab",
"device_type": "ap/switch/gateway",
"ev_type": "NOTICE",
"mac": "5c5b35xxxxxx",
"org_id": "2818e386-8dec-2562-xxxx-xxxxxxxxxxxx",
"reason": "power_cycle",
"site_id": "4ac1dcf4-9d8b-7211-xxxx-xxxxxxxxxxxx",
"site_name": "Site 1",
"text": "event details",
"timestamp": 1461220784,
"type": "AP_RESTARTED"
}
]
}
장치 업다운
device-updowns 웹훅은 device-events 웹훅의 하위 집합입니다. 장치의 기본 정보와 다운된 이유(유형)만 보냅니다.
{
"topic": "device-updowns",
"events": [
{
"org_id": "2818e386-8dec-2562-xxxx-xxxxxxxxxxxx",
"site_id": "4ac1dcf4-9d8b-7211-xxxx-xxxxxxxxxxxx",
"type": "AP_RESTARTED",
"ap": "5c5b35xxxxxx",
"ap_name": "AP01",
"site_name": "Site1"
"timestamp": 1461220784
}
]
}
게스트 권한 부여
게스트 권한 부여 웹훅은 게스트 클라이언트가 WLAN에 권한을 부여할 때 해당 고객에게 게스트 클라이언트에 대한 데이터를 제공합니다.
{
"topic": "guest-authorizations",
"events": [
{
"ap":"5c5b350e55c8",
"auth_method": "passphrase",
"authorized_expiring_time":1677076639,
"authorized_time":1677076519,
"carrier": "docomo",
"client": "ac2316eca70a",
"company": "MIST",
"email": ""abcd@abcd.com",
"field1": "field1 value",
"field2": "field2 value",
"field3": "field3 value",
"field4": "field4 value",
"mobile": "+0123456789",
"name": "Dr Strange",
"org_id":"1688605f-916a-47a1-8c68-f19618300a08",
"site_id":"ec3b5624-73f1-4ed3-b3fd-5ba3ee40368a",
"sms_gateway": "Telstra",
"sponsor_email": "sponsor@gmail.com",
"ssid":"Portal Auth",
"wlan_id":"7681be9a-044a-4622-90cf-3accde5ad853",
}
]
}
Juniper Mist 에지 이벤트
mxedge-events 웹훅 페이로드에는 device-events와 유사한 개별 Juniper Mist Edge 디바이스에서 발생하는 이벤트에 대한 기본 정보가 포함될 수 있습니다.
{
"topic": "mxedge-events",
"events": [
{
"audit_id": "03a65fa8-f74b-4c82-xxxx-xxxxxxxxxxxx",
"mxcluster_id": "27558fe2-a0e5-4236-xxxx-xxxxxxxxxxxx",
"mxedge_id": "00000000-0000-0000-1000-xxxxxxxxxxxx",
"mxedge_name": "ME1",
"org_id": "dfb3a656-2a21-4ea5-xxxx-xxxxxxxxxxxx",
"timestamp": "1692974834.308884",
"type": "ME_CONFIG_CHANGED_BY_USER"
}
]
}
위치 페이로드 예시
다음 그룹은 사이트(조직이 아님)에서만 사용할 수 있는 위치 웹후크입니다.
위치 좌표
위치 웹훅 페이로드는 클라이언트 정보를 Juniper Mist에 업로드된 맵(평면도)의 위치와 연관시킵니다. 정확하게 축척된 맵과 SDK 클라이언트 사용은 이 웹후크에 대한 요구 사항입니다.
{
"topic": "location",
"events": [
{
"site_id": "4ac1dcf4-9d8b-7211-xxxx-xxxxxxxxxxxx",
"map_id": "845a23bf-bed9-e43c-xxxx-xxxxxxxxxxxx",
"x": 13.5,
"y": 3.2,
"timestamp": 1461220784,
// for SDK client
"type": "sdk",
"id": "de87bf9d-183f-e383-xxxx-xxxxxxxxxxxx",
"name": "optional",
// for WIFI
"type": "wifi",
"mac": "5684daxxxxxx",
// Optional for wifi
"wifi_beacon_extended_info": [
{"frame_ctrl": 776, "seq_ctrl": 772, "payload": "............"},
]
// for ASSET
"type": "asset",
"mac": "7fc293xxxxxx",
"ibeacon_uuid": "f3f17139-704a-f03a-xxxx-xxxxxxxxxxxx",
"ibeacon_major": 13,
"ibeacon_minor": 138,
"eddystone_uid_namespace": "2818e3868decxxxxxxxx",
"eddystone_uid_instance": "5c5b35xxxxxx",
"eddystone_url_url": "https://www.abc.com",
"mfg_company_id": 935,
"mfg_data": "648520a1020000",
"battery_voltage": 3370
}
]
}
점유 알림
점유 경보 웹훅은 구성된 영역을 초과하는 경우 특정 영역에 대한 정보를 표시occupancy_limit.
{
"topic": "occupancy-alerts",
"events": [
{
"alert_events": [
{
"current_occupancy": 10,
"map_id": "f5d26c7f-1670-4921-xxxx-xxxxxxxxxxxx",
"occupancy_limit": 5,
"org_id": "6748cfa6-4e12-11e6-xxxx-xxxxxxxxxxxx",
"timestamp": 1594861457,
"type": "COMPLIANCE-VIOLATION",
"zone_id": "b83312a7-7269-4ae1-xxxx-xxxxxxxxxxxx",
"zone_name": "PLM and Leadership"
},
{
"current_occupancy": 20,
"map_id": "f5d26c7f-1670-4921-xxxx-xxxxxxxxxxxx",
"occupancy_limit": 10,
"org_id": "6748cfa6-4e12-11e6-xxxx-xxxxxxxxxxxx",
"timestamp": 1594861457,
"type": "COMPLIANCE-VIOLATION",
"zone_id": "80acf542-e863-43cf-xxxx-xxxxxxxxxxxx",
"zone_name": "CSQA"
},
{
"current_occupancy": 9,
"map_id": "f5d26c7f-1670-4921-xxxx-xxxxxxxxxxxx",
"occupancy_limit": 4,
"org_id": "6748cfa6-4e12-11e6-xxxx-xxxxxxxxxxxx",
"timestamp": 1594861457,
"type": "COMPLIANCE-VIOLATION",
"zone_id": "a4c7a7c2-880e-4a0e-xxxx-xxxxxxxxxxxx",
"zone_name": "Marketing & Sales Ops"
}
],
"site_id": "67970e46-4e12-11e6-xxxx-xxxxxxxxxxxx",
"site_name": "MIST OFFICE"
}
]
}
RSSI 영역
rssizone 웹후크 페이로드는 사이트 전체에서 구성된 최소 RSSI 임계값을 초과한 디바이스를 표시합니다.
{
"topic":"rssizone",
"events":[
{
"mac":"500291xxxxxx",
"map_id":"f5d26c7f-1670-4921-xxxx-xxxxxxxxxxxx",
"rssizone_id":"e38f8e76-40db-4144-xxxx-xxxxxxxxxxxx",
"site_id":"f5fcbee5-fbca-45b3-xxxx-xxxxxxxxxxxx",
"timestamp":1694158990.986472,
"trigger":"enter",
"type":"wifi"
}
]
}
SDK 클라이언트 스캔 데이터
SDK 클라이언트 스캔 데이터 웹훅 페이로드는 클라이언트 자체에 애플리케이션(SDK 사용)을 설치하지 않고는 사용할 수 없는 클라이언트에 대한 특정 데이터를 표시합니다.
{
"events": [
{
"connection_ap": "5c5b35xxxxxx",
"connection_band": "2.4",
"connection_bssid": "5c5b35xxxxxx",
"connection_channel": 11,
"connection_rssi": -87,
"last_seen": 1592333828,
"mac": "70ef00xxxxxx",
"scan_data": [
{
"ap": "5c5b35xxxxxx",
"band": "2.4",
"bssid": "5c5b35xxxxxx",
"channel": 11,
"rssi": -87,
"ssid": "mist-wifi",
"timestamp": 1592333828
},
{
"ap": "5c5b35xxxxxx",
"band": "5",
"bssid": "5c5b35xxxxxx",
"channel": 36,
"rssi": -75,
"ssid": "mist-wifi",
"timestamp": 1592333828
}
],
"site_id": "d761985e-49b1-4506-xxxx-xxxxxxxxxxxx"
}
],
"topic": "sdkclient-scan-data"
}
가상 비콘 진입 및 종료 이벤트
vbeacon 웹훅은 Juniper Mist SDK를 실행하는 모바일 디바이스가 가상 비콘에 의해 정의된 영역에 들어가거나 나갈 때 트리거됩니다.
{
"topic":"vbeacon",
"events":[
{
"mac":"10521cxxxxxx",
"map_id":"5a8b84e6-cc7b-xxxx-xxxxxxxxxxxx",
"site_id":"f5fcbee5-fbca-45b3-xxxx-xxxxxxxxxxxx",
"timestamp":1694166602.662786,
"trigger":"enter",
"type":"wifi",
"vbeacon_id":"ca301fd7-07af-4d42-xxxx-xxxxxxxxxxxx"
}
]
}
영역 진입 및 종료 이벤트
영역 웹후크는 디바이스가 정의된 영역에 들어가거나 나갈 때 트리거됩니다.
{
"topic":"zone",
"events":[
{
"mac":"10521cxxxxxx",
"map_id":"5a8b84e6-cc7b-xxxx-xxxxxxxxxxxx",
"site_id":"f5fcbee5-fbca-45b3-xxxx-xxxxxxxxxxxx",
"timestamp":1694166602.662786,
"trigger":"exit",
"type":"wifi",
"zone_id":"b83312a7-7269-4ae1-xxxx-xxxxxxxxxxxx "
}
]
}