Pular para o conteúdo principal

Encaminhamento / Webhooks

O Encaminhamento / Webhooks do 2 Way Messaging é um mecanismo que permite ao utilizador da Arpoone receber, em tempo real, os SMS recebidos na plataforma da Arpoone, que correspondem a uma configuração 2WM previamente definida.
Para que isso aconteça, o utilizador da Arpoone deve ativar a opção de Encaminhamento ao configurar keywords e/ou o comportamento de fallback.

O endpoint de URL configurado será invocado pelo nosso servidor (HTTP/S POST), enviando a informação do SMS recebido em formato JSON.

Invocações​

A estrutura dos webhooks 2WM que a Arpoone enviará para o endpoint configurado pelo utilizador é a seguinte:

[
  {
    "Id": <uuidv4>,
    "OrganizationId": <uuidv4>,
    "ReceiveDateTime": <datetime>,
    "From": <string>, (número de origem do SMS recebido)
    "To": <string>, (número de destino do SMS recebido)
    "Keyword": <string>, 
    "Text": <string>,
    "Encoding": <int>,
    "Mcc": <string>,
    "Mnc": <string>,
    "TotalSegments": <int>
  }
  ...
]

Importante: O utilizador da Arpoone deve garantir que é retornada uma resposta HTTP 200 (OK) em caso de sucesso, caso contrário, o webhook será novamente enviado mais tarde.

Notas​

  • Deve-se prestar especial atenção ao facto de que, no pedido HTTP feito pela Arpoone, o corpo da requisição é um array que pode conter um ou mais SMS recebidos, até um máximo de 1000 por pedido HTTP;

  • Recomendamos a utilização da ferramenta https://webhook.site para validação/testes da funcionalidade do webhook 2WM, utilizando o valor "Your Unique URL" fornecido pela ferramenta como endpoint na configuração da keyword no 2WM;

  • Para otimizar o desempenho, os utilizadores da Arpoone devem processar os webhooks de forma assíncrona, garantindo um tempo de resposta curto aos pedidos HTTP da Arpoone.