イベントのサブスクリプションを管理する

NTT CPaaS Web インターフェイス (opens in a new tab) または サブスクリプション API を使用して (opens in a new tab)、イベント サブスクリプションのすべての側面を作成、表示、および管理できます。サブスクリプションは、通知をトリガーするイベントと、それらの通知の配信方法を定義します。

各サブスクリプションには、次のものが含まれている必要があります。

• 選択された カテゴリ と一連の イベント
• Webhook URL を含む 通知プロファイル
• (省略可能) フィルター (アプリケーション ID、エンティティ ID、ユーザーなど)
• (オプション) 認証設定 と 証明書

カテゴリごとに使用可能なイベントの包括的な一覧については、「イベント サブスクリプション」を参照してください。

サブスクリプションの作成と管理

Web インターフェイス または API を使用して、サブスクリプションを作成、管理、または削除します。

サブスクリプションの作成

Web インターフェイス でサブスクリプションを作成するには:

1. NTT CPaaS Web インターフェイス (opens in a new tab)にログインします。

   
   

2. [開発者ツール] > [サブスクリプション管理]** に移動します。

   
   

3. [サブスクリプション] タブを開きます。

   • このタブには、Web インターフェイスまたは API を使用して作成されたすべての既存のサブスクリプションが表示されます。検索 バーを使用してリストをフィルター処理できます。
   
   

4. [サブスクリプション] タブで、[サブスクリプションの作成] を選択します。

   
   

5. [カテゴリの選択] 画面で、カテゴリを選択します。カテゴリは次のようにグループ化されます。

   • チャネル:メール、Facebook、カカオ-アリム、カカオ-チング、LINE、モバイルプッシュ、RCS、SMS、MMS、Viber、WhatsApp、Zalo、VoiceとWebRTC、オープンチャネル、Apple Messages for Business
   • 番号と送信者:登録、モバイルID、番号検索
   • ツール: ブロックリスト、顧客エンゲージメント
   
   

6. サブスクリプション名 と サブスクリプション ID を入力します。次に、**[次へ] を選択します。

   • サブスクリプション ID には、文字、数字、ダッシュ、またはアンダースコアのみを使用します。スペースや特殊記号は使用しないでください。
   
   

7. イベントの選択 画面で、サブスクライブするイベントを選択し、次へ を選択します。

   手記

   選択したイベントに 番号レベルで定義された受信設定 が既にある場合、そのイベントは新しいサブスクリプションに自動的に追従しません。 サブスクリプションが適用されるようにするには、番号レベルの構成を更新し、転送アクションとして Follow subscription を設定します。

   • 使用可能なイベントは、選択したカテゴリによって異なります。完全なリファレンスについては、イベント サブスクリプションを参照してください。
   
   

8. [フィルターの設定] 画面 (省略可能) で、次の方法でトラフィックをフィルター処理します。

   • ユーザー: 特定のユーザーに対して生成されたフィルタ イベント。
   • エンティティ: 組織内の顧客や部門など、一意のオブジェクトを表すエンティティ ID。
   • アプリケーション: NTT CPaaS プラットフォーム上の特定のユース ケースまたは環境を表すアプリケーション ID。
   • リソース: メッセージの送信に使用される送信者名、番号、ドメイン、またはその他の ID。
   手記

   これらのフィルターは、複数組み合わせて使用できます。サブスクリプションは、すべてのフィルター条件がイベントに一致する場合にのみトリガーされます。

   • フィルターが適用されていない場合、サブスクリプションは選択したカテゴリのすべてのイベントに適用されます。
   • 準備ができたら、**[次へ] を選択します。
   
   

9. 既存の 通知プロファイル を選択するか、新しい通知プロファイルを作成します。

   • 新しいものを作成する場合は、その名前と Webhook URL を入力します。
   • 必要に応じて、応答本文の正規表現または応答の正規表現を追加して、HTTP 応答本文とヘッダーを検証します。
   • 通知プロファイルタブで通知プロファイルを個別に作成することもできます。
   大事な

   サブスクリプションが正しく機能するには、対応する通知プロファイルが必要です。

   
   

10. (オプション)セキュリティ設定 で、既存の 認証設定 を選択するか、新しい認証設定を作成します。

    • Basic、HMAC、または 0Auth を選択します。
    • 選択したタイプに必要な資格情報または設定を指定します。
    
    

11. (オプション)必要に応じて、既存の 証明書 を適用します。

    
    

