アプリケーションの管理
Vonage API アプリケーションには、Vonage エンドポイントに接続し、Vonage API を使用するために必要なセキュリティおよび設定情報が含まれています。作成された各Vonageアプリケーションは複数の機能をサポートすることができます。例えば、Voice API、Messages API、RTC APIの使用をサポートするアプリケーションを作成することができます。
Vonage CLI を使用して、アプリケーションの作成と管理、新しい機能の追加、Webhook 設定情報の更新を行うことができます。
アプリケーションの作成
について vonage apps create <name> コマンドでアプリケーションを作成できます。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 と同じサブコマンドが実行される。 vonage apps list.いくつかのフラグがあります。
があります:
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
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である。
注:この操作では公開鍵は表示されません。公開鍵を表示する必要がある場合は --show-all, --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.
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.
アプリケーションの更新
vonage apps update <id> では、既存のアプリケーションの名前を更新したり、Improve AI設定を変更したり、新しい公開鍵を設定したりすることができます:
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 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
vonage apps delete 00000000-0000-0000-0000-000000000000
✅ Fetching application
Delete application New Name (7d7133ab-de4e-4b7a-8e1e-376670077c71)? [y/n]
✅ Deleting application