Introdução à Messages API

Esta página irá guiá-lo por todas as etapas necessárias para começar a utilizar a Messages API da Vonage. A Messages API oferece uma maneira simples de enviar mensagens aos seus clientes por meio de diversos canais populares — SMS, MMS, RCS, WhatsApp, Facebook Messenger e Viber. Em vez de integrar cada plataforma separadamente, você pode se conectar uma única vez e gerenciar todas as conversas em um único lugar. A disponibilidade dos canais varia de acordo com o tipo de Account, o mercado e o status de integração; por exemplo, o acesso ao RCS requer ativação adicional.

Para começar, siga este guia para criar sua conta e suas Applications. Em seguida, acesse o guia de introdução para o seu canais selecionados para concluir sua integração.

Pré-requisitos

Antes de enviar sua primeira mensagem, você precisará criar um Account e um Application da Vonage:

Crie um account na Vonage

Para criar seu account gratuito na Vonage:

  1. No seu navegador, acesse Painel de controle.
  2. Insira as informações da sua empresa e clique em Inscreva-se. A Vonage envia um PIN para o seu celular por mensagem de texto ou ligação automática. O tempo limite para cada tentativa de verificação é de 5 minutos.
    Nota: você pode associar um número de telefone a apenas uma conta. Se o seu número de telefone já estiver associado a uma conta da Vonage, você deve exclua esse número de telefone da conta existente.
  3. Em Verificação do número de telefone, digite o PIN que a Vonage lhe enviou e clique em Verify. Você está conectado ao Painel de Controle e está vendo como começar a desenvolver com a Vonage. Esta página é exibida sempre que você fizer login, até que você tenha feito sua primeira chamada com sucesso usando as APIs da Vonage.

Ao criar sua conta na Vonage, você recebe €2 de crédito de teste gratuito e sua conta é configurada no modo DEMO. Você pode usar nossos produtos para enviar mensagens para até 10 números de destino; uma mensagem informando que a conta está no modo demo é adicionada a todos os SMS que você enviar. Para sair do modo demo recarregue sua Account.

NOTA: Para fluxos de trabalho RCS, um account de teste gratuito ou no modo DEMO não é suficiente por si só. Atualmente, o acesso ao RCS está disponível apenas para clientes gerenciados pela Vonage, e o recurso de integração necessário deve estar habilitado em sua chave de API antes que você possa enviar tráfego RCS.

Em pouquíssimos países a Vonage não consegue criar um Account para você automaticamente. Isso se deve a restrições de pagamento ou restrições legais ao comércio para uma empresa registrada nos EUA.

Criar uma aplicação da API da Vonage

Existem três métodos alternativos para criar um aplicativo de Mensagens:

  1. Como usar a CLI da Vonage
  2. Como usar o painel
  3. Como usar a API do aplicativo

Cada um desses métodos é descrito nas seções a seguir.

Como criar uma aplicação de mensagens usando a CLI da Vonage

Para criar seu aplicativo usando a CLI da Vonage, digite o seguinte comando no shell:

vonage apps:create "My Messages App" --messages_inbound_url=https://example.com/webhooks/inbound-message --messages_status_url=https://example.com/webhooks/message-status

Este comando cria uma aplicação da API da Vonage com mensagens capacidade, e as URLs dos webhooks estão configuradas conforme especificado. Ele também gera um arquivo de chave privada my_messages_app.key e cria ou atualiza o vonage_app.json arquivo.

Guarde a chave privada gerada em um local seguro assim que o comando for concluído. A autenticação JWT para a Messages API depende dessa chave e, caso você a perca, não será possível baixar novamente a chave privada original.

Como criar um aplicativo de mensagens usando o painel de controle

Você pode criar um aplicativo de Mensagens no Painel de controle.

Para criar seu aplicativo usando o Painel:

  1. Sob Applications No Painel, clique no Criar um novo aplicativo botão.

  2. Sob Nome, digite o nome da Application. Escolha um nome que facilite a identificação futura.

  3. Clique no botão Gerar chave pública e chave privada. Isso criará um par de chaves pública/privada, e a chave privada será baixada pelo seu navegador.

    Guarde a chave privada baixada em um local seguro. A autenticação JWT para a Messages API depende dessa chave e, caso você a perca, não será possível baixar novamente a chave privada original.

  4. Sob Recursos selecione o Mensagens botão.

  5. No URL de origem na caixa, digite a URL do seu webhook de mensagens recebidas, por exemplo, https://example.com/webhooks/inbound-message.

  6. No URL de status na caixa, digite a URL do seu webhook de status de mensagem, por exemplo, https://example.com/webhooks/message-status.

  7. Clique no Criar um novo pedido botão. Agora você será direcionado para a próxima etapa do procedimento de criação do aplicativo, onde poderá vincular um número da API da Vonage ao aplicativo e vincular contas externas, como o Facebook, a esse aplicativo.

  8. Se houver um account externo à qual você queira vincular este aplicativo, clique no External accounts linked aba e, em seguida, clique no botão correspondente Link botão correspondente à conta que você deseja vincular.

Você já criou seu aplicativo.

NOTA: Antes de testar seu aplicativo, certifique-se de que seus webhooks estejam configurados e que seu servidor de webhooks esteja em funcionamento.

Como criar um aplicativo de mensagens usando a API do aplicativo

A API de Aplicativos permite criar e configurar um aplicativo da Vonage programaticamente — sem usar o painel de controle nem a CLI. Um aplicativo da Vonage criado por meio da API de Aplicativos funciona da mesma forma que um criado pelo painel de controle.

Para obter uma visão geral completa sobre como criar uma aplicação da Vonage, consulte Criar uma aplicação da Vonage.