能力の管理

について vonage apps capabilities コマンドは、アプリケーションに関連するVonage API機能の追加、更新、削除に使用できます。

能力の追加と更新

アプリケーションに新しいケイパビリティを追加したり、アプリケーションがすでに使用するように設定されているケイパビリティの設定を更新したりするには、次のコマンドを実行します。 vonage apps capabilities update <application-id> <capability>.

各APIには、関連する設定を構成するための異なるフラグのセットがある。各APIのフラグのリストは、以下の関連セクションにある。

ネットワークの特徴

フラッグ 説明 タイプ
--network-app-id ネットワーク登録申請ID ストリング
--network-redirect-url トークンの交換コードにリダイレクトするURL ストリング
vonage apps capabilities update 00000000-0000-0000-0000-000000000000 networkApis `
  --network-app-id'00000000-0000-0000-0000-000000000000' `
  --network-redirect-url='https://example.com/network/redirect'
  
✅ Fetching Application
✅ Adding network 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:
  NETWORK APIS:
    Redirect URL: [GET] https://example.com/network/redirect

メッセージ

フラッグ 説明 タイプ
--messages-inbound-url インバウンドメッセージ用URL ストリング
--messages-status-url ステータス・メッセージのURL ストリング
--messages-version ウェブフックデータのバージョン。v0.1 "または "v1 "のいずれかでなければなりません。 ストリング
--messages-authenticate-media インバウンドメディアの認証 ブーリアン
vonage apps capabilities update 00000000-0000-0000-0000-000000000000 messages `
  --messages-inbound-url='https://example.com/webhooks/messages/inbound' `
  --messages-status-url='https://example.com/webhooks/messages/status' `
  --messages-version='v1' \
  --messages-authenticate-media                                                                                                                                                                                 [boolean]
  
✅ Fetching Application
✅ Adding messages 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:
 MESSAGES:
    Authenticate Inbound Media: On
    Webhook Version: v1
    Status URL: [POST] https://manchuck.com/meetings/status
    Inbound URL: [POST] https://manchuck.com/meetings/inbound

Verify

フラッグ 説明 タイプ
--verify-status-url VerifyステータスメッセージのURL ストリング
vonage apps capabilities update 00000000-0000-0000-0000-000000000000 verify `
  --verify-status-url='https://example.com/webhooks/verify/status'
  
✅ 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:
 VERIFY:
    Webhook Version: v2
    Status URL: [POST] https://example.com/webhooks/verify/status

声

フラッグ 説明 タイプ
--voice-signed-callbacks 署名付きコールバックを有効にする ブーリアン
--voice-conversations-ttl 会話の有効期限（秒単位）
--voice-leg-persistence-time 脚の持続時間（日単位）
--voice-region すべての着信、プログラマブルSIPおよびSIPコネクトコールは、選択された地域に送信されます。通話が地域のエンドポイントを使用している場合、これはアプリケーションの設定を上書きします。 ストリング
--voice-answer-url アンサーウェブフックURLアドレス ストリング
--voice-answer-http アンサーウェブフックHTTPメソッド ストリング
--voice-answer-connection-timeout 応答接続タイムアウト
--voice-answer-socket-timeout 応答ソケットタイムアウト
--voice-event-url イベントウェブフックURLアドレス ストリング
--voice-event-http イベントWebhook HTTPメソッド ストリング
--voice-event-connection-timeout イベント接続タイムアウト
--voice-event-socket-timeout イベントソケットのタイムアウト
--voice-fallback-url フォールバックWebhook URLアドレス ストリング
--voice-fallback-http フォールバックWebhook HTTPメソッド ストリング
--voice-fallback-connection-timeout フォールバック接続タイムアウト
--voice-fallback-socket-timeout フォールバック・ソケットのタイムアウト 
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

ビデオ