12. (オプション)詳細設定を構成します。

    • 最大バケット サイズ (1–2000): 要求あたりの最大メッセージ数
    • ウィンドウ サイズ (20–10000): 同時接続数
    • 接続タイムアウト (300–30000 ms): 接続タイムアウト
    • 読み取りタイムアウト (1000–90000 ms): 読み取りタイムアウト
    • 有効な SSL プロトコル: TLS v1.2、TLS v1.3
    • ヘッダー: ヘッダーとして送信されるキーと値のペア
    • レート制限 (1–5000): 要求数/秒
      

13. [次へ] を選択して、サブスクリプションの概要を表示します。次に、[保存]** を選択します。

    • これで、新しいサブスクリプションが作成されました。

サブスクリプションを管理する

Web インターフェイス でサブスクリプションを表示または変更するには、次の手順に従います。

1. NTT CPaaS Web インターフェイス (opens in a new tab)にログインします。
   
2. [開発者ツール] > [サブスクリプション管理]** に移動します。
   
3. [サブスクリプション] タブを開き、検索 バーを使用してサブスクリプションを検索します。
   
4. サブスクリプションの横にある 3 ドット メニューを選択し、[編集] を選択します。
   • サブスクリプションの概要を表示するには、[表示] を選択します。
   
   
5. 必要な変更を行います。
   • イベント、フィルター、認証設定、通知プロファイルを変更できます。
   • サブスクリプションのカテゴリやチャンネルは変更できません。
   
   
6. Save (保存) を選択します。

サブスクリプションの削除

サブスクリプションを削除する場合は、このアクションが他の構成済み設定に影響を与える可能性があることに注意してください。サブスクリプション階層を確認して、削除ルールを理解することが重要です。サブスクリプションを削除すると、それに関連付けられている他のコンポーネントに影響を与える可能性があるため、注意してください。

Web インターフェイスでサブスクリプションを削除するには、次の手順に従います。

1. NTT CPaaS Web インターフェイス (opens in a new tab)にログインします。

2. [開発者ツール] > [サブスクリプション管理]** に移動します。

3. [サブスクリプション] タブを開き、検索 バーを使用してサブスクリプションを検索します。

4. サブスクリプションの横にある 3 ドット メニューを選択し、[削除] を選択します。

通知プロファイルの作成と管理

通知プロファイルは、通知の送信先と配信方法を定義します。すべてのサブスクリプションが正しく機能するには、有効な通知プロファイルが含まれている必要があります。 通知プロファイルは、NTT CPaaS Web インターフェイス または サブスクリプション API - プロファイル (opens in a new tab) を使用して作成、更新、または削除できます。通常、プロファイルには Webhook URL が含まれており、高度な配信と認証の設定が含まれる場合があります。

ユースケースによっては、新しいサブスクリプションの設定時に通知プロファイルを作成できます。この場合、サブスクリプションが作成されると、通知プロファイルは [サブスクリプション管理] 領域の [通知] タブに表示されます。

スタンドアロンの通知プロファイルは、複数のサブスクリプションで 1 つの通知プロファイルを使用するシナリオ用に作成できます。

通知プロファイルの作成

Webインターフェイスを介して通知を作成するには:

1. NTT CPaaS Web インターフェイス (opens in a new tab)にログインします。
   
2. [開発者ツール] > [サブスクリプション管理]** に移動します。
   
3. [通知プロファイル] タブを開きます。
   
4. **[通知プロファイルの作成] を選択します。
   
5. プロファイル情報を入力します。
   • 通知プロファイル名: 文字、ダッシュ、またはアンダースコアを使用します。スペースや特殊記号は使用できません。
   • Webhook URL: イベント通知を受信する宛先 URL。
   
   
6. (オプション)エキスパートパラメータを追加します。
   • 応答本文の正規表現: 応答本文に表示する必要があるテキスト パターン
   • 応答正規表現: 想定される HTTP 状態コード
   
   
7. (オプション)セキュリティ設定 で、既存の 認証設定 を選択するか、新しい認証設定を作成します。
   • Basic、HMAC、または 0Auth を選択します。
   • 選択したタイプに必要な資格情報または設定を指定します。
   手記

   Webhook エンドポイントを保護するために、少なくとも基本認証を使用することをお勧めします。詳細については、認証設定の作成セクションを参照してください。

   
   
8. (オプション)必要に応じて、既存の 証明書 を適用します。
   
9. (オプション)詳細設定を構成します。
   • 最大バケット サイズ (1–2000): 要求あたりの最大メッセージ数
   • ウィンドウ サイズ (20–10000): 同時接続数
   • 接続タイムアウト (300–30000 ms): 接続タイムアウト
   • 読み取りタイムアウト (1000–90000 ms): 読み取りタイムアウト
   • 有効な SSL プロトコル: TLS v1.2、TLS v1.3
   • ヘッダー: ヘッダーとして送信されるキーと値のペア
   • レート制限 (1–5000): 要求数/秒
   
   
