Obter Notificações
Este endpoint permite que você recupere notificações enviadas anteriormente.Parâmetros de Path
| Propriedade | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| botId | string | ID do bot. | Sim |
Parâmetros de Query
| Propriedade | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| messageId | string | ID da mensagem. | Não |
| campaignId | string | ID da campanha. | Não |
| elementName | string | Nome do elemento. | Não |
| from | date | Data de início. | Não |
| to | date | Data de término. | Não |
| limit | number | Limite de paginação (Máx: 50). | Não |
| page | number | Número da página (Padrão: 1). | Não |
Exemplo de Requisição
Lista de status de mensagem
| Status | Descrição |
|---|---|
DELIVERED_CHANNEL | A mensagem foi recebida pelo WhatsApp. |
DELIVERED_USER | A mensagem foi recebida pelo usuário. |
READ | O usuário leu a mensagem. |
REPLY | O usuário respondeu à mensagem. |
CREATED | A mensagem foi recebida pela Jelou. |
FAILED | A mensagem não pôde ser entregue. |
Status de leitura da mensagem
| Status | Descrição |
|---|---|
true | O usuário leu a mensagem. |
false | O usuário não leu a mensagem. |
Respostas da API
O payload contém os seguintes campos:| Propriedade | Descrição |
|---|---|
| sentStatus | Status de entrega do template. |
| createdAt | Data de envio da mensagem. |
| deliveryChannelAt | Data de entrega ao canal WhatsApp. |
| deliveryUserAt | Data de entrega da mensagem pelo WhatsApp. |
| readAt | Data em que a mensagem foi lida pelo usuário. |
| destination | Número de telefone do usuário. |
| elementName | Nome do template. |
| id | ID da mensagem. |
| error | Motivo da falha na entrega do template (se aplicável). |
| reply | Resposta do usuário (disponível quando o status é REPLY). |
Análise de métricas
Use os dados de notificação para:- Medir engajamento: Calcule a porcentagem de mensagens lidas em relação às entregues.
- Identificar problemas: Detecte números inválidos ou bloqueados por meio de erros
FAILED. - Otimizar agendamentos: Analise timestamps para encontrar os melhores horários de envio.
- Melhorar conteúdo: Use respostas (
REPLY) para entender quais mensagens geram mais interação.