始める前に

このトピックでは、コード・スニペットを使用するための背景情報を提供します。

コード・スニペットとは？

コード・スニペットは、自分のアプリケーションで再利用できる短いコードの断片です。

コード・スニペットは Vonageノードコードスニペット そして Vonage Curl コード・スニペット リポジトリ。

コード・スニペットを最適に使用するために、この情報をよくお読みください。

前提条件

  1. Vonage APIアカウントの作成
  2. ノードJSのインストール - Vonageコマンドラインインタフェース（CLI）を使用するために必要です。
  3. Vonage CLIをインストールする
  4. ノードサーバーSDKのインストール - を使用する場合のみ必要です。
  5. ウェブフックの設定.
  6. Webhookサーバーの書き方
  7. Webhookサーバーをローカルでテストする方法を知る

交換可能な変数

汎用交換可能

以下の置き換え可能な情報は、ライブラリーと特定の呼び出しによって異なります：

キー説明
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_APPLICATION_PRIVATE_KEY_PATH

Private key path.

VONAGE_APPLICATION_PRIVATE_KEY

Private key.

VONAGE_APPLICATION_ID

The Vonage Application ID.

Numbers

電話番号はすべてE.164形式です。

キー説明
VONAGE_NUMBER

Your Vonage Number. E.g. 447700900000

FROM_NUMBER

Replace with number you are sending from. E.g. 447700900002

TO_NUMBER

Replace with the number you are sending to. E.g. 447700900001

特定の交換可能変数

一部のコード・スニペットには、FacebookページIDのような特殊な変数があり、実際の値に置き換える必要があります。必要な場合は、コード・スニペットごとに指定します。

ウェブフック

ここで出会う主な人物は以下の通りだ：

  • /webhooks/messages/inbound - Vonageがメッセージを受信すると、ここにコールバックが届きます。
  • /webhooks/messages/status - Vonageがメッセージステータスの更新を受信すると、ここでコールバックを受け取ります。

を使用してローカルでテストしている場合 ングロク の場合、Vonage Application オブジェクトに以下の例のような形式で Webhook URL を設定します：

  • https://demo.ngrok.io/webhooks/messages/inbound
  • https://demo.ngrok.io/webhooks/messages/status

変更 demo を、Ngrokが生成するURLと置き換えてください。

注： アプリケーションをテストする前に、Webhook URLが設定され、Webhooksサーバーが起動していることを確認してください。

ヒント クライアントSDKとサーバーSDKが必要に応じてJWTを生成するので、Curlでテストする場合のみ、この手順を実行する必要があります。

Vonage API Applicationsを作成すると、アプリケーションIDと秘密鍵ファイルを使用することができます、 private.key, でJWTを生成する。

を使用してJWTトークンを作成するには Vonage CLI次のコマンドを使用する。

# A command with parameters
vonage jwt create `
--app-id='00000000-0000-0000-0000-000000000000' `
--private-key=./private.key

# Will produce a token
eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MzYyODE5NDYsImp0aSI6IjBmZjcwZDNmLTAzN2EtNGY4MC04ODZjLWI3MmM3MmQyMWNmMiIsImlhdCI6MTczNjI4MTA0NiwiYXBwbGljYXRpb25faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAifQ.gA7jClpqaZ2OoS0iri-zGCbda4jO7C0M8mka0EnSyjlds1EeY8fNoBEx3FTXHfkkzzrj0TskrWc_dcs1wuM8Kx55c5rLQ7taVpDAYopKSc_CeeOaad8S6aWnRkTUTNeduO4aIn-0CbyRTluBYsH1RBqYBQvobuQIDEwbFw8xBgx0UfREMMN6DAWknR57eiVXN9x_oD6CGQJ1yV3025nGboeMsP9YgX4Nwc-rE2r8c1ZGwCLO81x8i19Qil3Nwu5q1nzouyavQjIw00B_TZkushnI1ufdi_GNqk-h5q2HvGkg7Pj9bVkZHFdVTO8im03JYNyJmcV83vnpjOLuCFRzxQ

または JWTウェブアプリ を使ってJWTを生成する。

ヒント 生成されたJWTは以下でテストできます。 jwt.io