10. [保存] を選択して、通知プロファイルを保存します。

通知プロファイルを管理する

Web インターフェイスで通知プロファイルの概要を表示または変更するには、次の手順を実行します。

1. NTT CPaaS Web インターフェイス (opens in a new tab)にログインします。
   
2. [開発者ツール] > [サブスクリプション管理]** に移動します。
   
3. [通知プロファイル] タブを開き、検索 バーを使用してサブスクリプションを見つけます。
   
4. 認証設定の横にある 3 ドット メニューを選択し、[編集] を選択します。
   • 認証設定の概要を表示するには、[表示] を選択します。
   
   
5. 必要な変更を行います。
   
6. Update (更新) を選択します。

通知プロファイルの削除

通知プロファイルを削除する場合は、このアクションが他の構成済み設定に影響を与える可能性があることに注意してください。サブスクリプション階層を確認して、削除ルールを理解することが重要です。通知プロファイルを削除すると、それに関連付けられている他のコンポーネントに影響を与える可能性があるため、注意してください。

Web インターフェイスでサブスクリプションを削除するには、次の手順に従います。

1. NTT CPaaS Web インターフェイス (opens in a new tab)にログインします。

2. [開発者ツール] > [サブスクリプション管理]** に移動します。

3. [通知プロファイル] タブを開き、検索 バーを使用してサブスクリプションを見つけます。

4. サブスクリプションの横にある 3 ドット メニューを選択し、[削除] を選択します。

スタンドアロン通知プロファイル

スタンドアロン通知プロファイル は、独立して動作し、どのサブスクリプションにもリンクされていない通知プロファイルです。スタンドアロン プロファイルは、URLが API 要求または Webhook パラメーターで直接指定されている場合の通知動作を管理するために使用されます。

スタンドアロン通知プロファイルには、次の 2 つのタイプがあります。

スタンドアロン通知プロファイルは、トラフィックが "notifyURL" や Webhook URL などのパラメーターを使用して API 経由で送信されたときにトリガーされます。これらの値は、配信レポート (DLR) などのイベントの送信先を指定します。

API 要求に URL が含まれる場合、システムはスタンドアロン通知プロファイルを使用して、これらのイベントの処理方法と転送方法を決定し、一致したプロファイルで定義されている詳細設定、証明書、またはセキュリティ構成を適用します。

使用例

クライアントは SMS v3 API (opens in a new tab) を使用し、API要求に次の Webhook 構成を含めて、分散論理ルーターの送信先を指定します。

"webhooks": {
    "delivery": {
        "url": "https://www.example.com/sms/advanced"
    },
    "contentType": "application/json",
    "callbackData": "DLR callback data"
}

スタンドアロン通知プロファイルの処理ロジック

認証設定の作成と管理

認証設定では、Webhook エンドポイントに通知を送信するときの NTT CPaaS の認証方法を定義します。システム要件に応じて、基本認証、HMAC 署名、または 0Auth を使用できます。

NTT CPaaS Web インターフェイス または サブスクリプション API - セキュリティ (opens in a new tab) を使用して、認証設定を作成、再利用、または削除できます。認証設定は、通知プロファイルを通じて適用されます。

ユースケースによっては、新しい通知プロファイルを設定するときに認証設定を作成することを選択できます。この場合、認証設定が作成されると、サブスクリプション管理 領域の [認証設定] タブに認証設定が表示されます。

複数の通知プロファイルで1つの認証設定を使用するシナリオでは、スタンドアロンの認証設定を作成できます。

認証設定の作成

Webインターフェイスで認証設定を作成するには:

1. NTT CPaaS Web インターフェイス (opens in a new tab)にログインします。
   
2. [開発者ツール] > [サブスクリプション管理]** に移動します。
   
3. [認証設定] タブを開きます。
   
4. [認証設定の作成] を選択します。
   
5. セキュリティ設定名を入力します。
   • 文字、ダッシュ、またはアンダースコアを使用します。スペースや特殊記号は使用できません。
   
   
6. 認証の種類 を選択します。
   • 基本: ユーザー名とパスワードを入力します。
   • HMAC: HMAC 署名と HMAC アルゴリズムの計算に使用する秘密鍵を指定します。
   • 0認証: アクセストークンを取得するためのトークンURLとグラントタイプ(アクセストークンを取得するメソッド)を追加します。必要に応じて、クライアント ID、クライアント シークレット、クライアント スコープ、およびリソースを追加します。また、システムの必要に応じてカスタムヘッダーを追加することもできます。
   
   
