お知らせ機能｜通知先の追加・お知らせの設定・メールとWebhookの通知例

  • 更新

[リリースノート] 無効なwebhookの停止処理の追加（2024/04/23）

お知らせ機能は、『アクセスユーザー』画面の各カギの詳細画面または、『お知らせ機能』画面から設定することができます。 アクセスユーザーがドアのロックを解除したときに、通知を受信するためにアカウント管理者は、特定の「管理者」が通知を受信する通知先を設定する必要があります。 お知らせ機能を追加する前に、通知先を追加する必要があります。

※KLシリーズ（500iなど）で対応しております。

設定の手順

  1. 「高度な機能」→「お知らせ機能」→「通知先」タブで「通知先の追加」を押し、送り先の名前とメールアドレスを入れて「作成」を押します。Webhookで受け取るときは「WEBHOOK」のタブで追加します（お客様の側での開発が必要です。ふつうは「メール」を選びます）。「有効」のチェックを外した通知先には送られません。
  2. 「お知らせ機能」タブで「お知らせ機能の追加」を押します。
  3. 通知の種類（メールかWEBHOOK）、通知先、情報元、イベントを選んで「作成」を押します。すべてのデバイスが対象なら、情報元は「アカウント」にします。

おすすめのイベントは「アクセスユーザー/アクセスゲストの同期失敗」「アクセスゲストの同期遅延」「ネットワークの接続状況」「電池残量の低下」です。電池の低下とWi-Fiの切断を管理者に知らせたいときは、情報元を「アカウント」、イベントを「Wi-Fiの接続状況」「電池残量の低下」「電池交換」にします。

「Wi-Fiの接続状況」は、本体が長くクラウドにつながらないときに届き、つながり直したときにも届きます。ルーターの混雑などで一時的に通信できないこともあるため、ハートビート間隔の2倍の時間つながらないときに届きます（例：1時間なら2時間）。電池残量の低下のお知らせのタイミングは 電池残量の表示とお知らせ にあります。

情報元で「カギ」を選び、KLシリーズ（500i・700i・900j）のデバイスを選ぶと、イベントに英語の項目が出ます。KLシリーズでは使えないので選ばないでください。

お知らせ機能の追加

Step 1. お知らせ機能を利用される前に、まずは通知先のご登録をお願いいたします。（※ご参考：通知先）

Step 2.『お知らせ機能』タブで「お知らせ機能の追加」ボタンをクリックします。 ポップアップ画面でサブスクライバーの種類 (メールまたはWEBHOOK) を選択し、ドロップダウンリストから発行元を選択します。 アクセス、イベントの種類をクリックして作成します。

 

情報元について

お知らせ機能設定じの情報元の設定について補足します。

SC__2020-03-09_11.12.41.jpg

■メールの通知例

  • 解錠
