フィルタリングによる監査イベントの取得

このコード・スニペットでは、フィルタリングを使用して監査イベントのリストを取得する方法について説明します。

パラメータ

クエリ・パラメータを使用して、返されるイベント・オブジェクトのリストをフィルタリングすることができます。指定可能なパラメータを以下の表に示す：

クエリ・パラメータ	説明
`event_type`	監査イベントのタイプ： `APP_CREATE`, `NUMBER_ASSIGN`などがある。をカンマ区切りで指定できる。イベントの種類ここにある。
`search_text`	JSON互換の検索文字列。監査イベント内の特定のテキストを検索します。
`date_from`	この日付（ISO-8601 形式）から Audit イベントを取得します。
`date_to`	この日付までの Audit イベントを取得します（ISO-8601 形式）。
`page`	1ページから始まるページ番号。
`size`	ページあたりの要素数（1〜100、デフォルトは30）。

例

以下の置換可能な値が、便利な方法でサンプルコードに設定されていることを確認する必要があります：

キー	説明
`VONAGE_API_KEY`	Your Vonage API key (see it on your dashboard).
`VONAGE_API_SECRET`	Your Vonage API secret (also available on your dashboard).
`SEARCH_TEXT`	Some JSON compatible text to search for. For example, "number".
`DATE_FROM`	Audit events starting from this ISO-8601 datetime value. For example, "2018-07-01".
`DATE_TO`	Audit events up to this ISO-8601 datetime value. For example, "2018-08-01".

次の例では アプリケーションの作成 そして 依存関係を初期化する 手続きは任意である。

前提条件

Vonage アプリケーションには、プロジェクトに必要な設定が含まれています。アプリケーションはVonage CLI (下記参照) またはダッシュボード経由を使用して作成できます。アプリケーションの詳細についてはVonageコンセプトガイドを見るを参照してください。

CLIをインストールする

npm install -g nexmo-cli

アプリケーションの作成

CLIをインストールしたら、それを使ってVonageアプリケーションを作成することができます。以下のコマンドを実行し、返ってくるアプリケーションIDを控えておいてください。これは、以下の例のNEXMO_APPLICATION_ID で使用する値です。また、依存関係を初期化する のステップで必要となるprivate.key をカレント・ディレクトリに作成します。

Vonage はanswer_url にアクセスするために、ローカルマシンに接続する必要があります。これにはngrok を使用することをお勧めします。以下の例でdemo.ngrok.io をご自身の ngrok URL に変更してください。

nexmo app:create "Get Events with filtering" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

get-events-with-filtering.sh という名前のファイルを作成し、以下のコードを追加する：

source "../config.sh"

全文を見る

コードを書く

get-events-with-filtering.sh に以下を追加する：

curl "https://api.nexmo.com/beta/audit/events?search_text=$SEARCH_TEXT&date_from=$DATE_FROM&date_to=$DATE_TO" \
     -u "$VONAGE_API_KEY:$VONAGE_API_SECRET"

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

./get-events-with-filtering.sh

前提条件

CLIをインストールする

npm install -g nexmo-cli

アプリケーションの作成

nexmo app:create "Get Events with filtering" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

npm install @vonage/audit

get-events-with-filtering.js という名前のファイルを作成し、以下のコードを追加する：

const { Audit } = require('@vonage/audit');

const auditClient = new Audit({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
});

全文を見る

コードを書く

get-events-with-filtering.js に以下を追加する：

const run = async () => {
  const filter = {
    dateFrom: DATE_FROM,
    dateTo: DATE_TO,
    searchText: SEARCH_TEXT,
  };

  try {
    for await (const event of auditClient.getEvents(filter)) {
      console.log(event);
    }
  } catch (error) {
    console.log(error);
  }
};
run();

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

node get-events-with-filtering.js

試してみる

シェルでコマンドを実行する。この呼び出しにより、フィルタリングされた監査イベントのリストが取得される。