Vonage CLIを使ったアプリケーションの管理

Vonage CLI を使用すると、Vonage アプリケーションを作成および管理できます。ヘルプを表示するには vonage apps --help 一度 CLIがインストールされたら、それを使うことができる。ほとんどのvonageコマンドと同様に --json そして --yaml フラグを フラグを指定する。

アプリケーションのリスト

デフォルトでは vonage apps と同じサブコマンドが実行される。 vonage apps list.いくつかのフラグがあります。 があります：

  • app-name - アプリケーション名によるフィルタリングが可能
  • capability - 能力でアプリケーションをフィルタリングします。カンマ , のどちらか、またはプラスを意味する。 + の両方が必要であることを意味する。
vonage apps

✅ Loading applications... Done

App ID                                Name               Capabilities
------------------------------------  -----------------  ------------------------------------------------------
00000000-0000-0000-0000-000000000000  Application        None
00000000-0000-0000-0000-000000000000  voice Application  Messages, Voice
00000000-0000-0000-0000-000000000000  All enabled        Messages, Network APIs, RTC, VBC, Verify, Video, Voice

アプリケーションの詳細を表示

について show サブコマンドは、特定のアプリケーションの詳細を取得することができます。コマンドのフォーマットは vonage apps show <id> どこ <id> はアプリケーションのUUIDである。

注：この操作では公開鍵は表示されません。公開鍵を表示する必要がある場合は --json または --yaml フラグ いかなる情報も編集しない

vonage apps show 00000000-0000-0000-0000-000000000000

✅ Fetching application

Name: All enabled
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: [GET] https://example.com/voice/event
    Answer URL: [GET] https://example.com/voice/answer
    Fallback URL: [GET] https://example.com/voice/fallback
  
  MESSAGES:
    Authenticate Inbound Media: On
    Webhook Version: v1
    Status URL: [POST] https://example.com/meetings/status
    Inbound URL: [POST] https://example.com/meetings/inbound
  
  VERIFY:
    Webhook Version: v2
    Status URL: [POST] https://example.com/verify2/status
  
  RTC:
    Event URL: [POST] https://example.com/rtc/event
    Uses Signed callbacks: On
  
  VIDEO:
    Archive Status URL: [POST] https://example.com/video/archive-status
    Archive Status Signature Secret: archive status
    Broadcast Status URL: [POST] https://example.com/video/broadcast-status
    Broadcast Status Signature Secret: broadcast status
    Caption Status URL: [POST] https://example.com/video/caption-status
    Caption Status Signature Secret: caption-status
    Connection Created URL: [POST] https://example.com/video/connected-created
    Connection Created Signature Secret: connection created
    Connection Destroyed URL: [POST] https://example.com/video/connection-destroyed
    Connection Destroyed Signature Secret: connection destroyed
    Render Status URL: [POST] https://example.com/video/render-status
    Render Status Signature Secret: render status
    SIP Call Created URL: [POST] https://example.com/video/sip1
    SIP Call Created Signature Secret: Off
    SIP Call Destroyed URL: [POST] https://example.com/video/sip3
    SIP Call Destroyed Signature Secret: Off
    SIP Call Mute Forced URL: [POST] https://example.com/video/sip4
    SIP Call Mute Forced Signature Secret: Off
    SIP Call Updated URL: [POST] https://example.com/video/sip2
    SIP Call Updated Signature Secret: Off
    Stream Created URL: [POST] https://example.com/video/stream-created
    Stream Created Signature Secret: stream created
    Stream Destroyed URL: [POST] https://example.com/video/stream-destroyed
    Stream Destroyed Signature Secret: stream destroyed
  
    RECORDINGS STORAGE:
      Cloud Storage: On
      Storage Type: AmazonS3
      Credential: manchuck_aws_bucket
      End to End Encryption: On
      Server Side Encryption: On
  
  NETWORK APIS:
    Redirect URL: [GET] https://example.com/gnp/redirect
  
  NB: VBC capabilities is not supported through the command line.

アプリケーションの作成

について create サブコマンドを使用すると、アプリケーションを作成できます。以前のバージョンのCLIでは、アプリケーションの機能を設定することもできました。 しかし、CLIのバージョン3では、この機能は削除されました。 以下.アプリケーション名 CLIがアプリケーション名を生成しなくなったため、アプリケーション名を渡す必要があります。 vonage apps create <name> 以下のパラメータ/フラグを持つようになった：

  • public-key-file - アプリケーションで使用したい公開鍵ファイルへのリンク。
  • private-key-file - 生成された秘密鍵を保存する場所へのフルパス。 public-key-file).
  • improve-ai - vonageがAIモデルを訓練するために、このアプリケーション・データを使えるようにする。

注: お客様が独自のキーを提供しない場合、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

アプリケーションの更新

アプリケーションを作成した後、名前を更新したり、AIを改善したり、新しい公開鍵を設定したりすることができます。 vonage apps update <id> と同じフラグを持つ。 vonage apps create ただし private-key-file.

vonage apps update 00000000-0000-0000-0000-000000000000 `
  --name="New Application Name"
  
✅ Fetching Application
✅ Updating Application

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

アプリケーションの削除

アプリケーションを削除するには、次のコマンドを実行します。 vonage apps delete <id>ここで id はアプリケーションのUUIDである：

vonage apps delete 00000000-0000-0000-0000-000000000000

✅ Fetching application
Delete application New Name (7d7133ab-de4e-4b7a-8e1e-376670077c71)? [y/n] 
✅ Deleting application

アプリケーションの機能管理

以前のバージョンのCLIでは、アプリケーションのケイパビリティを変更したい場合、すべての値を渡す必要がありました。 これは、現在の値を覚えておく必要があることを意味します。 を含めなかったり、間違った値を入力したりすると、ケーパビリティは期待通りに機能しませんでした。CLIのバージョン3では、次のように解決されている。 アプリケーション・ケイパビリティを管理するための新しいサブコマンドを持つことで、これを解決しています。コマンドの書式は次のとおりです。 です： vonage apps capabilities <action> <id> <which> [flags].

アプリケーションのNumbers管理

CLIのバージョン3では、アプリケーションのNumbersを簡単に管理することができます。主なコマンドは2つ： vonage apps numbers list <id>そして vonage apps numbers <link|unlink> <id> <msisdn>.これらのコマンドを使うことで Numbers が正しくリンクされていることを保証します。

アプリケーションにリンクされたNumbersをリストする

アプリケーションにリンクされているすべての Numbers をリストアップするには、次のコマンドを実行するだけです。 vonage apps numbers list <id> どこ id はアプリケーションのUUIDである。 です。もし --fail フラグが立っている場合、このコマンドはコード 1 アプリケーションに どちらか messages または voice の能力がある。

注：リンクしているすべての番号を表示します。リンクしている番号の数によっては時間がかかる場合があります。 時間がかかる場合があります。

vonage apps numbers list 00000000-0000-0000-0000-000000000000

✅ Fetching Application
Fetching numbers linked to application Your application [==============] 1/1 100%

There is 1 number linked:

Number       Country             Type       Features       
-----------  ------------------  ---------  ---------------
16127779311  🇺🇸 United States    Mobile     MMS, SMS, VOICE

アプリケーションへの番号のリンク/リンク解除

Numbersは、以下の方法でリンクできます。 vonage apps <link|unlink> <id> <msisdn>.

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

参考