監査イベントの種類を取得する

このコード・スニペットでは、サポートされているすべてのイベント・タイプのリストを取得する方法を説明します。

例

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

キー説明
VONAGE_API_KEY

Your Vonage API key (see it on your dashboard).

VONAGE_API_SECRET

Your Vonage API secret (also available on your dashboard).

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

前提条件

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 Event Types" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

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

source "../config.sh"

全文を見る

コードを書く

get-event-types.sh に以下を追加する：

curl -X "OPTIONS" "https://api.nexmo.com/beta/audit/events" \
     -u "$VONAGE_API_KEY:$VONAGE_API_SECRET"

全文を見る

コードを実行する

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

./get-event-types.sh

試してみる

シェルでコマンドを実行する。この呼び出しは、以下のように、サポートされている監査イベント・タイプのリストを取得する：

{
  "eventTypes": [
    {
      "type": "USER_STATUS",
      "description": "User status updated"
    },
    {
      "type": "USER_UPDATE",
      "description": "User updated"
    },
    {
      "type": "USER_BILLING_UPDATE",
      "description": "User billing updated"
    },
    {
      "type": "USER_CREATE",
      "description": "User created"
    },
    {
      "type": "USER_LOGIN",
      "description": "User login into Customer dashboard"
    },
    {
      "type": "USER_LOGOUT",
      "description": "User logout from Customer dashboard"
    },
    {
      "type": "USER_PRODUCT_SEARCH",
      "description": "User product search"
    },
    {
      "type": "USER_API_KEYS_UPDATE",
      "description": "Sub-accounts for user updated"
    },
    {
      "type": "ACCOUNT_SECRET_DELETE",
      "description": "Account secret deleted"
    },
    {
      "type": "ACCOUNT_SECRET_CREATE",
      "description": "Account secret created"
    },
    {
      "type": "ACCOUNT_UPDATE_SETTINGS_API",
      "description": "Account Settings updated via API"
    },
    {
      "type": "NUMBER_ASSIGN",
      "description": "Number assigned"
    },
    {
      "type": "NUMBER_UPDATED",
      "description": "Number updated"
    },
    {
      "type": "NUMBER_USER_CANCELED",
      "description": "Number canceled by user"
    },
    {
      "type": "NUMBER_LINKED",
      "description": "Number linked to application"
    },
    {
      "type": "NUMBER_UNLINKED",
      "description": "Number unlinked from application"
    },
    {
      "type": "APP_CREATE",
      "description": "Application created"
    },
    {
      "type": "APP_UPDATE",
      "description": "Application updated"
    },
    {
      "type": "APP_DELETE",
      "description": "Application deleted"
    },
    {
      "type": "APP_DISABLE",
      "description": "Application disabled"
    },
    {
      "type": "APP_ENABLE",
      "description": "Application enabled"
    },
    {
      "type": "IP_WHITELIST_CREATE",
      "description": "Whitelist IP added"
    },
    {
      "type": "IP_WHITELIST_DELETE",
      "description": "Whitelist IP deleted"
    },
    {
      "type": "AUTORELOAD_ENABLE",
      "description": "Automatic reload enabled"
    },
    {
      "type": "AUTORELOAD_UPDATE",
      "description": "Automatic reload settings updated"
    },
    {
      "type": "AUTORELOAD_DISABLE",
      "description": "Automatic reload disabled"
    }
  ]
}