Configure seus pré-requisitos

Você pode criar um account na Vonage pelo Painel de controle.

No Painel de Controle, você pode criar Applications e adquirir Numbers da Vonage. Você também pode realizar essas tarefas usando o CLI da Vonage.

Se você quiser realizar tarefas como criar Applications, adquirir Numbers da Vonage e assim por diante, precisará instalar a CLI da Vonage. Como a CLI da Vonage requer node.js você precisará instalar node.js primeiro.

Para garantir que node.js Após a instalação, execute o seguinte comando no terminal:

Siga as etapas descritas no Introdução ao Vonage CLI página para instalar e configurar a linha de comando.

Se você planeja usar JavaScript para desenvolver seu aplicativo, precisará instalar (ou atualizar) o SDK do Vonage Node Server.

Instalação

O Node Server SDK pode ser instalado da seguinte forma:

Se você já tiver o Server SDK instalado, o comando acima atualizará o Server SDK para a versão mais recente.

Uso

Se você decidir usar o SDK do servidor, precisará das seguintes informações:

Essas variáveis podem então ser substituídas por valores reais no código de exemplo do Server SDK.

Crie seu aplicativo

Existem dois métodos alternativos para criar uma aplicação de Mensagens e Despacho:

1. Como usar a CLI da Vonage
2. Como usar o painel

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

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

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

Isso cria uma aplicação da Vonage com mensagens capacidade, com as URLs dos webhooks configuradas conforme especificado, e gerar um arquivo de chave privada my_messages_app.key e cria/atualiza vonage_app.json.

Como criar uma aplicação de Mensagens e Despacho usando o Painel de Controle

Você pode criar Applications de Mensagens e Despacho 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.

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 Vonage ao aplicativo e vincular contas externas, como o Facebook, a ele.

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.

Há pelo menos dois webhooks que você deve configurar:

• Webhook de status de mensagem
• Webhook de mensagens recebidas

Quando são geradas atualizações de status de mensagens, como delivered, rejected ou accepted, as chamadas de retorno serão recebidas no Status da mensagem URL do webhook.

Quando uma mensagem recebida é captada, uma função de retorno com o conteúdo da mensagem é invocada no Mensagem recebida URL do webhook.

Para configurar as URLs dos webhooks

No Painel de controle, acesse Mensagens e Despacho.

Insira as URLs dos seus Webhooks nos campos intitulados URL de status e URL de origem.

Os valores que você inserir para as URLs dos webhooks dependem da localização do seu servidor de webhooks, por exemplo:

Webhooks de SMS recebidos

Fila de webhooks

Observe que os webhooks originados pela Vonage, como aqueles na URL do webhook de status de mensagem e na URL de mensagem recebida, são colocados em fila pela Vonage individualmente, mensagem por mensagem.

Certifique-se de que todas as aplicações respondam aos webhooks com um código de resposta 200.

Webhooks assinados

Para validar a origem dos seus webhooks, você pode verificar a assinatura deles; consulte as instruções aqui

Neste trecho de código, você aprenderá como lidar com uma mensagem recebida.

Exemplo

Certifique-se de que sua mensagem recebida O webhook está configurado no Painel. No mínimo, seu handler deve retornar um código de status 200 para evitar o acúmulo desnecessário de callbacks na fila. Certifique-se de que seu servidor de webhooks esteja em execução antes de testar seu aplicativo de mensagens.

npm install express body-parser

const express = require('express');
const bodyParser = require('body-parser');
const app = express();

app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: true }));

app.post('/webhooks/inbound-message', (req, res) => {
  console.log(req.body);
  res.status(200).end();
});

app.listen(3000);

pip install fastapi[standard]

from pprint import pprint

from fastapi import FastAPI, Request, status

app = FastAPI()


@app.post('/webhooks/message-status', status_code=status.HTTP_200_OK)
async def message_status(request: Request):
    data = await request.json()
    pprint(data)


@app.post('/webhooks/inbound-message')
async def inbound_message(request: Request):
    data = await request.json()
    pprint(data)

Se você quiser testar seu aplicativo localmente, pode usar o Ngrok.

Confira nossas informações sobre Usando o Ngrok para desenvolvimento local

Se estiver usando o Ngrok dessa maneira, você deve utilizar as URLs do Ngrok como URLs dos seus webhooks:

• https://abcdef1.ngrok.io/webhooks/inbound-message
• https://abcdef1.ngrok.io/webhooks/message-status