始める前に

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

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

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

前提条件

先に進む前に Vonageアカウントの作成 アプリケーションと Numbers を管理する。

アプリケーションの作成

に行く。 アプリケーションのページをダッシュボードに表示し Name あなたのApplicationsのために。

An example of brand new application

をクリックしてください。 公開鍵と秘密鍵の生成 ボタンをクリックし、ファイル private.key のあたりだ。

次に 声 ケイパビリティを持つ。 当面は、すべてデフォルトのままにしておいてください。

An example of enabling Voice capabilities

最後に 新規アプリケーションの作成 ページの一番下にある

チェックアウト Vonage CLIを始める CLIのインストールと設定方法の詳細については、こちらを参照してください。

Vonageアプリケーションを作成するには、次のコマンドを使用します：

vonage apps create 'Your application'

✅ Creating Application
Saving private key ... Done!
Application created

Name: Your application
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set

Capabilities:
  None Enabled

vonage apps create 'Your application'

✅ Creating Application
Saving private key ... Done!
Application created

Name: Your application
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set

Capabilities:
  None Enabled
vonage apps create 'Your application' ✅ Creating Application Saving private key ... Done! Application created Name: Your application Application ID: 00000000-0000-0000-0000-000000000000 Improve AI: Off Private/Public Key: Set Capabilities: None Enabled

アプリケーションができたら、次に voice WebhookのURLを自分のものに置き換えてください：

