Gerenciamento de Applications
Um aplicativo da API da Vonage contém as informações de segurança e configuração necessárias para se conectar aos terminais da Vonage e utilizar as APIs da Vonage. Cada aplicativo da Vonage criado pode oferecer suporte a vários recursos. Por exemplo, é possível criar um aplicativo que ofereça suporte ao uso das Voice API, Messages API e RTC APIs.
Você pode usar a CLI da Vonage para criar e gerenciar suas Applications, adicionar novos recursos e atualizar as informações de configuração do seu webhook.
Criação de uma aplicação
O vonage apps create <name> O comando permite que você crie um aplicativo. É necessário informar o nome do aplicativo, pois a CLI não irá gerá-lo automaticamente.
O comando possui os seguintes parâmetros:
Observação: Se você não fornecer sua própria chave, a Vonage criará uma para você. No entanto, se você não salvar a chave no momento da criação do aplicativo, não poderá acessá-la novamente. Você terá que regenerar a chave caso a perca.
Copiar
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
Copiar
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
Listando suas Applications
Por padrão, ao executar vonage apps isso executará o mesmo subcomando que vonage apps list. Há vários parâmetros
que você pode passar para refinar sua pesquisa:
Copiar
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
Copiar
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
Mostrar detalhes do aplicativo
O show O subcomando permite obter os detalhes de um aplicativo específico. O formato do comando é
vonage apps show <id>, onde <id> é o UUID do aplicativo.
Observação: Isso não exibirá a chave pública. Se você precisar visualizar a chave pública, pode usar o --show-all, --json, ou --yaml sinalizadores,
que não ocultarão nenhuma informação.
Copiar
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.
Copiar
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.
Atualizar uma aplicação
vonage apps update <id> permite que você atualize o nome de uma aplicação existente, altere a configuração “Melhorar IA” ou defina uma nova chave pública:
Copiar
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
Copiar
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
Excluir uma aplicação
É possível excluir um aplicativo com o comando vonage apps delete <id>, onde id é o UUID do aplicativo:
Copiar
vonage apps delete 00000000-0000-0000-0000-000000000000
✅ Fetching application
Delete application New Name (7d7133ab-de4e-4b7a-8e1e-376670077c71)? [y/n]
✅ Deleting application
Copiar
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