Gerenciamento de competências

O vonage apps capabilities O comando pode ser usado para adicionar, atualizar e remover os recursos da API da Vonage associados ao seu aplicativo.

Adicionando e atualizando uma funcionalidade

Para adicionar um novo recurso a uma aplicação ou atualizar as configurações de um recurso que a aplicação já tenha sido configurada para usar, execute o comando vonage apps capabilities update <application-id> <capability>.

Cada API possui um conjunto diferente de sinalizadores para a configuração de suas opções associadas; a lista de sinalizadores para cada API pode ser encontrada na seção correspondente abaixo.

Recursos de rede

Bandeira Descrição Tipo
--network-app-id ID do pedido de registro na rede String
--network-redirect-url URL para redirecionamento para a troca do código pelo token String
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

Mensagens

Bandeira Descrição Tipo
--messages-inbound-url URL para mensagens recebidas String
--messages-status-url URL para mensagens de status String
--messages-version Versão para dados de webhook. Deve ser “v0.1” ou “v1” String
--messages-authenticate-media Autenticar mídias recebidas Booleano
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

Bandeira Descrição Tipo
--verify-status-url URL para verificar mensagens de status String
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

Voz

Bandeira Descrição Tipo
--voice-signed-callbacks Ativar callbacks assinados Booleano
--voice-conversations-ttl O tempo de validade das conversas (medido em segundos)
--voice-leg-persistence-time A duração da persistência das etapas (medida em dias)
--voice-region Todas as chamadas recebidas, programáveis via SIP e SIP Connect serão encaminhadas para a região selecionada. Se a chamada estiver utilizando um terminal regional, isso substituirá a configuração do aplicativo String
--voice-answer-url Endereço da URL do webhook de resposta String
--voice-answer-http Método HTTP do Webhook de resposta String
--voice-answer-connection-timeout Tempo limite de conexão da resposta
--voice-answer-socket-timeout Tempo limite de resposta do soquete
--voice-event-url URL do webhook do evento String
--voice-event-http Método HTTP do webhook de evento String
--voice-event-connection-timeout Tempo limite de conexão do evento
--voice-event-socket-timeout Tempo limite do soquete de eventos
--voice-fallback-url Endereço de URL do webhook de reserva String
--voice-fallback-http Método HTTP do webhook de fallback String
--voice-fallback-connection-timeout Tempo limite de conexão de fallback
--voice-fallback-socket-timeout Tempo limite do soquete de 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

Vídeo

Bandeira Descrição Tipo
--video-archive-status-url URL do arquivo String
--video-archive-status-secret Segredo para a URL do arquivo String
--video-broadcast-status-url URL do status da transmissão String
--video-broadcast-status-secret URL secreta para transmissão String
--video-captions-status-url URL para verificar o status da legenda String
--video-captions-status-secret Segredo para o status da legenda String
--video-connection-created-url URL das conexões criadas String
--video-connection-created-secret Segredo para a URL da conexão criada String
--video-connection-destroyed-url URL para conexões interrompidas String
--video-connection-destroyed-secret O segredo das conexões interrompidas String
--video-render-status-url URL para verificar o status da renderização String
--video-render-status-secret Código para verificar o status da renderização String
--video-sip-call-created-url URL para chamadas iniciadas via SIP String
--video-sip-call-created-secret Segredo para o SIP criado String
--video-sip-call-destroyed-url URL do SIP destruído String
--video-sip-call-destroyed-secret Segredo do SIP destruído String
--video-sip-call-mute-forced-url URL para chamada SIP com o som desativado String
--video-sip-call-mute-forced-secret Segredo para silenciar chamadas SIP String
--video-sip-call-updated-url URL do SIP atualizado String
--video-sip-call-updated-secret Segredo para SIP atualizado String
--video-stream-created-url URL da transmissão criada String
--video-stream-created-secret Criado o segredo para a transmissão String
--video-stream-destroyed-url URL da transmissão foi excluída String
--video-stream-destroyed-secret Segredo do fluxo destruído String
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

Remover uma funcionalidade

É possível remover uma funcionalidade executando o comando vonage apps capabilities rm <application-id> <capability>, onde <application-id> é o ID do aplicativo que você deseja atualizar, e <capability> é a funcionalidade da API que você deseja remover.

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