フラッグ 説明 タイプ
--video-archive-status-url アーカイブのURL ストリング
--video-archive-status-secret アーカイブURLの秘密 ストリング
--video-broadcast-status-url ブロードキャスト・ステータスURL ストリング
--video-broadcast-status-secret ブロードキャストURLの秘密 ストリング
--video-captions-status-url キャプション・ステータスのURL ストリング
--video-captions-status-secret キャプション・ステータスの秘密 ストリング
--video-connection-created-url 作成された接続のURL ストリング
--video-connection-created-secret 作成された接続URLの秘密 ストリング
--video-connection-destroyed-url 破壊された接続のURL ストリング
--video-connection-destroyed-secret 破壊されたコネクションの秘密 ストリング
--video-render-status-url レンダリングステータスのURL ストリング
--video-render-status-secret レンダリングステータスの秘密 ストリング
--video-sip-call-created-url SIPで作成されたコールのURL ストリング
--video-sip-call-created-secret SIP用のシークレットを作成 ストリング
--video-sip-call-destroyed-url 破壊されたSIPのURL ストリング
--video-sip-call-destroyed-secret 破壊されたSIPの秘密 ストリング
--video-sip-call-mute-forced-url ミュートされたSIPコールのURL ストリング
--video-sip-call-mute-forced-secret コールミュートの秘密 SIP ストリング
--video-sip-call-updated-url 更新されたSIPのURL ストリング
--video-sip-call-updated-secret SIPのシークレットを更新 ストリング
--video-stream-created-url 作成されたストリームのURL ストリング
--video-stream-created-secret 作成されたストリームの秘密 ストリング
--video-stream-destroyed-url 破壊されたストリームのURL ストリング
--video-stream-destroyed-secret ストリーム破壊の秘密 ストリング
vonage apps capabilities update 00000000-0000-0000-0000-000000000000 video `
  --video-archive-status-url='https://example.com/video/archive-status' `
  --video-archive-status-secret='your status secret' `
  --video-broadcast-status-url='https://example.com/video/broadcast-status' `
  --video-broadcast-status-secret='your broadcast secret' `
  --video-captions-status-url='https://example.com/video/caption-status' `
  --video-captions-status-secret='your caption status secret' `
  --video-connection-created-url='https://example.com/video/connected-created' `
  --video-connection-created-secret='your connection created secret' `
  --video-connection-destroyed-url='https://example.com/video/connection-destroyed' `
  --video-connection-destroyed-secret='your connection destroyed secret' `
  --video-render-status-url='https://example.com/video/render-status' `
  --video-render-status-secret='yoru render status secret' `
  --video-sip-call-created-url='https://example.com/video/sip1' `
  --video-sip-call-created-secret='your sip created secret' `
  --video-sip-call-destroyed-url='https://example.com/video/sip3' `
  --video-sip-call-destroyed-secret='your sip destroyed secret' `
  --video-sip-call-mute-forced-url='https://example.com/video/sip4' `
  --video-sip-call-mute-forced-secret='your sip mute forced secret' `
  --video-sip-call-updated-url='https://example.com/video/sip2' `
  --video-sip-call-updated-secret='your sip updated secret' `
  --video-stream-created-url='https://example.com/video/stream-created' `
  --video-stream-created-secret='your stream created secret' `
  --video-stream-destroyed-url='https://example.com/video/stream-destroyed' `
  --video-stream-destroyed-secret='your stream destroyed secret
  
✅ Fetching Application
✅ Adding video 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:
 VIDEO:
    Archive Status URL: [POST] https://example.com/video/archive-status
    Archive Status Signature Secret: your status secret
    Broadcast Status URL: [POST] https://example.com/video/broadcast-status
    Broadcast Status Signature Secret: your broadcast secret
    Caption Status URL: [POST] https://example.com/video/caption-status
    Caption Status Signature Secret: your caption status secret
    Connection Created URL: [POST] https://example.com/video/connected-created
    Connection Created Signature Secret: your connection created secret
    Connection Destroyed URL: [POST] https://example.com/video/connection-destroyed
    Connection Destroyed Signature Secret: your connection destroyed secret
    Render Status URL: [POST] https://example.com/video/render-status
    Render Status Signature Secret: yoru render status secret
    SIP Call Created URL: [POST] https://example.com/video/sip1
    SIP Call Created Signature Secret: your sip created secret
    SIP Call Destroyed URL: [POST] https://example.com/video/sip3
    SIP Call Destroyed Signature Secret: your sip destroyed secret
    SIP Call Mute Forced URL: [POST] https://example.com/video/sip4
    SIP Call Mute Forced Signature Secret: your sip mute forced secret
    SIP Call Updated URL: [POST] https://example.com/video/sip2
    SIP Call Updated Signature Secret: your sip updated secret
    Stream Created URL: [POST] https://example.com/video/stream-created
    Stream Created Signature Secret: your stream created secret
    Stream Destroyed URL: [POST] https://example.com/video/stream-destroyed
    Stream Destroyed Signature Secret: your stream destroyed secret

能力の削除

ケーパビリティを削除するには、以下のコマンドを実行する。 vonage apps capabilities rm <application-id> <capability>ここで <application-id> は更新したいアプリケーションのID、そして <capability> は、削除したいAPIケイパビリティである。

vonage apps capabilities rm 00000000-0000-0000-0000-000000000000 messages 

✅ Fetching Application

Remove Messages capability from testing (00000000-0000-0000-0000-000000000000)? [y/n] 

✅ Removing messages capability from application 

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

Capabilities:
  None Set