Gestion des capacités

Les vonage apps capabilities peut être utilisée pour ajouter, mettre à jour et supprimer les capacités de l'API Vonage associées à votre application.

Ajout et mise à jour d'une capacité

Pour ajouter une nouvelle capacité à une application ou mettre à jour les paramètres d'une capacité qu'une application a déjà été configurée pour utiliser, exécutez la commande vonage apps capabilities update <application-id> <capability>.

Chaque API dispose d'un ensemble différent de drapeaux pour la configuration des paramètres qui lui sont associés ; la liste des drapeaux pour chaque API se trouve dans la section correspondante ci-dessous.

Caractéristiques du réseau

Drapeau Description Type
--network-app-id ID de la demande d'enregistrement du réseau Chaîne
--network-redirect-url URL à rediriger pour échanger le code contre le jeton Chaîne
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

Drapeau Description Type
--messages-inbound-url URL pour les messages entrants Chaîne
--messages-status-url URL pour les messages d'état Chaîne
--messages-version Version des données du webhook. Doit être soit "v0.1", soit "v1". Chaîne
--messages-authenticate-media Authentifier les médias entrants Booléen
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

Drapeau Description Type
--verify-status-url URL pour les messages d'état de vérification Chaîne
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

Voix

Drapeau Description Type
--voice-signed-callbacks Activer les rappels signés Booléen
--voice-conversations-ttl Le temps de vie des conversations (mesuré en secondes)
--voice-leg-persistence-time La durée de persistance pour les jambes (mesurée en jours)
--voice-region Tous les appels entrants, SIP programmables et SIP connect seront envoyés à la région sélectionnée. Si l'appel utilise un point d'extrémité régional, cette option est prioritaire sur le paramètre de l'application. Chaîne
--voice-answer-url Adresse URL du Webhook de la réponse Chaîne
--voice-answer-http Méthode HTTP du Webhook de réponse Chaîne
--voice-answer-connection-timeout Délai de connexion de la réponse
--voice-answer-socket-timeout Réponse au délai d'attente du socket
--voice-event-url Adresse URL du Webhook de l'événement Chaîne
--voice-event-http Méthode HTTP du webhook d'événement Chaîne
--voice-event-connection-timeout Délai de connexion à un événement
--voice-event-socket-timeout Délai d'attente pour le socket d'événement
--voice-fallback-url Adresse URL du webhook de repli Chaîne
--voice-fallback-http Méthode HTTP du webhook de repli Chaîne
--voice-fallback-connection-timeout Délai d'attente pour la connexion de repli
--voice-fallback-socket-timeout Délai d'attente pour le socket de repli 
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

Vidéo

Drapeau Description Type
--video-archive-status-url URL pour les archives Chaîne
--video-archive-status-secret Secret pour l'URL de l'archive Chaîne
--video-broadcast-status-url URL de l'état de la diffusion Chaîne
--video-broadcast-status-secret Secret pour l'URL de diffusion Chaîne
--video-captions-status-url URL pour l'état de la légende Chaîne
--video-captions-status-secret Secret pour le statut des légendes Chaîne
--video-connection-created-url URL pour les connexions créées Chaîne
--video-connection-created-secret Secret de l'URL de connexion créée Chaîne
--video-connection-destroyed-url URL pour les connexions détruites Chaîne
--video-connection-destroyed-secret Secret pour les connexions détruites Chaîne
--video-render-status-url URL pour l'état du rendu Chaîne
--video-render-status-secret Secret pour l'état de l'enduit Chaîne
--video-sip-call-created-url URL pour les appels créés par SIP Chaîne
--video-sip-call-created-secret Secret pour SIP créé Chaîne
--video-sip-call-destroyed-url URL pour le SIP détruit Chaîne
--video-sip-call-destroyed-secret Secret pour SIP détruit Chaîne
--video-sip-call-mute-forced-url URL pour l'appel SIP en sourdine Chaîne
--video-sip-call-mute-forced-secret Secret pour l'appel en sourdine SIP Chaîne
--video-sip-call-updated-url URL pour la mise à jour du SIP Chaîne
--video-sip-call-updated-secret Secret pour SIP mis à jour Chaîne
--video-stream-created-url URL du flux créé Chaîne
--video-stream-created-secret Secret pour le flux créé Chaîne
--video-stream-destroyed-url URL pour le flux détruit Chaîne
--video-stream-destroyed-secret Secret de la destruction d'un cours d'eau Chaîne
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

Supprimer une capacité

Vous pouvez supprimer une capacité en exécutant la commande vonage apps capabilities rm <application-id> <capability>où <application-id> est l'ID de l'application que vous souhaitez mettre à jour, et <capability> est la capacité de l'API que vous souhaitez supprimer.

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