Como consultar status de envio de mensagens por data
Consulta em lote para retorno de todas as mensagens em um período.
Conforme explicado na documentação Assincronicidade no envio de mensagens, o envio de mensagens para contatos através da WhatsApp Business API acontece de forma assíncrona. Sendo assim a consulta ao status poderá não trazer resultados se ocorrer de forma imediata após a solicitação de envio. Recomendamos esperar alguns segundos depois da solicitação de envio para que a mensagem apareça no resultado.
1. Primeiro passo - Obter credenciais de acesso
Antes de consultar o status de solicitações de envio de mensagens, a aplicação cliente deve obter o token de acesso às APIs, conforme descrito no guia Como autenticar.
2. Segundo passo - Consultar status de envio de mensagens
Para consultar o status deve-se fazer uma requisição HTTP GET para o endpoint https://api.whatsapp.serpro.gov.br/{wabaId}/client/{fromPhoneNumberId}/status, conforme exemplo abaixo:
Parâmetros
dataFimStr (obrigatório): formato dd/mm/aaaa hh:mm:ss
dataInicioStr (obrigatório): formato dd/mm/aaaa hh:mm:ss
destinatario: número do telefone do destinatário
IdMeta
IdRequisicao
situacao (valores possíveis): ENVIADA, ENTREGUE, LIDA, FALHOU, DESCONHECIDA
pagina: O número da página de resultados a ser retornada. O padrão é 1 se não for especificado.
tamanho: O número de itens a serem retornados por página. O valor padrão é 20 e valor máximo permitido é 500
3. Terceiro passo - Resultado da consulta de status de envio de mensagens por data
[
{
"pagina": 0,
"tamanho": 0,
"total": 0
"status": [
{
"dataEnvioApi": "string",
"dataRecebimentoPacote": "string",
"delivered": "string",
"destinatario": "string",
"erroMsg": "string",
"failed": "string",
"idMeta": "string",
"idRequisicao": "string",
"phoneNumberId": "string",
"read": "string",
"sent": "string",
"situacao": "string",
"sucessoEnvioApi": true
}
],
}
]