vonage apps capabilities update 00000000-0000-0000-0000-000000000000 voice `
  --voice-answer-url='https://example.com/webhooks/voice/answer' `
  --voice-event-url='https://example.com/webhooks/voice/event' `
  --voice-fallback-url='https://example.com/webhooks/voice/fallback'
  
✅ Fetching Application
✅ Adding voice capability to application 00000000-0000-0000-0000-000000000000

Name: Your application
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set

Capabilities:
 VOICE:
    Uses Signed callbacks: On
    Conversation TTL: 41 hours
    Leg Persistence Time: 6 days
    Event URL: [POST] https://example.com/webhooks/voice/event
    Answer URL: [POST] https://example.com/webhooks/voice/answer
    Fallback URL: [POST] https://example.com/webhooks/voice/fallback

vonage apps capabilities update 00000000-0000-0000-0000-000000000000 voice ^
  --voice-answer-url='https://example.com/webhooks/voice/answer' ^
  --voice-event-url='https://example.com/webhooks/voice/event' ^
  --voice-fallback-url='https://example.com/webhooks/voice/fallback'
  
✅ Fetching Application
✅ Adding voice capability to application 00000000-0000-0000-0000-000000000000

Name: Your application
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set

Capabilities:
 VOICE:
    Uses Signed callbacks: On
    Conversation TTL: 41 hours
    Leg Persistence Time: 6 days
    Event URL: [POST] https://example.com/webhooks/voice/event
    Answer URL: [POST] https://example.com/webhooks/voice/answer
    Fallback URL: [POST] https://example.com/webhooks/voice/fallback
vonage apps capabilities update 00000000-0000-0000-0000-000000000000 voice \ --voice-answer-url='https://example.com/webhooks/voice/answer' \ --voice-event-url='https://example.com/webhooks/voice/event' \ --voice-fallback-url='https://example.com/webhooks/voice/fallback' ✅ Fetching Application ✅ Adding voice capability to application 00000000-0000-0000-0000-000000000000 Name: Your application Application ID: 00000000-0000-0000-0000-000000000000 Improve AI: Off Private/Public Key: Set Capabilities: VOICE: Uses Signed callbacks: On Conversation TTL: 41 hours Leg Persistence Time: 6 days Event URL: [POST] https://example.com/webhooks/voice/event Answer URL: [POST] https://example.com/webhooks/voice/answer Fallback URL: [POST] https://example.com/webhooks/voice/fallback

アプリケーションはその後作成され、必要な機能を持ちます。アプリケーションの作成とアプリケーション機能の追加については 申請書類.

番号を借りる

ダッシュボードで ナンバーズを買う ページをご覧ください。 必ず 声 を検索フィルターに入力し、番号を購入したい国を選択してください。国によっては、追加の書類が必要な場合があるため、番号をリクエストする必要があります。

An example of number research

をクリックします。 購入 ボタンをクリックし、購入手続きを行ってください。

おめでとうございます！あなたのバーチャルナンバーが あなたのナンバーズ.

Vonage CLIを使用して番号をレンタルできます。次のコマンドは、米国で利用可能な番号を検索します：

vonage numbers search US

✅ Searching for numbers

There is 1 number available for purchase in United States

Number       Type    Features         Monthly Cost  Setup Cost
-----------  ------  ---------------  ------------  ----------
16127779311  Mobile  MMS, SMS, VOICE  €0.90         €0.00

Use vonage numbers buy to purchase.

vonage numbers search US

✅ Searching for numbers

There is 1 number available for purchase in United States

Number       Type    Features         Monthly Cost  Setup Cost
-----------  ------  ---------------  ------------  ----------
16127779311  Mobile  MMS, SMS, VOICE  €0.90         €0.00

Use vonage numbers buy to purchase.
vonage numbers search US ✅ Searching for numbers There is 1 number available for purchase in United States Number Type Features Monthly Cost Setup Cost ----------- ------ --------------- ------------ ---------- 16127779311 Mobile MMS, SMS, VOICE €0.90 €0.00 Use vonage numbers buy to purchase.

Numbers を購入するにはこのコマンドを使用する：

vonage numbers buy US 16127779311 
✅ Searching for numbers
Are you sure you want to purchase the number 16127779311 for €0.90? [y/n] y

✅ Purchasing number
Number 16127779311 purchased

Number: 16127779311 
Country: 🇺🇸 United States
Type: Mobile
Features: MMS, SMS, VOICE
Monthly Cost: €0.90
Setup Cost: €0.00
Linked Application ID: Not linked to any application
Voice Callback: Not Set
Voice Callback Value: Not Set
Voice Status Callback: Not Set

vonage numbers buy US 16127779311 
✅ Searching for numbers
Are you sure you want to purchase the number 16127779311 for €0.90? [y/n] y

✅ Purchasing number
Number 16127779311 purchased

Number: 16127779311 
Country: 🇺🇸 United States
Type: Mobile
Features: MMS, SMS, VOICE
Monthly Cost: €0.90
Setup Cost: €0.00
Linked Application ID: Not linked to any application
Voice Callback: Not Set
Voice Callback Value: Not Set
Voice Status Callback: Not Set
vonage numbers buy US 16127779311 ✅ Searching for numbers Are you sure you want to purchase the number 16127779311 for €0.90? [y/n] y ✅ Purchasing number Number 16127779311 purchased Number: 16127779311 Country: 🇺🇸 United States Type: Mobile Features: MMS, SMS, VOICE Monthly Cost: €0.90 Setup Cost: €0.00 Linked Application ID: Not linked to any application Voice Callback: Not Set Voice Callback Value: Not Set Voice Status Callback: Not Set

指定する 2文字の国コード を購入する。 他国で番号を購入する。

Numbersをリンクする

これでアプリケーションとナンバーの両方が揃ったので、両者をリンクさせる必要がある。

に行く。 アプリケーション ページを開き、先ほど作成したアプリケーションをクリックします。

An example of an application

の中で 声 セクションで リンク ボタンをクリックします。

これでアプリケーションとナンバーの両方が揃ったので、両者をリンクさせる必要がある。

vonage apps numbers link 00000000-0000-0000-0000-000000000000 16127779311

✅ Fetching Application
Fetching Owned numbers [===============================================] 1/1 100%

Number linked

Number: 16127779311
Country: 🇺🇸 United States
Type: Toll-free
Features: MMS, SMS, VOICE
Monthly Cost: Not Set
Setup Cost: Not Set
Linked Application ID: 00000000-0000-0000-0000-000000000000
Voice Callback: app
Voice Callback Value: 00000000-0000-0000-0000-000000000000
Voice Status Callback: Not Set

vonage apps numbers link 00000000-0000-0000-0000-000000000000 16127779311

✅ Fetching Application
Fetching Owned numbers [===============================================] 1/1 100%

Number linked

Number: 16127779311
Country: 🇺🇸 United States
Type: Toll-free
Features: MMS, SMS, VOICE
Monthly Cost: Not Set
Setup Cost: Not Set
Linked Application ID: 00000000-0000-0000-0000-000000000000
Voice Callback: app
Voice Callback Value: 00000000-0000-0000-0000-000000000000
Voice Status Callback: Not Set
vonage apps numbers link 00000000-0000-0000-0000-000000000000 16127779311 ✅ Fetching Application Fetching Owned numbers [===============================================] 1/1 100% Number linked Number: 16127779311 Country: 🇺🇸 United States Type: Toll-free Features: MMS, SMS, VOICE Monthly Cost: Not Set Setup Cost: Not Set Linked Application ID: 00000000-0000-0000-0000-000000000000 Voice Callback: app Voice Callback Value: 00000000-0000-0000-0000-000000000000 Voice Status Callback: Not Set

その他のリソース

交換可能な変数

汎用交換可能

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

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

JWT

Used to authenticate your request. See Authentication for more information, including how to generate a JWT.

Numbers

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

キー説明
VONAGE_VIRTUAL_NUMBER

Your Vonage Number. E.g. 447700900000

VOICE_TO_NUMBER

The recipient number to call, e.g. 447700900002.

UUID

UUIDは通常、特定の呼び出しを識別するためにコード・スニペットで使用される。

キー説明
VOICE_CALL_ID

The UUID of the call leg.

特定の交換可能変数

コード・スニペットによっては、より特殊な変数があり、それを実際の値で置き換える必要がある。 実際の値に置き換える必要があります。これらはコード・スニペットごとに指定することができます。

認証

Voice APIでは、JWTを使った認証が必要です。JWTは Vonage CLI または オンラインツール.

ウェブフック

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

  • /webhooks/answer - Vonageはインバウンドコールを受信すると、ここでGETリクエストを行います。あなたはNCCOで応答する。
  • /webhooks/event - イベントが発生すると、Vonage はここで POST リクエストを行います。JSONイベントを受け取ります。
  • /webhooks/recordings - 録画が利用可能になると、VonageはここでPOSTリクエストを行います。録画の詳細を含むJSONオブジェクトを受け取ります。
  • /webhooks/dtmf - Vonage はユーザの DTMF 入力を JSON オブジェクトでここに POST する。

Ngrok を使用している場合は、Vonage Application オブジェクトの Webhook URL を次のように設定します。 に設定します：

  • https://demo.ngrok.io/webhooks/answer
  • https://demo.ngrok.io/webhooks/event
  • https://demo.ngrok.io/webhooks/recordings
  • https://demo.ngrok.io/webhooks/dtmf

変更 demo を、あなたのケースに当てはまるものに置き換えてください。