API設定

API設定ページでは、API認証情報の管理、Webhookの設定、SMS APIの動作制御を行うことができます。各APIキーには、それぞれ固有の認証情報と設定があります。

Dashboard API Settings

アクセスAPI設定

  1. Vonage Dashboardにログインします。
  2. に移動する。 設定 → API設定 の左サイドバーにある。
  3. 上部でAPIキーを選択します。

APIキーを選択したら

さらにAPIキーが必要ですか？ クリック APIキーの追加リクエスト を使用して、さまざまな環境やユースケースに対応する追加キーを作成することができます。

APIキーとシークレット

あなたの APIキー は、ページ上部のAccountドロップダウンに表示されます。これはAPIリクエストで使用される公開識別子です。また、このアカウントにニックネームを付けて、プラットフォーム全体で識別することもできます（例："Production"、"Development"、"Testing"）。

あなたの APIの秘密 に表示されている。 APIキーの秘密 セクションを参照されたい：

  • APIシークレット1 - プライマリ認証シークレット（デフォルトではマスクされています）
  • APIシークレット2 - 回転のための第二の秘密（デフォルトではマスクされている）

まだ2つ目のAPIシークレットをお持ちでない場合は、ここで「新しいシークレットを作成」リンクをクリックして作成することができます。

Messages API タイプ

Vonage がこの API キーの SMS メッセージをどのように処理するかを設定します。

Messaging API Type

VonageにはSMSを送信するための2つの異なるAPIがあります。受信するウェブフックの形式が変わるため、一度に1つしか使用できません。

APIを選択してください：

  • SMS API - よりシンプルなウェブフック形式（GETまたはPOST）のレガシーAPI
  • Messages API - JSONウェブフックによる最新のマルチチャネルAPI

適切なボタンをクリックして、使用するAPIを選択します。

NumbersごとのWebhook： をクリックすると、Vonage番号ごとに異なる受信ウェブフックを設定できます。 管理する にある。 Numbersのページ.

SMS API

Webhookフォーマット

SMS APIのみを選択し、配信受領（DLR）ウェブフックのフォーマットを選択します：

  1. をクリックする。 Webhookフォーマット ドロップダウン。
  2. から選ぶ：
    • ゲット - URLクエリパラメータとして送信されるWebhookデータ
    • ポスト - フォームエンコードされたボディとして送信されるWebhookデータ
    • POST-JSON - JSONボディとして送信されるWebhookデータ（推奨）

デリバリーレシート（DLR）ウェブフック

送信SMSメッセージの配信状況アップデートを受け取る。

  1. の中で 納品書（DLR）ウェブフック フィールドにウェブフックのURLを入力します。
  2. 例 https://example.com/webhooks/delivery-receipt
  3. SMSが配信されると（または失敗すると）、VonageはこのURLにアップデートを送信します。

ウェブフックのペイロードの詳細については SMS API ウェブフック リファレンス.

インバウンドSMSウェブフック

誰かがあなたのVonage番号にSMSを送信したときに通知を受け取ります。

  1. の中で インバウンドSMSウェブフック フィールドにウェブフックのURLを入力します。
  2. 例 https://example.com/webhooks/inbound-sms
  3. 誰かがあなたのVonage番号にメールを送ると、そのメッセージはこのURLに転送されます。

ウェブフックのペイロードの詳細については SMS API 受信メッセージリファレンス.

Messages API

注： これらの設定は、Messages APIを使用する際のデフォルトのWebhookのためのものです。セキュリティと柔軟性を高めるために、アプリケーションで Webhook を設定することをお勧めします。 Messages API ドキュメント.

ステータスウェブフック

送信メッセージのステータスアップデートを受け取る。

  1. の中で ステータスウェブフック フィールドにウェブフックのURLを入力します。
  2. 例 https://example.com/webhooks/status-updates
  3. 送信したメッセージのステータスが変更されると、VonageはこのURLにアップデートを送信します。

ウェブフックのペイロードの詳細については Messages API ウェブフック リファレンス.

インバウンド・ウェブフック

顧客からメッセージが送信されたら通知を受け取ります。

  1. の中で インバウンド・ウェブフック フィールドにウェブフックのURLを入力します。
  2. 例 https://example.com/webhooks/inbound-message
  3. 誰かがあなたのMessages APIチャンネル経由であなたにメッセージを送ると、そのメッセージはこのURLに転送されます。

ウェブフックのペイロードの詳細については Messages API インバウンドメッセージリファレンス.

署名入りウェブフック

Signed Webhooks

オプションのセキュリティ・レイヤーを追加して、WebhookリクエストがVonageからのもので、転送中に改ざんされていないことを確認します。

シグネチャー・シークレット

Webhook リクエストに含まれる署名を生成するために使用される秘密鍵。

  1. の中で 署名入りウェブフック セクションをご覧ください。 署名の秘密 (デフォルトではマスクされている）。
  2. をクリックする。 アイアイコン 秘密を明かすために。
  3. をクリックする。 コピーアイコン でクリップボードにコピーする。

署名方法

ウェブフック署名の作成に使用するアルゴリズムを選択します：

  1. をクリックする。 署名方法 ドロップダウン。
  2. から選ぶ：
    • MD5 HASH署名 (レガシー、推奨しない）
    • MD5 HMAC署名
    • SHA1 HMAC署名
    • SHA-256 HMAC署名 (おすすめ）
    • SHA-512 HMAC署名 (最も安全）

有効にすると、受信するWebhookリクエストは、認証ヘッダにJWTトークンを含み、このトークンはあなたの署名シークレットで署名されます。詳細はこちら 署名付きウェブフックの検証.

コンプライアンス

HIPAA番号

お客様のAccountがHIPAA準拠のNumbersを購入できるようになっている場合、以下の通知が表示されます：

このアカウントでHIPAA Numbersを購入できるようになりました。あなたの キャンペーンページ をクリックし、HIPAA準拠の番号をリクエストして有効にしてください。

お客様のユースケースでHIPAAコンプライアンスを有効にする必要がある場合は、Vonageアカウントマネージャーにお問い合わせください。