7. **[保存] を選択して、認証設定を保存します。

認証設定の管理

Web インターフェイスで通知設定の概要を表示または変更するには、次の手順に従います。

1. NTT CPaaS Web インターフェイス (opens in a new tab)にログインします。
   
2. [開発者ツール] > [サブスクリプション管理]** に移動します。
   
3. [認証設定] タブを開き、検索 バーを使用して設定を見つけます。
   
4. サブスクリプションの横にある 3 ドット メニューを選択し、[編集] を選択します。
   • 通知プロファイルの概要を表示するには、[表示] を選択します。
   
   
5. 必要な変更を行います。
   
6. Update (更新) を選択します。

認証設定の削除

認証設定を削除する場合は、このアクションが他の構成済み設定に影響を与える可能性があることに注意してください。サブスクリプション階層を確認して、削除ルールを理解することが重要です。認証設定を削除すると、それに関連付けられている他のコンポーネントに影響を与える可能性があるため、注意してください。

Web インターフェイス で認証設定を削除するには、次の手順に従います。

1. NTT CPaaS Web インターフェイス (opens in a new tab)にログインします。

2. [開発者ツール] > [サブスクリプション管理]** に移動します。

3. [認証設定] タブを開き、検索 バーを使用してサブスクリプションを検索します。

4. 認証設定の横にある 3 ドット メニューを選択し、[削除] を選択します。

証明書の作成と管理

証明書を使用すると、相互トランスポート層セキュリティ (mTLS) を介して Webhook 通信をセキュリティで保護できます。有効にすると、NTT CPaaS とシステムの両方がデジタル証明書を使用して相互に認証されます。これにより、イベント通知は信頼できるエンドポイントとのみ交換されます。

相互TLS(mTLS)を使用すると、最初のSSL/TLSハンドシェイク中に両者が互いを認証できます。標準 TLS では、クライアントのみがサーバーの証明書を検証してサーバーを認証しますが、サーバーはクライアントを検証しません。つまり、サーバーは、ユーザー名/パスワードなどの追加の認証メカニズムが設定されている場合でも、接続するすべてのクライアントを信頼します。mTLSでは、サーバーとクライアントの両方が証明書を交換し、それぞれが相手の真正性を検証できるようにします。

一般的なサブスクリプションでは、NTT CPaaS は標準の HTTPS を使用して Webhook URL にイベント通知を送信します。mTLSが有効な場合:

• NTT CPaaS はクライアントとして機能します。
• システムがサーバーとして機能します。
• システムは NTT CPaaS の証明書を検証し、NTT CPaaS は自分の証明書を検証します。

これを行うには、クライアント証明書をNTT CPaaSにアップロードし、通知プロファイルに添付する必要があります。

証明書は通知プロファイルに添付され、サブスクリプション管理 インターフェイスまたは サブスクリプション API - 証明書 (opens in a new tab) を使用して管理できます。

証明書を作成する

Webインターフェイスで証明書を作成するには:

1. NTT CPaaS Web インターフェイス (opens in a new tab)にログインします。
   
2. [開発者ツール] > [サブスクリプション管理]** に移動します。
   
3. [証明書] タブを開きます。
   
4. **[証明書の作成] を選択します。
   
5. 証明書情報を入力します。
   • 証明書名を入力します。文字、数字、ダッシュ、またはアンダースコアを使用します。スペースや特殊記号は使用しないでください。
   • 証明書の内容を貼り付けます。
   • パスフレーズを追加します。
   
   
6. 保存 を選択して証明書を保存します。

証明書が NTT CPaaS プラットフォームと同期されたら (証明書ステータスの取得 (opens in a new tab)APIリクエストを使ってこれを確認できます)、ウェブフックが構成されているサブスクリプション 通知プロファイル にそれを適用します。

そのウェブフックに送信されるイベントは、アップロードされた証明書を使ってmTLS接続を確立します。

証明書の管理と削除

Webインターフェイスで証明書を表示するには:

1. NTT CPaaS Web インターフェイス (opens in a new tab)にログインします。
   
2. [開発者ツール] > [サブスクリプション管理]** に移動します。
   
3. [証明書] タブを開きます。
   • 作成またはアップロードされたすべての証明書のリストが表示されます。
   
   
4. 証明書を削除するには、証明書の横にある 3 ドット メニューを選択し、[削除] を選択します。