Voice API da Vonage com ASP.NET: Antes de começar

Este artigo faz parte de uma série sobre como usar a Voice API da Vonage em projetos ASP.NET. Ele dá continuidade à série “Introdução à Vonage e ao ASP.NET”, que segue nossa série “Introdução” sobre SMS APIs.

Neste tutorial, vamos configurar um projeto ASP.NET no Visual Studio com todas as configurações necessárias para se conectar à Voice API da Vonage. Isso permite adicionar funcionalidades de chamadas telefônicas a um aplicativo ASP.NET. Futuras postagens no blog mostrarão como integrar a Voice API ao seu aplicativo; o objetivo aqui é mostrar como dar os primeiros passos.

Configurando um aplicativo da Vonage

Para poder utilizar Voice API da Vonage, você precisará usar um Aplicativo da Vonage. Um aplicativo da Vonage contém as informações de segurança e configuração necessárias para interagir com a Voice API da Vonage e utilizar facilmente a Voice API.

Todas as solicitações à Voice API exigem autenticação. É necessário gerar uma chave privada por meio da API de Aplicativos, o que permite criar JSON Web Tokens (JWT) para realizar as solicitações. É possível criar um par de chaves pública/privada associado a um aplicativo de duas maneiras.

O painel do aplicativo Vonage

Se você acessar o painel do Vonage, na seção seção “Aplicativos”, você pode criar um novo aplicativo.

Preencha os campos obrigatórios e, em seguida, clique em “Gerar par de chaves pública/privada”; isso solicitará que você baixe sua chave privada (guarde-a em um local seguro!) e preencher a chave pública para você.

Você pode ler mais sobre nosso painel de aplicativos e como ele facilita a configuração do gerenciamento do aplicativo Vonage Voice em nossa postagem no blog.

O CLI da Vonage

Primeiro, vamos instalar a CLI da Vonage do npm

npm install @vonage/cli -g

Em seguida, configure-o com sua chave e seu segredo da API da Vonage.

vonage config:set --apiKey=API_KEY --apiSecret=API_SECRET

Agora que a configuração está concluída, o próximo passo é criar o aplicativo de voz usando o comando app:create.

Em ambas as opções, é necessário registrar um nome de aplicativo, por exemplo, “Meu primeiro aplicativo de voz”, e dois endpoints de webhook para especificar as URLs de resposta e de evento. O app:create comando irá guiá-lo nesse processo.

vonage apps:create 

√ Application Name ... My first voice app
√ Select App Capabilities » Voice
√ Create voice webhooks? ... yes
√ Answer Webhook - URL ... http://example.com/webhook_name/answer
√ Answer Webhook - Method » POST
√ Event Webhook - URL ... http://example.com/webhook_name/event
√ Event Webhook - Method » POST
√ Allow use of data for AI training? Read data collection disclosure - https://help.nexmo.com/hc/en-us/articles/4401914566036 ... no
Creating Application... done

Quando o aplicativo é criado com sucesso, a CLI retorna o ID do aplicativo e a chave privada, ambos necessários para interagir com a Voice API da Vonage. Essas informações também são armazenadas em dois arquivos localizados no diretório do usuário, por exemplo: c:\users\bob\ e são vonage_app.json e <app_name>.key

Configuração do projeto ASP.NET

Agora que geramos nosso par de chaves pública/privada e nosso aplicativo Vonage, vamos ver como devemos configurar nosso projeto ASP.NET. Você deve ter percebido que agora existe mais de uma plataforma ASP.NET: o ASP.NET foi desenvolvido especificamente para o Windows, enquanto o ASP.NET Core é o novo framework de código aberto e multiplataforma.

Tentaremos abordar ambos os casos quando houver diferença no código; caso contrário, utilizaremos um ou outro, com foco no ASP.Net Core, já que essa é a tendência futura.

Configuração de um projeto Web ASP.Net

Primeiro, abra o Visual Studio e crie uma nova projeto de aplicativo Web ASP.NET (.NET Framework) .

Selecione o Modelo MVC e certifique-se de que o tipo de autenticação esteja definido como Sem autenticação. Clique em OK para criar o projeto.

Configuração de projetos em ASP.Net Core e .Net 5 e versões posteriores

No Visual Studio, crie um novo projeto e selecione “Aplicativo Web ASP.NET Core”.

Em seguida, selecione o modelo de aplicativo da Web.

Instalando o SDK .NET da Vonage

Quer você opte por um projeto ASP.Net Web ou Core, as etapas a seguir são as mesmas.

Instale o SDK .Net da Vonage por meio do Console do Gerenciador de Pacotes NuGet.

Install-Package Vonage

Adicione um arquivo JSON (appsettings.json) ao seu projeto. Nele, você deverá inserir suas credenciais da Vonage.

{
  "appSettings": {
    "Vonage_key": "VONAGE-API-KEY",
    "Vonage_secret": "VONAGE-API-SECRET",
    "VONAGE_FROM_NUMBER": "VONAGE-VIRTUAL-NUMBER"
  }
}

Agora você está pronto para mergulhar no código. Vamos ver como você pode fazer uma chamada de conversão de texto em fala no seu projeto ASP.NET usando a Voice API.

Saiba mais sobre as APIs da Vonage e o ASP.NET

Este post foi apenas uma breve introdução à configuração do seu primeiro aplicativo Vonage com ASP.NET. Agora você está pronto para mergulhar no código e aprender como fazer uma chamada com conversão de texto em fala no ASP.NET usando a Voice API da Vonage

Além disso, por que não tentar enviar um SMS com o ASP.NET MVC? Ou aprender a receber SMS com o ASP.NET MVC? Ambos os posts estão no nosso blog de desenvolvedores. Você também pode se interessar pelo nosso SDK .NET de código aberto, disponível no GitHub.