Webhooks de mensagens recebidas e de status de mensagens

Você precisa configurar os webhooks de “Mensagem recebida” e “Status da mensagem”.

Configure suas URLs de webhook

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.

IMPORTANTE: Ambas as URLs de webhook devem ser configuradas. No mínimo, seus manipuladores de webhook devem retornar respostas 200 tanto para os callbacks de “Mensagem de entrada” quanto para os de “Status da mensagem”. Isso garante que possíveis fila de chamadas de retorno assim, evitam-se problemas.

Para configurar as URLs dos webhooks

  1. Se você já criou um aplicativo, mas ainda não configurou seus webhooks, acesse Suas Applications e selecione o aplicativo a ser configurado.

  2. Clique Editar para modificar as URLs dos webhooks do aplicativo.

  3. Na seção “Recursos de mensagens”, insira as URLs dos seus webhooks nos campos intitulados URL de status e URL de origem.

Os valores que você inserir para as URLs de webhook dependem da localização do seu servidor de webhook. Por exemplo:

Webhook URL
URL de status https://www.example.com/webhooks/message-status
URL de origem https://www.example.com/webhooks/inbound-message

NOTA: Recomendamos usar Autenticação baseada em JWT pois isso permite que você configure as URLs dos webhooks de recebimento e confirmação de entrega em nível de aplicação. Caso contrário, todas as chamadas de retorno das suas diferentes aplicações serão enviadas para o seu URLs de webhooks no nível da conta.

NOTA: Os callbacks são enviados por meio de POST Solicitações HTTP.

Testando localmente via Ngrok

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

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

Webhooks em ambiente de produção

Se as URLs de Webhook para mensagens no seu Account da API da Vonage já estiverem em uso em produção e você desejar uma segunda para utilizar a Messages API, envie um e-mail para apoio e solicite uma chave de API secundária.