Door 1 - Internal I/O - TOBIRA④__IN (test_location_name01##QR) は 2023/03/06 21:05 JST時にロック解除されました
  • 施錠
Door 1 - Internal I/O - TOBIRA④__IN (test_location_name01##QR) は 2023/03/06 21:05 JST時にロックされました
 

■webhookの通知例

※KLシーリスは "connector_lock"タイプ

  • ネットワークの切断
{
  "data": {
  "type": "connectivity_event",
  "attributes": {
    "source": "device",
    "status": "failed",
    "time_zone": "Asia/Tokyo",
    "occurred_at": "2021-04-14T03:10:23Z",
    "created_at": "2021-04-14T03:10:23Z",
    "updated_at": "2021-04-14T03:10:23Z",
    "connected_at": null,
    "publisher_id": "6e61b0bd-6f9d-41af-a34a-a627bb3329e9",
    "publisher_type": "lock"
  },
  "id": "0392bcee-6414-47ea-b168-e83bc9088d77",
  "links": {
    "self": "/events/0392bcee-6414-47ea-b168-e83bc9088d77",
    "publisher": "/devices/6e61b0bd-6f9d-41af-a34a-a627bb3329e9"
    }
  }
}
  • ネットワークの接続開始
{
  "data": {
  "type": "connectivity_event",
  "attributes": {
    "source": "device",
    "status": "succeeded",
    "time_zone": "Asia/Tokyo",
    "occurred_at": "2021-04-14T04:15:45Z",
    "created_at": "2021-04-14T04:15:45Z",
    "updated_at": "2021-04-14T04:15:45Z",
    "connected_at": null,
    "publisher_id": "6e61b0bd-6f9d-41af-a34a-a627bb3329e9",
    "publisher_type": "lock"
  },
  "id": "a6eaed1d-eb58-457d-a3f6-84f87ba1e2d3",
  "links": {
    "self": "/events/a6eaed1d-eb58-457d-a3f6-84f87ba1e2d3",
    "publisher": "/devices/6e61b0bd-6f9d-41af-a34a-a627bb3329e9"
    }
  }
}
  • 電池残量の低下
{
  "data": {
  "type": "power_level_low_event",
  "attributes": {
    "source": "user",
    "status": "succeeded",
    "time_zone": "America/Denver",
    "occurred_at": "2021-02-24T08:35:07Z",
    "created_at": "2021-02-24T21:27:07Z",
    "updated_at": "2021-02-24T21:27:07Z",
    "power_level": 29,
    "publisher_id": "70b215a1-9033-48c6-8410-7db24e18cabb",
    "publisher_type": "lock"
  },
  "id": "7c60cb2c-9ea8-4614-b581-1ced281ec6ae",
  "links": {
    "self": "http://api.remotelock.dev/events/7c60cb2c-9ea8-4614-b581-1ced281ec6ae",
    "publisher": "http://api.remotelock.dev/devices/70b215a1-9033-48c6-8410-7db24e18cabb"
    }
  }
}
  • ユーザーがPINコードでロック解除

利用シーン例：どのお客さんがどのデバイスに何時に入室したか。

以下のサンプルデータでは associated_resource_id  = 予約エンドポイントのカギ発行時、レスポンスで返ってきたaccess_person_id

{
  "data": {
    "type": "unlocked_event",
    "attributes": {
      "source": "user",
      "status": "succeeded",
      "time_zone": "Asia/Tokyo",
      "occurred_at": "2024-08-02T04:23:55Z",
      "created_at": "2024-08-02T04:24:09Z",
      "updated_at": "2024-08-02T04:24:09Z",
      "associated_resource_name": null,
      "status_info": null,
      "method": "pin",
      "pin": "21391",
      "card": null,
      "publisher_id": "a316a506-0038-47b2-9157-52d57ad59412",
      "publisher_type": "lock",
      "associated_resource_id": "5e9d7fa0-4439-444a-a6b5-81866e752e55",
      "associated_resource_type": "access_guest"
    },
    "id": "b8b22833-82bb-450f-a323-dd12ad47849a",
    "links": {
      "self": "/events/b8b22833-82bb-450f-a323-dd12ad47849a",
      "publisher": "/devices/a316a506-0038-47b2-9157-52d57ad59412",
      "associated_resource": "/access_persons/5e9d7fa0-4439-444a-a6b5-81866e752e55"
    }
  }
}
  • アクセスユーザー／ゲストの同期成功 (アクセスユーザー／ゲストの同期状況に関してはKLシリーズで対応済み)
{
  "data": {
    "type": "access_person_synced_event",
    "attributes": {
      "source": "user",
      "status": "succeeded",
      "time_zone": "Asia/Tokyo",
      "occurred_at": "2024-08-02T05:13:13Z",
      "created_at": "2024-08-02T05:13:16Z",
      "updated_at": "2024-08-02T05:13:16Z",
      "associated_resource_name": null,
      "publisher_id": "a316a506-0038-47b2-9157-52d57ad59412",
      "publisher_type": "lock",
      "associated_resource_id": "9a9e390c-b708-4ba3-af90-077a126f9b0d",
      "associated_resource_type": "access_guest"
    },
    "id": "6f3dc8b3-5162-4aca-9b75-7e2cf5f9b951",
    "links": {
      "self": "/events/6f3dc8b3-5162-4aca-9b75-7e2cf5f9b951",
      "publisher": "/devices/a316a506-0038-47b2-9157-52d57ad59412",
      "associated_resource": "/access_persons/9a9e390c-b708-4ba3-af90-077a126f9b0d"
    }
  }
}
  • ユーザーが「解錠/施錠」ボタンでロック施錠

※"method" : "pin" になりますが、"pin"項目がない

{
  "data": {
    "type": "locked_event",
    "attributes": {
      "source": "user",
      "status": "succeeded",
      "time_zone": "Asia/Tokyo",
      "occurred_at": "2024-08-02T05:02:11Z",
      "created_at": "2024-08-02T05:02:17Z",
      "updated_at": "2024-08-02T05:02:17Z",
      "associated_resource_name": null,
      "method": "pin",
      "publisher_id": "48bfee4f-b3f5-4be7-9cf6-763f8500aec3",
      "publisher_type": "connector_lock"
    },
    "id": "e9f4f562-7cf4-471e-8d44-4b4bcb1d5e19",
    "links": {
      "self": "/events/e9f4f562-7cf4-471e-8d44-4b4bcb1d5e19",
      "publisher": "/devices/48bfee4f-b3f5-4be7-9cf6-763f8500aec3"
    }
  }
}
  • デバイスオートロックでロック施錠
{
  "data": {
    "type": "locked_event",
    "attributes": {
      "source": "device",
      "status": "succeeded",
      "time_zone": "Asia/Tokyo",
      "occurred_at": "2024-08-02T02:32:55Z",
      "created_at": "2024-08-02T02:32:57Z",
      "updated_at": "2024-08-02T02:32:57Z",
      "associated_resource_name": null,
      "method": "auto_lock",
      "publisher_id": "48bfee4f-b3f5-4be7-9cf6-763f8500aec3",
      "publisher_type": "connector_lock"
    },
    "id": "f609b399-9602-4aae-9c28-bf6bc466a91e",
    "links": {
      "self": "/events/f609b399-9602-4aae-9c28-bf6bc466a91e",
      "publisher": "/devices/48bfee4f-b3f5-4be7-9cf6-763f8500aec3"
    }
  }
}
  • アクセスユーザー/ゲスト作成
{
  "data": {
    "type": "access_person_created_event",
    "attributes": {
      "source": "user",
      "status": "succeeded",
      "time_zone": "UTC",
      "occurred_at": "2024-08-02T05:12:05Z",
      "created_at": "2024-08-02T05:12:05Z",
      "updated_at": "2024-08-02T05:12:05Z",
      "publisher_id": "9a9e390c-b708-4ba3-af90-077a126f9b0d",
      "publisher_type": "access_guest"
    },
    "id": "0dbe59fa-633a-4fce-a0af-be3a7f94366c",
    "links": {
      "self": "/events/0dbe59fa-633a-4fce-a0af-be3a7f94366c",
      "publisher": "/access_persons/9a9e390c-b708-4ba3-af90-077a126f9b0d"
    }
  }
}
  • アクセスユーザー/ゲスト変更
{
  "data": {
    "type": "access_person_updated_event",
    "attributes": {
      "source": "user",
      "status": "succeeded",
      "time_zone": "Asia/Tokyo",
      "occurred_at": "2024-08-02T06:54:11Z",
      "created_at": "2024-08-02T06:54:11Z",
      "updated_at": "2024-08-02T06:54:11Z",
      "publisher_id": "7eaeef71-d21a-4ebf-9897-5070aa66d2d7",
      "publisher_type": "access_guest"
    },
    "id": "20ca7494-224b-4f5e-955c-2056a10310ef",
    "links": {
      "self": "/events/20ca7494-224b-4f5e-955c-2056a10310ef",
      "publisher": "/access_persons/7eaeef71-d21a-4ebf-9897-5070aa66d2d7"
    }
  }
}
  • アクセスユーザー/ゲスト削除
{
  "data": {
    "type": "access_person_deleted_event",
    "attributes": {
      "source": "user",
      "status": "succeeded",
      "time_zone": "UTC",
      "occurred_at": "2024-08-02T07:36:47Z",
      "created_at": "2024-08-02T07:36:47Z",
      "updated_at": "2024-08-02T07:36:47Z",
      "publisher_id": "5a058d8c-2099-4393-ba91-8a5f885a490b",
      "publisher_type": "access_guest"
    },
    "id": "b8ee52f4-3b50-4c93-baa8-c17cf301bb55",
    "links": {
      "self": "/events/b8ee52f4-3b50-4c93-baa8-c17cf301bb55",
      "publisher": "/access_persons/5a058d8c-2099-4393-ba91-8a5f885a490b"
    }
  }
}
  • TOBIRA用アクセスパーソン作成　＞　デバイスに同期　＞　QRでデバイス解錠　＞　オートロックデバイスロックイベント  
 
{
         {
            "type": "locked_event",
            "attributes": {
                "source": "device",
                "status": "succeeded",
                "time_zone": "Asia/Tokyo",
                "occurred_at": "2024-09-06T05:23:33Z",
                "created_at": "2024-09-06T05:23:42Z",
                "updated_at": "2024-09-06T05:23:42Z",
                "associated_resource_name": null,
                "method": "auto_lock",
                "publisher_id": "12029d71-f760-49e2-bbf7-0c65e04a6142",
                "publisher_type": "acs_door"
            },
            "id": "01eb8283-5006-4722-ab97-47ff9ad74de4",
            "links": {
                "self": "https://api.remotelock.jp/events/01eb8283-5006-4722-ab97-47ff9ad74de4",
                "publisher": "https://api.remotelock.jp/devices/12029d71-f760-49e2-bbf7-0c65e04a6142"
            }
        },
        {
            "type": "access_person_used_event",
            "attributes": {
                "source": "user",
                "status": "succeeded",
                "time_zone": "Asia/Tokyo",
                "occurred_at": "2024-09-06T05:23:29Z",
                "created_at": "2024-09-06T05:23:30Z",
                "updated_at": "2024-09-06T05:23:30Z",
                "associated_resource_name": null,
                "status_info": null,
                "method": "card",
                "pin": null,
                "card": "212870",
                "publisher_id": "03ee4943-3640-4f7e-816b-ae87d5d97a95",
                "publisher_type": "access_guest",
                "associated_resource_id": "12029d71-f760-49e2-bbf7-0c65e04a6142",
                "associated_resource_type": "acs_door"
            },
            "id": "2b32e9f1-fd93-4f6c-ae47-810953ed9e05",
            "links": {
                "self": "https://api.remotelock.jp/events/2b32e9f1-fd93-4f6c-ae47-810953ed9e05",
                "publisher": "https://api.remotelock.jp/access_persons/03ee4943-3640-4f7e-816b-ae87d5d97a95",
                "associated_resource": "https://api.remotelock.jp/devices/12029d71-f760-49e2-bbf7-0c65e04a6142"
            }
        },
        {
            "type": "unlocked_event",
            "attributes": {
                "source": "user",
                "status": "succeeded",
                "time_zone": "Asia/Tokyo",
                "occurred_at": "2024-09-06T05:23:29Z",
                "created_at": "2024-09-06T05:23:29Z",
                "updated_at": "2024-09-06T05:23:29Z",
                "associated_resource_name": null,
                "status_info": null,
                "method": "card",
                "pin": null,
                "card": "212870",
                "publisher_id": "12029d71-f760-49e2-bbf7-0c65e04a6142",
                "publisher_type": "acs_door",
                "associated_resource_id": "03ee4943-3640-4f7e-816b-ae87d5d97a95",
                "associated_resource_type": "access_guest"
            },
            "id": "33d7d8e1-214d-4450-b761-b09de1e55272",
            "links": {
                "self": "https://api.remotelock.jp/events/33d7d8e1-214d-4450-b761-b09de1e55272",
                "publisher": "https://api.remotelock.jp/devices/12029d71-f760-49e2-bbf7-0c65e04a6142",
                "associated_resource": "https://api.remotelock.jp/access_persons/03ee4943-3640-4f7e-816b-ae87d5d97a95"
            }
        },
        {
            "type": "access_person_synced_event",
            "attributes": {
                "source": "user",
                "status": "succeeded",
                "time_zone": "Asia/Tokyo",
                "occurred_at": "2024-09-06T05:22:06Z",
                "created_at": "2024-09-06T05:22:07Z",
                "updated_at": "2024-09-06T05:22:07Z",
                "associated_resource_name": null,
                "publisher_id": "12029d71-f760-49e2-bbf7-0c65e04a6142",
                "publisher_type": "acs_door",
                "associated_resource_id": "03ee4943-3640-4f7e-816b-ae87d5d97a95",
                "associated_resource_type": "access_guest"
            },
            "id": "14f21c5f-85ed-4d8b-9b52-177efc3d0019",
            "links": {
                "self": "https://api.remotelock.jp/events/14f21c5f-85ed-4d8b-9b52-177efc3d0019",
                "publisher": "https://api.remotelock.jp/devices/12029d71-f760-49e2-bbf7-0c65e04a6142",
                "associated_resource": "https://api.remotelock.jp/access_persons/03ee4943-3640-4f7e-816b-ae87d5d97a95"
            }
        },
        {
            "type": "access_person_created_event",
            "attributes": {
                "source": "user",
                "status": "succeeded",
                "time_zone": "UTC",
                "occurred_at": "2024-09-06T05:21:57Z",
                "created_at": "2024-09-06T05:21:57Z",
                "updated_at": "2024-09-06T05:21:57Z",
                "publisher_id": "03ee4943-3640-4f7e-816b-ae87d5d97a95",
                "publisher_type": "access_guest"
            },
            "id": "0a3e61ee-8bec-4fab-8bf9-1c523bfdbd33",
            "links": {
                "self": "https://api.remotelock.jp/events/0a3e61ee-8bec-4fab-8bf9-1c523bfdbd33",
                "publisher": "https://api.remotelock.jp/access_persons/03ee4943-3640-4f7e-816b-ae87d5d97a95"
            }
        },
}

 

 

関連記事