Como receber evento do usuário
Processo para permitir ao cliente que contrata a Plataforma Serpro WhatsApp Business receber os eventos do WhatsApp para tratamento. Os eventos podem ser qualquer tipo de mensagem enviada pelo usuário do WhatsApp, assim como o status de mensagens enviadas pelo cliente.
Podem ser cadastrados um ou mais Webhooks do cliente para o recebimento destes eventos.
O webhook deve responder em no máximo 3 segundos, caso contrário será considerado erro de timeout.
Não faça processamentos/validações no recebimento da msg. Recepcione a msg e posteriormente trate conforme sua necessidade.
O endpoint do webhook deve utilizar as portas padrão 80 ou 443. Outras portas não são permitidas pelo nosso firewall.
Caso o envio de uma mensagem para o cliente não tenha sucesso, ela irá para uma fila de reenvio. Para isso, foi criada uma variável chamada delay, que terá o número de tentativas de envio daquela mensagem até o sucesso.
Os tempos de reenvio das mensagens estão definidos abaixo:
- 10 segundos na primeira tentativa de reenvio
- 1 minuto na segunda tentativa de reenvio
- 30 minutos na terceira tentativa de reenvio
- De 1 hora em 1 hora até o primeiro dia (24 horas)
- Uma vez ao dia até 7 dias
Aviso importante
As tentativas de envio do evento não entregue serão de até 7 dias!
Webhook Inativo:
Webhooks que não recebem mensagens com sucesso e que possuem no mínimo 100 mensagens com erro a pelo menos 3 dias, serão desativados para manutenção da saúde da plataforma.
Caso o webhook esteja inativo por 45 dias, ele será excluído.
Webhooks que não estão conseguindo receber mensagens ou estão desativados, ao voltarem a funcionar, receberão mensagens de até 7 dias atrás. Não existe garantia que chegarão na ordem enviada.
URI para ativar um webhook
URI: https://api.whatsapp.serpro.gov.br/client/{fromPhoneNumberId}/v2/webhook/{id}/ativar
Método: PUT
URI para desativar um webhook
URI: https://api.whatsapp.serpro.gov.br/client/{fromPhoneNumberId}/v2/webhook/{id}/desativar
Método: PUT
1. Primeiro passo - Cadastrar webhook para receber os eventos
Para receber os eventos enviados recebidos pelo usuário do WhatsApp é necessário cadastrar o Webhook de recebimento, conforme descrito no guia Como gerenciar Webhook.
Aviso importante
Só serão recebidas as mensagens enviadas pelo usuário após o cadastramento do Webhook!
Formatos de mensagens possíveis
Para maiores detalhes, acessar a documentação Tipos de mensagens recebidas e Tipos de mensagens de status.
Tipo de mensagem de status
Na mensagem do tipo status, existem 2 campos de ID, o "id" que corresponde ao id da Meta e o "idRequisicao" (ao final) que corresponde ao id do Serpro enviado como retorno da requisição de mensagem.